Skip to content

Commit b7de9c3

Browse files
committed
review comments
1 parent 309189c commit b7de9c3

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

doc/tools/SSH-keys.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,11 @@ manager. This will generate two files: `~\.ssh\id_ed25519` and `~\.ssh\id_ed2551
2424
ending in `.pub` is a public key, the one without the `.pub` extension is a private key. It
2525
would be sensible to store copies of these two files in your password manager too.
2626

27+
:::{warning}
2728
For the avoidance of doubt, the **public** key (`*.pub`) can be freely shared with everyone (for
2829
example, by being copied onto instruments). Do not share your **private** key. The private key
2930
is additionally encrypted using your selected password.
31+
:::
3032

3133
## Setting up SSH agent
3234

@@ -39,7 +41,7 @@ Start-Service ssh-agent
3941
## Deploying the public key
4042

4143
- Add your public key to the [keys repository](https://github.com/ISISComputingGroup/keys).
42-
- Ask a developer whose key is *already* deployed to run the deployment script, which will
44+
- Ask a developer whose key is *already* deployed to run the [`deploy_keys.py` script](https://github.com/ISISComputingGroup/keys/blob/main/deploy_keys.py), which will
4345
update the `authorized_keys` files on each instrument.
4446

4547
If the permissions on `administrators_authorized_keys` are wrong, that file won't work. The
@@ -63,9 +65,11 @@ account password; your key is sufficient to grant you access.
6365

6466
## Bulk usage
6567

66-
Firstly, if you intend to run a command across many instruments, it is worth getting that command
68+
:::{caution}
69+
If you intend to run a command across many instruments, it is worth getting that command
6770
reviewed by another developer and running it together. This is **especially** true if you intend to
6871
run a command as a privileged user.
72+
:::
6973

7074
Typing the password to unlock your SSH key for each instrument would be tedious.
7175
To avoid this, we can **temporarily** add the key to the SSH agent:

0 commit comments

Comments
 (0)