diff --git a/doc/configuration.rst b/doc/configuration.rst index 4daeaa1..4c6a666 100644 --- a/doc/configuration.rst +++ b/doc/configuration.rst @@ -5,6 +5,7 @@ Pagure offers a wide varieties of options that must or can be used to adjust its behavior. + Must options ------------ @@ -85,6 +86,7 @@ The URL should end with a slash ``/``. Defaults to: ``'git://pagure.org/'`` + Repo Directories ---------------- @@ -198,6 +200,7 @@ upload. For more information, see the install.rst guide. Defaults to: ``False`` + Configure Gitolite ------------------ @@ -256,6 +259,7 @@ using a package manager or something like ``/opt/bin/`` for a more custom install. + EventSource options ------------------- @@ -277,6 +281,7 @@ running. below) + Web-hooks notifications ----------------------- @@ -292,6 +297,7 @@ Defaults to: ``False``. below) + Redis options ------------- @@ -320,6 +326,7 @@ communicating with the EventSource server. Defaults to: ``0``. + Authentication options ---------------------- @@ -340,6 +347,7 @@ the users in the admin groups listed above as well as admin rights to all projects hosted on this pagure instance. + Optional options ---------------- @@ -446,7 +454,6 @@ Defaults to: ] - CHECK_SESSION_IP ~~~~~~~~~~~~~~~~ @@ -586,6 +593,17 @@ or gitlab.com. Defaults to: ``False`` +DOC_APP_URL +~~~~~~~~~~~ + +This configuration key allows you to specify where the documentation server +is running (preferably in a different domain name entirely). +If not set, the documentation page will show an error message saying that +this pagure instance does not have a documentation server. + +Defaults to: ``None`` + + Deprecated configuration keys -----------------------------