add URLs of the source files for all settings (#54983)

The settings names and default values are scattered in the sources and
it is non trivial to figure out where they are. Add a list of all
source files that contain settings variables as a reference.

License MIT
This commit is contained in:
Loïc Dachary 2021-06-18 13:06:00 +02:00
parent aedeacb681
commit de673e3616
No known key found for this signature in database
GPG Key ID: 130A0B53C3EEB5FA
1 changed files with 21 additions and 2 deletions

View File

@ -4,8 +4,27 @@
Configuration
=============
Configuration with settings
===========================
Configuration from files
========================
Authentic 2 can be configured by adding or overriding:
* `Django settings <https://docs.djangoproject.com/en/2.2/topics/settings/>`__
* `Authentic 2 Django settings <https://git.entrouvert.org/authentic.git/tree/src/authentic2/settings.py>`__
* `Authentic 2 A2_* settings <https://git.entrouvert.org/authentic.git/tree/src/authentic2/app_settings.py>`__
* `Authentic 2 SAML_* settings <https://git.entrouvert.org/authentic.git/tree/src/authentic2/saml/app_settings.py>`__
* `Authentic 2 A2_FC_* settings <https://git.entrouvert.org/authentic.git/tree/src/authentic2_auth_fc/app_settings.py>`__
* `Authentic 2 A2_AUTH_OIDC_* settings <https://git.entrouvert.org/authentic.git/tree/src/authentic2_auth_oidc/app_settings.py>`__
* `Authentic 2 A2_AUTH_SAML_* settings <https://git.entrouvert.org/authentic.git/tree/src/authentic2_auth_saml/app_settings.py>`__
* `Authentic 2 A2_IDP_CAS_* settings <https://git.entrouvert.org/authentic.git/tree/src/authentic2_idp_cas/app_settings.py>`__
* `Authentic 2 A2_IDP_OIDC_* settings <https://git.entrouvert.org/authentic.git/tree/src/authentic2_idp_oidc/app_settings.py>`__
* `Authentic 2 LDAP_AUTH_SETTINGS <https://git.entrouvert.org/authentic.git/tree/src/authentic2/backends/ldap_backend.py#n531>`__
The following files will be read, in the following order, and their
value will override the defaults found in the sources above:
* `/etc/authentic2/config.py`
* `/etc/authentic2/settings.d/*.py` (sorted in alphabetical order)
Configuration with the administration interface
===============================================