HowTo SSH Keys

Generate and deploy SSH Keys to Github

Generate the keys

1. Generate key
   

    $ ssh-keygen -t ed25519 -C "your_email@example.com"

2. Name the file id_github_sigrokorg and store it somewhere in your home directory (e.g. /home/frank/.ssh)
3. Don't enter a password
4. You now have two files: id_github_sigrokorg (the private key) and id_github_sigrokorg.pub (the public key)

Add public key to the destination repository (e.g. libsigrokflow)

1. Go the the Github page of the repository in question (e.g. https://github.com/sigrokproject/libsigrokflow)
2. Click on "Settings" (repository settings)
   
3. Click on "Deploy keys"
   
4. Click on "Add deploy key"
   
5. Enter a title, e.g. "Deploy key for sigrok-sync"
6. Paste the content of the public key into the "key" text area
7. Select "Allow write access"
   

Add private key to the source repository (sigrok-sync)

1. Go the the Github page of the sigrok-sync repository
2. Click on "Settings" (repository settings)
   
3. Click on "Secrets" and then on "Actions"
   
4. Click on "New repository secret"
   
5. Enter a name (this name is used in the Github workflow): SSH_SYNC_KEY
6. Paste the content of the private key into the "secret" text area