|
@@ -477,7 +477,7 @@ If none of these options are set, a single queue will be used for all tasks.
|
|
|
FAST_CELERY_QUEUE
|
|
|
~~~~~~~~~~~~~~~~~
|
|
|
|
|
|
-This configuration key allows to specify a dedicated queue for tasks that
|
|
|
+This configuration key can be used to specify a dedicated queue for tasks that
|
|
|
are triggered by the web frontend and need to be processed quickly for the
|
|
|
best user experience.
|
|
|
|
|
@@ -489,7 +489,7 @@ Defaults to: ``None``.
|
|
|
MEDIUM_CELERY_QUEUE
|
|
|
~~~~~~~~~~~~~~~~~~~
|
|
|
|
|
|
-This configuration key allows to specify a dedicated queue for tasks that
|
|
|
+This configuration key can be used to specify a dedicated queue for tasks that
|
|
|
are triggered by the web frontend and need to be processed but aren't critical
|
|
|
for the best user experience.
|
|
|
|
|
@@ -500,7 +500,7 @@ Defaults to: ``None``.
|
|
|
SLOW_CELERY_QUEUE
|
|
|
~~~~~~~~~~~~~~~~~
|
|
|
|
|
|
-This configuration key allows to specify a dedicated queue for tasks that
|
|
|
+This configuration key can be used to specify a dedicated queue for tasks that
|
|
|
are triggered by the web frontend, are slow and do not impact the user
|
|
|
experience in the user interface.
|
|
|
|
|
@@ -520,7 +520,7 @@ stomp-compliant message bus.
|
|
|
STOMP_NOTIFICATIONS
|
|
|
~~~~~~~~~~~~~~~~~~~
|
|
|
|
|
|
-This configuration key allows to turn on or off notifications via
|
|
|
+This configuration key can be used to turn on or off notifications via
|
|
|
`stomp protocol <https://stomp.github.io/>`_. All other stomp-related
|
|
|
settings don't need to be present if this is set to ``False``.
|
|
|
|
|
@@ -570,7 +570,7 @@ password-encoded.
|
|
|
ALWAYS_STOMP_ON_COMMITS
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
|
|
-This configuration key allows to enforce `stomp <https://stomp.github.io/>`_
|
|
|
+This configuration key can be used to enforce `stomp <https://stomp.github.io/>`_
|
|
|
notifications on commits made on all projects in a pagure instance.
|
|
|
|
|
|
Defaults to: ``False``.
|
|
@@ -583,14 +583,14 @@ ACLS
|
|
|
~~~~
|
|
|
|
|
|
This configuration key lists all the ACLs that can be associated with an API
|
|
|
-token with a short description of what the ACL allows to do.
|
|
|
+token with a short description of what the ACL allows one to do.
|
|
|
This key it not really meant to be changed unless you really know what you
|
|
|
are doing.
|
|
|
|
|
|
USER_ACLS
|
|
|
~~~~~~~~~
|
|
|
|
|
|
-This configuration key allows to list which of the ACLs listed in ``ACLS``
|
|
|
+This configuration key can be used to list which of the ACLs listed in ``ACLS``
|
|
|
can be associated with an API token of a project in the (web) user interface.
|
|
|
|
|
|
Use this configuration key in combination with ``ADMIN_API_ACLS`` to disable
|
|
@@ -603,7 +603,7 @@ Defaults to: ``[key for key in ACLS.keys() if key != 'generate_acls_project']``
|
|
|
ADMIN_API_ACLS
|
|
|
~~~~~~~~~~~~~~
|
|
|
|
|
|
-This configuration key allows to list which of the ACLs listed in ``ACLS``
|
|
|
+This configuration key can be used to list which of the ACLs listed in ``ACLS``
|
|
|
can be generated by the ``pagure-admin`` CLI tool by admins.
|
|
|
|
|
|
Defaults to: ``['issue_comment', 'issue_create', 'issue_change_status', 'pull_request_flag', 'pull_request_comment', 'pull_request_merge', 'generate_acls_project', 'commit_flag', 'create_branch']``
|
|
@@ -612,7 +612,7 @@ Defaults to: ``['issue_comment', 'issue_create', 'issue_change_status', 'pull_re
|
|
|
CROSS_PROJECT_ACLS
|
|
|
~~~~~~~~~~~~~~~~~~
|
|
|
|
|
|
-This configuration key allows to list which of the ACLs listed in ``ACLS``
|
|
|
+This configuration key can be used to list which of the ACLs listed in ``ACLS``
|
|
|
can be associated with a project-less API token in the (web) user interface.
|
|
|
These project-less API tokens can be generated in the user's settings page
|
|
|
and allows action in multiple projects instead of being restricted to a
|
|
@@ -1034,7 +1034,7 @@ Defaults to: ``True``
|
|
|
ENABLE_TICKETS_NAMESPACE
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
|
|
-This configuration key allows to restrict the namespace in which the ticketing
|
|
|
+This configuration key can be used to restrict the namespace in which the ticketing
|
|
|
system is enabled.
|
|
|
So if your pagure instance has ``ENABLE_TICKETS`` as ``True`` and sets
|
|
|
``ENABLE_TICKETS_NAMESPACE`` to ``['tests', 'infra']`` only the projects opened
|
|
@@ -1124,7 +1124,7 @@ Defaults to: ``False``.
|
|
|
FEDMSG_NOTIFICATIONS
|
|
|
~~~~~~~~~~~~~~~~~~~~
|
|
|
|
|
|
-This configuration key allows to turn on or off notifications via `fedmsg
|
|
|
+This configuration key can be used to turn on or off notifications via `fedmsg
|
|
|
<http://www.fedmsg.com/>`_.
|
|
|
|
|
|
Defaults to: ``False``.
|
|
@@ -1133,7 +1133,7 @@ Defaults to: ``False``.
|
|
|
FEDORA_MESSAGING_NOTIFICATIONS
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
|
|
-This configuration key allows to turn on or off sending notifications via
|
|
|
+This configuration key can be used to turn on or off sending notifications via
|
|
|
`fedora-messaging <>`_.
|
|
|
|
|
|
Defaults to: ``False``.
|
|
@@ -1142,7 +1142,7 @@ Defaults to: ``False``.
|
|
|
ALWAYS_FEDMSG_ON_COMMITS
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
|
|
-This configuration key allows to enforce `fedmsg <http://www.fedmsg.com/>`_
|
|
|
+This configuration key can be used to enforce `fedmsg <http://www.fedmsg.com/>`_
|
|
|
notifications on commits made on all projects in a pagure instance.
|
|
|
|
|
|
Defaults to: ``True``.
|
|
@@ -1181,7 +1181,7 @@ Defaults to: ``[]``.
|
|
|
LOCAL_SSH_KEY
|
|
|
~~~~~~~~~~~~~
|
|
|
|
|
|
-This configuration key allows to let pagure administrate the user's ssh keys
|
|
|
+This configuration key can be used to let pagure administrate the user's ssh keys
|
|
|
or have a third party tool do it for you.
|
|
|
In most cases, it will be fine to let pagure handle it.
|
|
|
|
|
@@ -1191,7 +1191,7 @@ Defaults to ``True``.
|
|
|
DEPLOY_KEY
|
|
|
~~~~~~~~~~
|
|
|
|
|
|
-This configuration key allows to disable the deploy keys feature of an
|
|
|
+This configuration key can be used to disable the deploy keys feature of an
|
|
|
entire pagure instance. This feature enable to add extra public ssh keys
|
|
|
that a third party could use to push to a project.
|
|
|
|
|
@@ -1263,7 +1263,7 @@ Defaults to: ``root@localhost.localdomain``
|
|
|
USER_NAMESPACE
|
|
|
~~~~~~~~~~~~~~
|
|
|
|
|
|
-This configuration key allows to enforce that project are namespaced under
|
|
|
+This configuration key can be used to enforce that project are namespaced under
|
|
|
the user's username, behaving in this way in a similar fashion as github.com
|
|
|
or gitlab.com.
|
|
|
|
|
@@ -1317,10 +1317,10 @@ TRIGGER_CI
|
|
|
|
|
|
A run of pagure-ci can be manually triggered if some key sentences are added
|
|
|
as comment to a pull-request, either manually or via the "Rerun CI" dropdown.
|
|
|
-This allows to re-run a test that failed due to some network outage or other
|
|
|
+This allows one to re-run a test that failed due to some network outage or other
|
|
|
unexpected issues unrelated to the test suite.
|
|
|
|
|
|
-This configuration key allows to define all the sentences that can be used
|
|
|
+This configuration key can be used to define all the sentences that can be used
|
|
|
to trigger this pagure-ci run. The format is following: ``{"<sentence>":
|
|
|
{"name": "<name of the CI>", "description": "<short description>"}}``
|
|
|
|
|
@@ -1418,7 +1418,7 @@ To give access to just some projects (named ``rpms/test`` and
|
|
|
REQUIRED_GROUPS
|
|
|
~~~~~~~~~~~~~~~
|
|
|
|
|
|
-The required groups allows to specify in which group an user must be to be
|
|
|
+The required groups allows one to specify in which group an user must be to be
|
|
|
added to a project with commit or admin access.
|
|
|
|
|
|
Defaults to: ``{}``
|
|
@@ -1520,7 +1520,7 @@ Defaults to: ``{}``
|
|
|
CASE_SENSITIVE
|
|
|
~~~~~~~~~~~~~~
|
|
|
|
|
|
-This configuration key allows to make this pagure instance case sensitive
|
|
|
+This configuration key can be used to make this pagure instance case sensitive
|
|
|
instead of its default: case-insensitive.
|
|
|
|
|
|
Defaults to: ``False``
|
|
@@ -1529,7 +1529,7 @@ Defaults to: ``False``
|
|
|
PROJECT_NAME_REGEX
|
|
|
~~~~~~~~~~~~~~~~~~
|
|
|
|
|
|
-This configuration key allows to customize the regular expression used to
|
|
|
+This configuration key can be used to customize the regular expression used to
|
|
|
validate new project name.
|
|
|
|
|
|
Defaults to: ``^[a-zA-z0-9_][a-zA-Z0-9-_]*$``
|
|
@@ -1546,7 +1546,7 @@ Defaults to: ``'/'``
|
|
|
ALLOWED_PREFIX
|
|
|
~~~~~~~~~~~~~~
|
|
|
|
|
|
-This configuration key allows to specify a list of allowed namespaces that
|
|
|
+This configuration key can be used to specify a list of allowed namespaces that
|
|
|
will not require creating a group for users to create projects in.
|
|
|
|
|
|
Defaults to: ``[]``
|
|
@@ -1568,7 +1568,7 @@ where timedelta comes from the python datetime module
|
|
|
BLACKLISTED_GROUPS
|
|
|
~~~~~~~~~~~~~~~~~~
|
|
|
|
|
|
-This configuration key allows to blacklist some group names.
|
|
|
+This configuration key can be used to blacklist some group names.
|
|
|
|
|
|
Defaults to: ``['forks', 'group']``
|
|
|
|
|
@@ -1576,7 +1576,7 @@ Defaults to: ``['forks', 'group']``
|
|
|
ENABLE_GROUP_MNGT
|
|
|
~~~~~~~~~~~~~~~~~
|
|
|
|
|
|
-This configuration key allows to turn on or off managing (ie: creating a
|
|
|
+This configuration key can be used to turn on or off managing (ie: creating a
|
|
|
group, adding or removing users in that group) groups in this pagure instance.
|
|
|
If turned off, groups and group members are to be managed outside of pagure
|
|
|
and synced upon login.
|
|
@@ -1587,7 +1587,7 @@ Defaults to: ``True``
|
|
|
ENABLE_USER_MNGT
|
|
|
~~~~~~~~~~~~~~~~
|
|
|
|
|
|
-This configuration key allows to turn on or off managing users (adding or
|
|
|
+This configuration key can be used to turn on or off managing users (adding or
|
|
|
removing them from a project) in this pagure instance.
|
|
|
If turned off, users are managed outside of pagure.
|
|
|
|
|
@@ -1597,7 +1597,7 @@ Defaults to: ``True``
|
|
|
SESSION_COOKIE_NAME
|
|
|
~~~~~~~~~~~~~~~~~~~
|
|
|
|
|
|
-This configuration key allows to specify the name of the session cookie used
|
|
|
+This configuration key can be used to specify the name of the session cookie used
|
|
|
by pagure.
|
|
|
|
|
|
Defaults to: ``'pagure'``
|
|
@@ -1606,7 +1606,7 @@ Defaults to: ``'pagure'``
|
|
|
SHOW_PROJECTS_INDEX
|
|
|
~~~~~~~~~~~~~~~~~~~
|
|
|
|
|
|
-This configuration key allows to specify what is shown in the index page of
|
|
|
+This configuration key can be used to specify what is shown in the index page of
|
|
|
logged in users.
|
|
|
|
|
|
Defaults to: ``['repos', 'myrepos', 'myforks']``
|
|
@@ -1619,7 +1619,7 @@ By default pagure sends an email to every one watch commits on a project when a
|
|
|
commit is made.
|
|
|
However some pagure instances may be using a different notification mechanism on
|
|
|
commits and thus may not want this feature to double the notifications received.
|
|
|
-This configuration key allows to turn on or off email being sent to people
|
|
|
+This configuration key can be used to turn on or off email being sent to people
|
|
|
watching commits on a project upon commits.
|
|
|
|
|
|
Defaults to: ``True``
|
|
@@ -1689,7 +1689,7 @@ Defaults to: ``False``
|
|
|
SYNTAX_ALIAS_OVERRIDES
|
|
|
~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
|
|
-This configuration key allows to force highlight.js to use a certain logic
|
|
|
+This configuration key can be used to force highlight.js to use a certain logic
|
|
|
on certain files based on their extensions.
|
|
|
|
|
|
It should be a dictionary containing the file extensions as keys and
|
|
@@ -1703,7 +1703,7 @@ RepoSpanner Options
|
|
|
|
|
|
Pagure can be integrated with `repoSpanner <https://repospanner.org>`_
|
|
|
allowing to deploy pagure in a load-balanced environment since the git
|
|
|
-repositories are then synced accross multiple servers simultaneously.
|
|
|
+repositories are then synced across multiple servers simultaneously.
|
|
|
|
|
|
Support for this integration has been included in Pagure version 5.0 and higher.
|
|
|
|
|
@@ -1763,7 +1763,7 @@ Defaults to: ``False``
|
|
|
REPOSPANNER_REGIONS
|
|
|
~~~~~~~~~~~~~~~~~~~
|
|
|
|
|
|
-This configuration key allows to specify the different region where repoSpanner
|
|
|
+This configuration key can be used to specify the different region where repoSpanner
|
|
|
is deployed and thus with which this pagure instance can be integrated.
|
|
|
|
|
|
An example entry could look like:
|
|
@@ -1947,7 +1947,7 @@ Defaults to: ``None``
|
|
|
MQTT_TOPIC_PREFIX
|
|
|
~~~~~~~~~~~~~~~~~
|
|
|
|
|
|
-This configuration key allows to specify a prefix to the mqtt messages sent.
|
|
|
+This configuration key can be used to specify a prefix to the mqtt messages sent.
|
|
|
This prefix will be added to the topic used by pagure thus allowing the mqtt
|
|
|
admins to specify a parent topic for all pagure-related messages.
|
|
|
|
|
@@ -1957,7 +1957,7 @@ Defaults to: ``None``
|
|
|
ALWAYS_MQTT_ON_COMMITS
|
|
|
~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
|
|
-This configuration key allows to enforce `mqtt <https://mqtt.org/>`_
|
|
|
+This configuration key can be used to enforce `mqtt <https://mqtt.org/>`_
|
|
|
notifications on commits made on all projects in a pagure instance.
|
|
|
|
|
|
Defaults to: ``False``.
|
|
@@ -2013,7 +2013,7 @@ Usage of docs and tickets can be triggered by setting `ENABLE_DOCS` and
|
|
|
FILE_SIZE_HIGHLIGHT
|
|
|
~~~~~~~~~~~~~~~~~~~
|
|
|
|
|
|
-This configuration key allows to specify the maximum number of characters a file
|
|
|
+This configuration key can be used to specify the maximum number of characters a file
|
|
|
or diff should have to have syntax highlighting. Everything above this limit
|
|
|
will not have syntax highlighting as this is a memory intensive procedure that
|
|
|
easily leads to out of memory error on large files or diff.
|
|
@@ -2024,7 +2024,7 @@ Defaults to: ``5000``
|
|
|
BOOTSTRAP_URLS_CSS
|
|
|
~~~~~~~~~~~~~~~~~~
|
|
|
|
|
|
-This configuration key allows to specify the URL where are hosted the bootstrap
|
|
|
+This configuration key can be used to specify the URL where are hosted the bootstrap
|
|
|
CSS file since the files hosted on apps.fedoraproject.org used in pagure.io
|
|
|
are not restricted in browser access.
|
|
|
|
|
@@ -2037,7 +2037,7 @@ documentation <https://docs.pagure.org/pagure/usage/theming.html>`_
|
|
|
BOOTSTRAP_URLS_JS
|
|
|
~~~~~~~~~~~~~~~~~
|
|
|
|
|
|
-This configuration key allows to specify the URL where are hosted the bootstrap
|
|
|
+This configuration key can be used to specify the URL where are hosted the bootstrap
|
|
|
JS file since the files hosted on apps.fedoraproject.org used in pagure.io
|
|
|
are not restricted in browser access.
|
|
|
|