From ed4935e6962fbbe2628904233c58f47987db49e1 Mon Sep 17 00:00:00 2001 From: Adrian Sieber <36796532+ad-si@users.noreply.github.com> Date: Wed, 4 Apr 2018 21:08:55 +0000 Subject: [PATCH] Clarify purpose of ROOT_URL (#3759) --- docs/content/doc/advanced/config-cheat-sheet.en-us.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) 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 0ec48bd28c..237016e2d8 100644 --- a/docs/content/doc/advanced/config-cheat-sheet.en-us.md +++ b/docs/content/doc/advanced/config-cheat-sheet.en-us.md @@ -84,7 +84,9 @@ Values containing `#` or `;` must be quoted using `` ` `` or `"""`. - `PROTOCOL`: **http**: \[http, https, fcgi, unix\] - `DOMAIN`: **localhost**: Domain name of this server. -- `ROOT_URL`: **%(PROTOCOL)s://%(DOMAIN)s:%(HTTP\_PORT)s/**: Full public URL of Gitea server. +- `ROOT_URL`: **%(PROTOCOL)s://%(DOMAIN)s:%(HTTP\_PORT)s/**: + Overwrite the automatically generated public URL. + This is useful if the internal and the external URL don't match (e.g. in Docker). - `HTTP_ADDR`: **0.0.0.0**: HTTP listen address. - If `PROTOCOL` is set to `fcgi`, Gitea will listen for FastCGI requests on TCP socket defined by `HTTP_ADDR` and `HTTP_PORT` configuration settings.