Difference between revisions of "HowTo SSH Keys"

From sigrok
Jump to navigation Jump to search
 
(5 intermediate revisions by the same user not shown)
Line 3: Line 3:
== Generate the keys ==
== Generate the keys ==


# Generate key
# Generate key <br /><small><source> $ ssh-keygen -t ed25519 -C "your_email@example.com"</source></small>
<small>
<source lang="python">
$ ssh-keygen -t ed25519 -C "your_email@example.com"
</source>
</small>
# Name the file <code>id_github_sigrokorg</code> and store it somewhere in your home directory (e.g. <code>/home/frank/.ssh</code>)
# Name the file <code>id_github_sigrokorg</code> and store it somewhere in your home directory (e.g. <code>/home/frank/.ssh</code>)
# Don't enter a password
# Don't enter a password
# You now have two files: <code>id_github_sigrokorg</code> (the private key) and <code>id_github_sigrokorg.pub</code> (the public key)
# You now have two files: <code>id_github_sigrokorg</code> (the private key) and <code>id_github_sigrokorg.pub</code> (the public key)


== Add key to the destination repository (e.g. <code>libsigrokflow</code>) ==
== Add public key to the destination repository (e.g. <code>libsigrokflow</code>) ==


# Go the the github page for of the repository in question (e.g. https://github.com/sigrokproject/libsigrokflow)
# Go the the Github page of the repository in question (e.g. https://github.com/sigrokproject/libsigrokflow)
# Click on "Settings" (repository settings)
# Click on "Settings" (repository settings)<br />[[File:destination_settings.png]]
[[File:destination_settings.png]]
# Click on "Deploy keys"<br />[[File:destination_deploy_keys.png]]
# Click on "Deploy keys"
# Click on "Add deploy key"<br />[[File:destination_add_key.png]]
[[File:destination_deploy_keys.png]]
# Enter a title, e.g. "Deploy key for sigrok-sync"
# Paste the content of the <b>public key</b> into the "key" text area
# Select "Allow write access"<br />[[File:destination_add_public_key.png]]
 
== Add private key to the source repository (<code>sigrok-sync</code>) ==
 
# Go the the Github page of the <code>sigrok-sync</code> repository
# Click on "Settings" (repository settings)<br />[[File:source_settings.png]]
# Click on "Secrets" and then on "Actions"<br />[[File:source_secrets.png]]
# Click on "New repository secret"<br />[[File:source_add_secret.png]]
# Enter a name (this name is used in the Github workflow): <code>SSH_SYNC_KEY</code>
# Paste the content of the <b>private key</b> into the "secret" text area<br />[[File:source_add_private_key.png]]

Latest revision as of 16:47, 2 April 2023

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)
    Error creating thumbnail: Unable to save thumbnail to destination
  3. Click on "Deploy keys"
    Error creating thumbnail: Unable to save thumbnail to destination
  4. Click on "Add deploy key"
    Error creating thumbnail: Unable to save thumbnail to destination
  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"
    Error creating thumbnail: Unable to save thumbnail to destination

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)
    Error creating thumbnail: Unable to save thumbnail to destination
  3. Click on "Secrets" and then on "Actions"
    Error creating thumbnail: Unable to save thumbnail to destination
  4. Click on "New repository secret"
    Error creating thumbnail: Unable to save thumbnail to destination
  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
    Error creating thumbnail: Unable to save thumbnail to destination