You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/tools/SSH-keys.md
+6-2Lines changed: 6 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,9 +24,11 @@ manager. This will generate two files: `~\.ssh\id_ed25519` and `~\.ssh\id_ed2551
24
24
ending in `.pub` is a public key, the one without the `.pub` extension is a private key. It
25
25
would be sensible to store copies of these two files in your password manager too.
26
26
27
+
:::{warning}
27
28
For the avoidance of doubt, the **public** key (`*.pub`) can be freely shared with everyone (for
28
29
example, by being copied onto instruments). Do not share your **private** key. The private key
29
30
is additionally encrypted using your selected password.
31
+
:::
30
32
31
33
## Setting up SSH agent
32
34
@@ -39,7 +41,7 @@ Start-Service ssh-agent
39
41
## Deploying the public key
40
42
41
43
- 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
43
45
update the `authorized_keys` files on each instrument.
44
46
45
47
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.
63
65
64
66
## Bulk usage
65
67
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
67
70
reviewed by another developer and running it together. This is **especially** true if you intend to
68
71
run a command as a privileged user.
72
+
:::
69
73
70
74
Typing the password to unlock your SSH key for each instrument would be tedious.
71
75
To avoid this, we can **temporarily** add the key to the SSH agent:
0 commit comments