From 3c79569bd7aa12823b08a9d823d58d6eaee59522 Mon Sep 17 00:00:00 2001 From: Andres Lowrie Date: Tue, 6 Oct 2020 11:23:18 -0500 Subject: [PATCH] docs: add PAT option for `--password` This could help users that are not aware that github personal access tokens can be used as passwords. It's verbose could be helpful --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 57ded18..8520917 100644 --- a/README.md +++ b/README.md @@ -99,7 +99,7 @@ docker run -d \ | GIT_SYNC_WEBHOOK_TIMEOUT | `--webhook-timeout` | the timeout for the webhook | 1 (second) | | GIT_SYNC_WEBHOOK_BACKOFF | `--webhook-backoff` | the time to wait before retrying a failed webhook | 3 (seconds) | | GIT_SYNC_USERNAME | `--username` | the username to use for git auth | "" | -| GIT_SYNC_PASSWORD | `--password` | the password to use for git auth (users should prefer env vars for passwords) | "" | +| GIT_SYNC_PASSWORD | `--password` | the password or [personal access token](https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/creating-a-personal-access-token) to use for git auth. (users should prefer env vars for passwords) | "" | | GIT_SYNC_SSH | `--ssh` | use SSH for git operations | false | | GIT_SSH_KEY_FILE | `--ssh-key-file` | the SSH key to use | "/etc/git-secret/ssh" | | GIT_KNOWN_HOSTS | `--ssh-known-hosts` | enable SSH known_hosts verification | true |