This document describes the various configuration options available in Patchwork. These options can be used for both :doc:`development <../development/installation>` and :doc:`deployment <installation>` installations.
Patchwork is a Django application and, as such, relies on Python-based settings files. Refer to the Django documentation for more information on the general format.
Patchwork provides three settings files:
base.py
- A base settings file that should not be used directly.
dev.py
- A settings file for development use. This file is horribly insecure and must not be used in production.
production.example.py
- A sample settings file for production use. This will likely require some heavy customization. The :ref:`deployment guide <deployment-settings>` provides more information.
Patchwork utilizes a number of Patchwork-only settings in addition to the Django and Django REST Framework settings.
If True, the details in ADMINS will be hidden from the About page
(/about
).
.. versionadded:: 2.2
Enable redirections of URLs from previous versions of Patchwork.
The number of days to consider an account confirmation request valid. After this interval, the :ref:`cron management command <deployment-final-steps>` will delete the request.
The default number of items to display in the list pages for a project
(/project/{projectID}/list
) or bundle (/bundle/{userID}/{bundleName}
).
This is customizable on a per-user basis from the user configuration page.
.. versionchanged:: 2.0 This option was previously named ``DEFAULT_PATCHES_PER_PAGE``. It was renamed as cover letters are now supported also.
Enable the :doc:`REST API <../api/rest/index>`.
.. versionadded:: 2.0
Enable the :doc:`XML-RPC API <../api/xmlrpc>`.
Force use of https://
links instead of guessing the scheme based on current
access. This is useful if SSL protocol is terminated upstream of the server
(e.g. at the load balancer)
The maximum number of items that can be requested in a REST API request using
the per_page
parameter.
.. versionadded:: 2.2
The number of minutes to wait before sending any notifications to a user. An notification generated during this time are gathered into a single digest email, ensuring users are not spammed with emails from Patchwork.
The email address that notification emails should be sent from.
The number of items to include in REST API responses by default. This can be
overridden by the per_page
parameter for some endpoints.
.. versionadded:: 2.0