Commit 861b6dd Add documentation for some of the configuration keys that were missing

1 file Authored and Committed by pingou 10 days ago
Add documentation for some of the configuration keys that were missing

Merges https://pagure.io/pagure/pull-request/1450

Signed-off-by: Pierre-Yves Chibon <pingou@pingoured.fr>

    
  1 @@ -107,6 +107,26 @@
  2             key
  3   
  4   
  5 + BOOTSTRAP_URLS_CSS
  6 + ~~~~~~~~~~~~~~~~~~
  7 + 
  8 + This configuration key allows to specify the URL where are hosted the bootstrap
  9 + CSS file since the files hosted on apps.fedoraproject.org used in pagure.io
 10 + are not restricted in browser access.
 11 + 
 12 + Defaults to: ``'https://apps.fedoraproject.org/global/fedora-bootstrap-1.1.1/fedora-bootstrap.css'``
 13 + 
 14 + 
 15 + BOOTSTRAP_URLS_JS
 16 + ~~~~~~~~~~~~~~~~~
 17 + 
 18 + This configuration key allows to specify the URL where are hosted the bootstrap
 19 + JS file since the files hosted on apps.fedoraproject.org used in pagure.io
 20 + are not restricted in browser access.
 21 + 
 22 + Defaults to: ``'https://apps.fedoraproject.org/global/fedora-bootstrap-1.1.1/fedora-bootstrap.js'``
 23 + 
 24 + 
 25   Repo Directories
 26   ----------------
 27   
 28 @@ -1277,7 +1297,84 @@
 29   will not have syntax highlighting as this is a memory intensive procedure that
 30   easily leads to out of memory error on large files or diff.
 31   
 32 - Defaults to: 5000
 33 + Defaults to: ``5000``
 34 + 
 35 + 
 36 + APPLICATION_ROOT
 37 + ~~~~~~~~~~~~~~~~
 38 + 
 39 + This configuration key is used in the path of the cookie used by pagure.
 40 + 
 41 + Defaults to: ``'/'``
 42 + 
 43 + 
 44 + ALLOWED_PREFIX
 45 + ~~~~~~~~~~~~~~
 46 + 
 47 + This configuration key allows to specify a list of allowed namespaces that
 48 + will not require creating a group for users to create projects in.
 49 + 
 50 + Defaults to: ``[]``
 51 + 
 52 + 
 53 + ADMIN_SESSION_LIFETIME
 54 + ~~~~~~~~~~~~~~~~~~~~~~
 55 + 
 56 + This configuration key allows specifying the lifetime of the session during
 57 + which the user won't have to re-login for admin actions.
 58 + In other words, the maximum time between which an user can access a project's
 59 + settings page without re-login.
 60 + 
 61 + Defaults to: ``timedelta(minutes=20)``
 62 + 
 63 + where timedelta comes from the python datetime module
 64 + 
 65 + 
 66 + BLACKLISTED_GROUPS
 67 + ~~~~~~~~~~~~~~~~~~
 68 + 
 69 + This configuration key allows to blacklist some group names.
 70 + 
 71 + Defaults to: ``['forks', 'group']``
 72 + 
 73 + 
 74 + ENABLE_GROUP_MNGT
 75 + ~~~~~~~~~~~~~~~~~
 76 + 
 77 + This configuration key allows to turn on or off managing (ie: creating a
 78 + group, adding or removing users in that group) groups in this pagure instance.
 79 + If turned off, groups and group members are to be managed outside of pagure
 80 + and synced upon login.
 81 + 
 82 + Defaults to: ``True``
 83 + 
 84 + 
 85 + ENABLE_USER_MNGT
 86 + ~~~~~~~~~~~~~~~~
 87 + 
 88 + This configuration key allows to turn on or off managing users (adding or
 89 + removing them from a project) in this pagure instance.
 90 + If turned off, users are managed outside of pagure.
 91 + 
 92 + Defaults to: ``True``
 93 + 
 94 + 
 95 + SESSION_COOKIE_NAME
 96 + ~~~~~~~~~~~~~~~~~~~
 97 + 
 98 + This configuration key allows to specify the name of the session cookie used
 99 + by pagure.
100 + 
101 + Defaults to: ``'pagure'``
102 + 
103 + 
104 + SHOW_PROJECTS_INDEX
105 + ~~~~~~~~~~~~~~~~~~~
106 + 
107 + This configuration key allows to specify what is shown in the index page of
108 + logged in users.
109 + 
110 + Defaults to: ``['repos', 'myrepos', 'myforks']``
111   
112   
113   Deprecated configuration keys