summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorZeger-Jan van de Weg <git@zjvandeweg.nl>2020-10-01 10:10:16 +0200
committerZeger-Jan van de Weg <git@zjvandeweg.nl>2020-10-01 10:10:16 +0200
commit1b63fc96e1a11a139ebd7b7f8b1427048a3d79b3 (patch)
treeb7c667bec64defcaa598618fefec26463653f6b0
parent1a2bfecd2f0ebb8e31f9833e0522c4643797041b (diff)
downloadgitlab-shell-1b63fc96e1a11a139ebd7b7f8b1427048a3d79b3.tar.gz
config: Set a secret example
The config.yml.example didn't include a field I was expecting to be there, which lead me to believe the field didn't exist. This change adds the `secret` YAML field, and describes how it interacts with the secrets_file.
-rw-r--r--config.yml.example4
1 files changed, 4 insertions, 0 deletions
diff --git a/config.yml.example b/config.yml.example
index 6689ca8..88e0c7d 100644
--- a/config.yml.example
+++ b/config.yml.example
@@ -38,6 +38,10 @@ auth_file: "/home/git/.ssh/authorized_keys"
# File that contains the secret key for verifying access to GitLab.
# Default is .gitlab_shell_secret in the gitlab-shell directory.
# secret_file: "/home/git/gitlab-shell/.gitlab_shell_secret"
+#
+# The secret field supersecedes the secret_file, and if set that
+# file will not be read.
+# secret: "supersecret"
# Log file.
# Default is gitlab-shell.log in the root directory.