summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorClar Fon <usr@ltdk.xyz>2022-02-07 16:56:45 -0500
committerGitHub <noreply@github.com>2022-02-07 16:56:45 -0500
commit99d14f6051854fe0e6dfc7fb6f4eb0a839179977 (patch)
tree746cd4e72854e696c87f017c9238f510f826879b /docs
parent9911b66aea076347cfb271b12c90bc31e4e5b5f8 (diff)
downloadgitea-99d14f6051854fe0e6dfc7fb6f4eb0a839179977.tar.gz
gitea-99d14f6051854fe0e6dfc7fb6f4eb0a839179977.zip
Add separate SSH_USER config option (#17584)
Co-authored-by: zeripath <art27@cantab.net>
Diffstat (limited to 'docs')
-rw-r--r--docs/content/doc/advanced/config-cheat-sheet.en-us.md1
1 files changed, 1 insertions, 0 deletions
diff --git a/docs/content/doc/advanced/config-cheat-sheet.en-us.md b/docs/content/doc/advanced/config-cheat-sheet.en-us.md
index d8a3b897cc..a3999595ab 100644
--- a/docs/content/doc/advanced/config-cheat-sheet.en-us.md
+++ b/docs/content/doc/advanced/config-cheat-sheet.en-us.md
@@ -265,6 +265,7 @@ The following configuration set `Content-Type: application/vnd.android.package-a
- `DISABLE_SSH`: **false**: Disable SSH feature when it's not available.
- `START_SSH_SERVER`: **false**: When enabled, use the built-in SSH server.
- `BUILTIN_SSH_SERVER_USER`: **%(RUN_USER)s**: Username to use for the built-in SSH Server.
+- `SSH_USER`: **%(BUILTIN_SSH_SERVER_USER)**: SSH username displayed in clone URLs. This is only for people who configure the SSH server themselves; in most cases, you want to leave this blank and modify the `BUILTIN_SSH_SERVER_USER`.
- `SSH_DOMAIN`: **%(DOMAIN)s**: Domain name of this server, used for displayed clone URL.
- `SSH_PORT`: **22**: SSH port displayed in clone URL.
- `SSH_LISTEN_HOST`: **0.0.0.0**: Listen address for the built-in SSH server.