doc: improved documentation for ssh keys
All checks were successful
Build / build (push) Successful in 12s
Build / deploy (push) Successful in 9s

This commit is contained in:
silver 2025-02-13 17:58:56 +00:00
parent b6f4f3b1ba
commit ad79fb617d
Signed by: silver
GPG key ID: 36F93D61BAD3FD7D

View file

@ -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``
## Windows
If you are using Windows then you should use PowerShell, not ``cmd``.
## Prep
First we set up the ssh folder and create a skynet folder within it for neatness
@ -13,15 +16,21 @@ cd ~/.ssh/skynet
```
## Create Key
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.
Now we will create the ssh key itself.
```bash
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``
### Linux Only