From 56ebe2fbeede39681bf779debbc15cfb41bcfb2b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Dachary?= Date: Fri, 18 Jun 2021 12:41:59 +0200 Subject: [PATCH] remove partial and outdated documentation on settings SAML_SIGNATURE_PUBLIC_KEY no longer exist and is only one of many settings. It is documented at the same level as generic Django settings such as DEBUG and it is unclear where exactly those settings should be set. License MIT --- configuration.rst | 5 --- settings_listing.rst | 97 -------------------------------------------- 2 files changed, 102 deletions(-) delete mode 100644 settings_listing.rst diff --git a/configuration.rst b/configuration.rst index 6a34bab..171c453 100644 --- a/configuration.rst +++ b/configuration.rst @@ -7,11 +7,6 @@ Configuration Configuration with settings =========================== -.. toctree:: - :maxdepth: 1 - - settings_listing - Configuration with the administration interface =============================================== diff --git a/settings_listing.rst b/settings_listing.rst deleted file mode 100644 index 030060c..0000000 --- a/settings_listing.rst +++ /dev/null @@ -1,97 +0,0 @@ -.. _settings_listing: - -============ -All settings -============ - -Activate or deactivate debug mode -================================= - -Variable: DEBUG - -Values: - -* False: deactivate debug mode -* True: activate debug mode - -Manage session cookie duration -============================== - -Variable: SESSION_EXPIRE_AT_BROWSER_CLOSE - -Values: - -* False: Cookies are not removed when browser is closed. -* True: Cookies are removed when browser is closed. - -Variable: SESSION_COOKIE_AGE - -Value: - -* Seconds (36000 equal 10 hours) - -Time zone selection -=================== - -Variable: TIME_ZONE - -Values: - -* See http://en.wikipedia.org/wiki/List_of_tz_zones_by_name - -Activate or deactivate SSL authentication -========================================= - -Variable: AUTH_SSL - -Values: - -* False: deactivate SSL authentication -* True: activate SSL authentication - -Activate or deactivate OpenID authentication, Authentic 2 is an OpenID relying party -==================================================================================== - -Variable: AUTH_OPENID - -Values: - -* False: deactivate OpenID authentication -* True: activate OpenID authentication - -Activate or deactivate Authentic 2 as a SAML2 identity provider -=============================================================== - -Variable: IDP_SAML2 - -Values: - -* False: deactivate SAML2 identity provider -* True: activate SAML2 identity provider - -Configure SAML2 keys -==================== - -* SAML_SIGNATURE_PUBLIC_KEY: Certtificate or public key for signature -* SAML_SIGNATURE_PRIVATE_KEY: Private key for signature -* SAML_ENCRYPTION_PUBLIC_KEY: Certtificate or public key for encryption -* SAML_ENCRYPTION_PRIVATE_KEY: Private key for encryption - -Values are pem files of X509 certificate or key, e.g.: -SAML_SIGNATURE_PRIVATE_KEY = '''-----BEGIN RSA PRIVATE KEY----- -MII...WA== ------END RSA PRIVATE KEY-----''' - -If SAML_ENCRYPTION_PUBLIC_KEY or SAML_ENCRYPTION_PRIVATE_KEY are not given, -the signature keys are used for encryption. - - -Activate or deactivate Authentic 2 as a CAS server -================================================== - -Variable: IDP_CAS - -Values: - -* False: deactivate CAS server -* True: activate CAS server