summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorTimothée Ravier <tim@siosm.fr>2018-05-22 03:35:36 +0200
committerLunny Xiao <xiaolunwen@gmail.com>2018-05-22 09:35:36 +0800
commitb3a3024f038f5709bf17f93a009415785ca20475 (patch)
tree2c7b27e9eea493d89082d5dabde97cd1d9460902 /docs
parentd97bb9516c26c04bf459fecf03a09e3e2147baf3 (diff)
downloadgitea-b3a3024f038f5709bf17f93a009415785ca20475.tar.gz
gitea-b3a3024f038f5709bf17f93a009415785ca20475.zip
doc: update LOCAL_ROOT_URL description for PROTOCOL = 'unix' case (#3760)
Update the sample configuration and config cheat sheet description for the LOCAL_ROOT_URL configuration variable to mention the special case required if PROTOCOL is set to 'unix'. Fixes #3741. Signed-off-by: Timothée Ravier <tim@siosm.fr>
Diffstat (limited to 'docs')
-rw-r--r--docs/content/doc/advanced/config-cheat-sheet.en-us.md5
1 files changed, 5 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 16d0a50fad..0d2af62373 100644
--- a/docs/content/doc/advanced/config-cheat-sheet.en-us.md
+++ b/docs/content/doc/advanced/config-cheat-sheet.en-us.md
@@ -95,6 +95,11 @@ Values containing `#` or `;` must be quoted using `` ` `` or `"""`.
- If `PROTOCOL` is set to `fcgi`, Gitea will listen for FastCGI requests on TCP socket
defined by `HTTP_ADDR` and `HTTP_PORT` configuration settings.
- `UNIX_SOCKET_PERMISSION`: **666**: Permissions for the Unix socket.
+- `LOCAL_ROOT_URL`: **%(PROTOCOL)s://%(HTTP_ADDR)s:%(HTTP_PORT)s/**: Local
+ (DMZ) URL for Gitea workers (such as SSH update) accessing web service. In
+ most cases you do not need to change the default value. Alter it only if
+ your SSH server node is not the same as HTTP node. Do not set this variable
+ if `PROTOCOL` is set to `unix`.
- `DISABLE_SSH`: **false**: Disable SSH feature when it's not available.
- `START_SSH_SERVER`: **false**: When enabled, use the built-in SSH server.
- `SSH_DOMAIN`: **%(DOMAIN)s**: Domain name of this server, used for displayed clone URL.