summaryrefslogtreecommitdiffstats
path: root/doc/settings_listing.rst
blob: 1ad751944aec5fe492121a5f002d4c98a7075456 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
.. _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 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