Skip to content

Commit 762ed35

Browse files
committed
doc: update README
1 parent 8c6bf22 commit 762ed35

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -61,21 +61,25 @@ The certificate will be requested with only those extensions required for the cu
6161

6262
### Examples
6363

64-
The following will request that an existing ed25519 public key be signed by the Vault signer at `https://vault.example.com:8200/v1/ssh-client-signer/sign/default`, with `permit-pty` and `permit-port-forwarding` extensions to support the connection to `host.example.com`:
64+
The following will request that an existing ed25519 public key be signed by the Vault signer at `https://vault.example.com:8200/v1/ssh-client-signer/sign/default`, with (automatic) `permit-pty` and `permit-port-forwarding` extensions to support the connection to `host.example.com`:
6565

6666
```console
6767
$ ssh-add ~/.ssh/id_ed25519
68-
$ export VAULT_ADDR=https://vault.example.com:8200 VAULT_SSH_PATH=ssh-client-signer VAULT_SSH_MODE=sign
68+
$ export VAULT_ADDR=https://vault.example.com:8200
69+
$ export VAULT_SSH_PATH=ssh-client-signer
70+
$ export VAULT_SSH_ROLE=default
71+
$ export VAULT_SSH_MODE=sign
6972
$ vault login
7073
...
7174
$ vssh -L8080:localhost:80 host.example.com
7275
...
7376
```
7477

75-
The following will request that an ephemeral ecdsa keypair with a 521-bit private key be generated by the Vault issuer at `https://vault.example.com/v1/ssh/issue/root`, and used to run the `id` command on `host2.example.com` as `root`:
78+
The following will request that an ephemeral ecdsa keypair with a (default) 256-bit private key be generated by the Vault issuer at `https://vault.example.com/v1/ssh/issue/root`, and used to run the `id` command on `host2.example.com` as `root`:
7679

7780
```console
78-
$ export VAULT_ADDR=https://vault.example.com VAULT_SSH_KEY_TYPE=ec
81+
$ export VAULT_ADDR=https://vault.example.com
82+
$ export VAULT_SSH_KEY_TYPE=ec
7983
$ vault login
8084
...
8185

0 commit comments

Comments
 (0)