doc: improved documentation for ssh keys
This commit is contained in:
parent
b6f4f3b1ba
commit
ad79fb617d
1 changed files with 14 additions and 5 deletions
|
@ -4,6 +4,9 @@ To be able to gain remote access to the Skynet.
|
||||||
|
|
||||||
``$USERNAME`` Refers to your Skynet username, for example I would replace ``$USERNAME`` with ``silver``
|
``$USERNAME`` Refers to your Skynet username, for example I would replace ``$USERNAME`` with ``silver``
|
||||||
|
|
||||||
|
## Windows
|
||||||
|
If you are using Windows then you should use PowerShell, not ``cmd``.
|
||||||
|
|
||||||
## Prep
|
## Prep
|
||||||
First we set up the ssh folder and create a skynet folder within it for neatness
|
First we set up the ssh folder and create a skynet folder within it for neatness
|
||||||
|
|
||||||
|
@ -14,14 +17,20 @@ cd ~/.ssh/skynet
|
||||||
|
|
||||||
## Create Key
|
## Create Key
|
||||||
Now we will create the ssh key itself.
|
Now we will create the ssh key itself.
|
||||||
Location: ``$USERNAME``, your skynet username.
|
|
||||||
**Password: Press Enter twice for no password on the key.**
|
|
||||||
|
|
||||||
If you are creating this key for a CI/CD pipeline (``user_deploy*``) then adding a password will cause it to fail.
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
ssh-keygen -t ed25519 -C "<comment>"
|
ssh-keygen -t ed25519 -C "<comment>"
|
||||||
```
|
```
|
||||||
|
|
||||||
|
* ``<comment>``: this is a comment to yerself about what the key is for
|
||||||
|
* I often use ``username@host``, ``silver@skynet``.
|
||||||
|
* Location: ``./$USERNAME``, your skynet username.
|
||||||
|
* ``./silver`` for example.
|
||||||
|
* **Password: Press Enter twice for no password on the key.**
|
||||||
|
|
||||||
|
If you are creating this key for a CI/CD pipeline (``user_deploy*``) then adding a password will cause it to fail.
|
||||||
|
|
||||||
|
|
||||||
It will create two files: ``$USERNAME`` and ``$USERNAME.pub`` inside ``~/.ssh/skynet``
|
It will create two files: ``$USERNAME`` and ``$USERNAME.pub`` inside ``~/.ssh/skynet``
|
||||||
|
|
||||||
### Linux Only
|
### Linux Only
|
||||||
|
|
Loading…
Add table
Reference in a new issue