From 8ad0fa0990e70d49595ee66db638c6c8c08258c3 Mon Sep 17 00:00:00 2001 From: jojobyte <184880+jojobyte@users.noreply.github.com> Date: Tue, 3 Oct 2023 23:58:59 -0600 Subject: [PATCH] docs: :memo: update readme --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ee987cc..617e23c 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,15 @@ Rsync files from a GitHub repo to a destination server over SSH | `SSH_PRIVATE_KEY` | The private key part of an SSH key pair. The public key part should be added to the `authorized_keys` on the destination server. | | `SSH_USERNAME` | The username to use when connecting to the destination server | | `SSH_HOSTNAME` | The hostname of the destination server | -| `SSH_CONFIG` | Override the SSH config (~/.ssh/config) file | +| `SSH_CONFIG` | Override the SSH config (/gh-rsync/.ssh/config) file | + +```sh +# The `SSH_PRIVATE_KEY` will be stored in `/gh-rsync/.ssh/deploy_key` +# It can be referenced in a `SSH_CONFIG` like: + +Host example.com + IdentityFile /gh-rsync/.ssh/deploy_key +``` ## Required arguments