summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorMikaël Ates <mates@entrouvert.com>2011-12-20 17:48:18 (GMT)
committerMikaël Ates <mates@entrouvert.com>2011-12-20 17:48:18 (GMT)
commit8ef4fdb71350f362409448be5b526306684263d0 (patch)
treec0d0d74912e55448a3560d63c73f4212ad20f81c /doc
parentbd7f68991d0626d445c53898efd757168dba7d35 (diff)
downloadauthentic-8ef4fdb71350f362409448be5b526306684263d0.zip
authentic-8ef4fdb71350f362409448be5b526306684263d0.tar.gz
authentic-8ef4fdb71350f362409448be5b526306684263d0.tar.bz2
[doc] Add a page about settings.py.
Diffstat (limited to 'doc')
-rw-r--r--doc/index.rst4
-rw-r--r--doc/settings.rst139
2 files changed, 142 insertions, 1 deletions
diff --git a/doc/index.rst b/doc/index.rst
index ced4366..25e2795 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -24,7 +24,7 @@ The Documentation is under the licence Creative Commons `CC BY-SA 2.0 <http://cr
- `Authentic2 project site <http://dev.entrouvert.org/projects/authentic>`_
- `Authentic2 roadmap <http://dev.entrouvert.org/projects/authentic/roadmap>`_
-- `Documentation in PDF <http://dev.entrouvert.org/attachments/148/Authentic2.pdf>`_
+- `Documentation in PDF <https://dev.entrouvert.org/attachments/158/Authentic2.pdf>`_
Documentation content
=====================
@@ -38,6 +38,8 @@ Documentation content
installation
+ settings
+
auth_ldap
auth_pam
diff --git a/doc/settings.rst b/doc/settings.rst
new file mode 100644
index 0000000..39665d3
--- /dev/null
+++ b/doc/settings.rst
@@ -0,0 +1,139 @@
+.. _settings:
+
+================
+General settings
+================
+
+How do I configure the general settings ?
+=========================================
+
+Edit the file settings.py in the project directory authentic2.
+
+A settings file is a Python module with module-level variables. So configure
+general settings is done by modifying those variables and reloading your
+application server.
+
+See the django documentation for more details about the settings files
+management.
+
+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 SAML2 authentication, Authentic 2 is a SAML2 service provider
+====================================================================================
+
+Variable: AUTH_SAML2
+
+Values:
+
+* False: deactivate SAML2 authentication
+* True: activate SAML2 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 one-time password authentication
+=======================================================
+
+Variable: AUTH_OATH
+
+Values:
+
+* False: deactivate one-time password authentication
+* True: activate one-time password 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 an OpenID provider
+========================================================
+
+Variable: IDP_OPENID
+
+Values:
+
+* False: deactivate OpenID provider
+* True: activate OpenID provider
+
+Activate or deactivate Authentic 2 as a CAS server
+==================================================
+
+Variable: IDP_CAS
+
+Values:
+
+* False: deactivate CAS server
+* True: activate CAS server