Skip to content
This repository has been archived by the owner on Nov 10, 2023. It is now read-only.

Commit

Permalink
Better docs
Browse files Browse the repository at this point in the history
  • Loading branch information
richfitz committed Oct 18, 2023
1 parent f71a507 commit 63b3d65
Showing 1 changed file with 22 additions and 7 deletions.
29 changes: 22 additions & 7 deletions development.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,7 @@ export VAULT_ADDR='http://127.0.0.1:8200'
export VAULT_TOKEN=$(cat ~/.vault-token)
```

within the hatch environment

```
privateer2 --path example/simple.json keygen --all
```
within the hatch environment before running any commands.

## Worked example

Expand All @@ -32,12 +28,23 @@ mkdir -p tmp
sed "s/alice.example.com/$(hostname)/" example/local.json > tmp/privateer.json
```

Set up the key volumes (and remove the file that would ordinarily be created)
Create a set of keys

```
privateer2 --path tmp/privateer.json keygen --all
```

You could also do this individually like

```
privateer2 --path tmp/privateer.json keygen alice
```

Set up the key volumes

```
privateer2 --path tmp/privateer.json configure alice
privateer2 --path tmp/privateer.json configure bob
rm -f tmp/.privateer_identity
```

Start the server, as a background process
Expand All @@ -52,6 +59,14 @@ Once `alice` is running, we can test this connection from `bob`:
privateer2 --path tmp/privateer.json --as=bob check --connection
```

This command would be simpler to run if in the `tmp` directory, which would be the usual situation in a multi-machine setup

```
privateer2 check --connection
```

For all other commands below, you can drop the `--path` and `--as` arguments if you change directory.

Create some random data within the `data` volume (this is the one that we want to send from `bob` to `alice`)

```
Expand Down

0 comments on commit 63b3d65

Please sign in to comment.