Skip to content

Commit 1c1c8b8

Browse files
committed
add docs on using keeper for ssh key management
1 parent 136bd32 commit 1c1c8b8

File tree

1 file changed

+16
-3
lines changed

1 file changed

+16
-3
lines changed

doc/tools/SSH-keys.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,20 @@ example, by being copied onto instruments). Do not share your **private** key. T
3030
is additionally encrypted using your selected password.
3131
:::
3232

33-
## Setting up SSH agent
33+
{#keeper_ssh}
34+
## Keeper
35+
36+
To avoid having to copy and paste your passphrase every time, you can use [Keeper](https://ukri.sharepoint.com/sites/thesource/SitePages/Keeper-Password-Manager.aspx) to store your passwords.
37+
38+
If you want to use Keeper (you'll need the desktop client for this, _not_ the browser plugin) for storing your SSH keys, and not have local plaintext copies on your machine, you can do so.
39+
40+
This is done by adding your newly-generated key to keeper (with the `SSH key` record type) with your public key, private key and passphrase filled in.
41+
42+
In `Settings -> Developer`, enable the "SSH Agent" which will add your keys, without needing to enter the passphrases, when the keeper vault is unlocked.
43+
44+
Ignore the section below as you don't need to manually set up an SSH agent.
45+
46+
## Manually Setting up SSH agent
3447

3548
In a powershell window, run the following commands:
3649
```powershell
@@ -59,7 +72,7 @@ To connect via SSH to an instrument, use:
5972
ssh spudulike@NDXINST
6073
```
6174

62-
This will prompt you on each connection for the passphrase to unlock your SSH key, this is the
75+
(If you aren't [using Keeper](#keeper_ssh)) This will prompt you on each connection for the passphrase to unlock your SSH key, this is the
6376
password you set earlier for your personal SSH key. You will not be prompted for an
6477
account password; your key is sufficient to grant you access.
6578

@@ -72,7 +85,7 @@ run a command as a privileged user.
7285
:::
7386

7487
Typing the password to unlock your SSH key for each instrument would be tedious.
75-
To avoid this, we can **temporarily** add the key to the SSH agent:
88+
To avoid this, we can either [use Keeper](#keeper_ssh), or **temporarily** add the key to the SSH agent:
7689

7790
```
7891
ssh-add

0 commit comments

Comments
 (0)