Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[howto_automatic-deployment] Mention the possible need for an SSH key passphrase #1835

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[howto_automatic-deployment] Mention the possible need for an SSH key passphrase #1835

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion source/howto_automatic-deployment.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,7 @@ Create ``.github/workflows/deploy-to-uberspace.yml`` within the ``isabells-websi
remote_host: ${{ vars.SSH_HOST }}
remote_user: ${{ vars.SSH_USERNAME }}
remote_key: ${{ secrets.SSH_PRIVATE_KEY }}
remote_key_pass: ${{ secrets.SSH_PRIVATE_KEY_PASS }} # Only needed if you added a passphrase upon creating the SSH key


The `name` is shown in the UI of GitHub Actions to track the process of your deployment.
Expand Down Expand Up @@ -172,7 +173,7 @@ In your GitHub repository go to:
- Secrets and variables
- Actions

Add the variables and secrets. Make sure you store the secrets in the ``Secrets`` tab and variables in the ``Variables`` tab.
Add the variables and secrets. Make sure you store the secrets in the ``Secrets`` tab (using the "New repository secret" button) and variables in the ``Variables`` tab (using the "New repository variable" button).

.. list-table::
:widths: 25 25 50
Expand All @@ -184,6 +185,9 @@ Add the variables and secrets. Make sure you store the secrets in the ``Secrets`
* - Secret
- SSH_PRIVATE_KEY
- Your private SSH Key
* - Secret
- SSH_PRIVATE_KEY_PASS
- The private SSH Key's passphrase (if any)
* - Variable
- SSH_USERNAME
- Your username, don't add any whitespace (e.g. isabell)
Expand Down Expand Up @@ -375,6 +379,7 @@ If you used the given example, the file should look like this:
remote_host: ${{ vars.SSH_HOST }}
remote_user: ${{ vars.SSH_USERNAME }}
remote_key: ${{ secrets.SSH_PRIVATE_KEY }}
remote_key_pass: ${{ secrets.SSH_PRIVATE_KEY_PASS }} # Only needed if you added a passphrase upon creating the SSH key

----

Expand Down