Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update demo script for prototype-2 #53

Merged
merged 6 commits into from
Apr 28, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions building.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Building NV2

The nv2 repo contains the following:

- `nv2` - A CLI for signing and verifying with Notary v2
- `docker-generate` - Extends docker with `docker generate` to create locally persisted manifest for signing, without having to push to a registry.
- `docker-nv2` - Extends docker with `docker nv2 notary` to enable, sign and verify Notary v2 signatures on `docker pull`

This plugin requires [golang](https://golang.org/dl/) with version `>= 1.16`.

## Windows with WSL

- Build the binaries, installing them to:
- `~/bin/nv2`
- `~/.docker/cli-plugins/docker-generate`
- `~/.docker/cli-plugins/docker-nv2`
```shell
git clone https://github.com/notaryproject/nv2.git
cd nv2
git checkout prototype-2
make install
SteveLasker marked this conversation as resolved.
Show resolved Hide resolved
```
- Verify binaries are installed
```bash
docker --help
# look for
Management Commands:
generate* Generate artifacts (github.com/shizhMSFT, 0.1.0)
nv2* Notary V2 Signature extension (Sajay Antony, Shiwei Zhang, 0.2.3)

which nv2
# output
/home/<user>]/bin/nv2
```
19 changes: 1 addition & 18 deletions docs/nv2/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,24 +12,7 @@

### Build and Install

This plugin requires [golang](https://golang.org/dl/) with version `>= 1.16`.

To build and install, run

```shell
go install github.com/notaryproject/nv2/cmd/nv2
```

To build and install to an optional path, run

```shell
go build -o nv2 ./cmd/nv2
```

Next, install optional components:

- Install [docker-generate](https://github.com/shizhMSFT/docker-generate) for local Docker manifest generation and local signing.
- Install [OpenSSL](https://www.openssl.org/) for key generation.
`nv2`: see [building.md](/building.md)

### Self-signed certificate key generation

Expand Down
Loading