Parameter list
Presentation
The following table describes all configuration
parameters. The colons are:
- Full name: description of the parameter
- Key name: all configuration have a key, used by the Manager to store
them in configuration backend, or by script to override default
value.
- Version: at which version the parameters appeared. If "0", it has
always been there (or we don't remember when)
- GUI: is available in Manager GUI (in the last stable version)
- Portal, Menu, Handler, Manager, Sessions: in which Perl Module the
parameter is used
The key name can be used to ovveride the configuration, when you edit
portal/index.pl, manager/index.pl, manager/sessions.pl or
handler/MyHandler.pm, with this syntax:
The key name can also be seen when you access directly to the
configuration backend (for example with an LDAP browser if you choose the
LDAP
configuration backend).
When a key name contains one or more /, it means that it's multi-level
hash map. For example level1Key / level2Key will be used as:
level1Key => { level2Key => 'value' },
General
parameters
Backends
| Full name |
Key name |
Version |
GUI |
Portal |
Menu |
Handler |
Manager |
Sessions |
| Authentication backend |
authentication |
0 |
Yes |
X |
|
|
|
|
| User backend |
userDB |
0.9.3 |
No |
X |
|
|
|
|
| Password backend |
passwordDB |
0.9.4 |
No |
X |
|
|
|
|
| Session backend |
globalStorage |
0 |
Yes |
X |
|
X |
|
X |
| Session backend options |
globalStorageOptions |
0 |
Yes |
X |
|
X |
|
X |
| Configuration backend |
configStorage |
0 |
No |
X |
|
X |
X |
X |
| Cache backend |
localStorage |
0 |
No |
X |
|
X |
X |
|
| Cache backend options |
localStorageOptions |
0 |
No |
X |
|
X |
X |
|
| Notification backend |
notificationStorage |
0.9.3 |
No |
X |
|
|
|
|
Common
| Full name |
Key name |
Version |
GUI |
Portal |
Menu |
Handler |
Manager |
Sessions |
| Remote user (for Apache logs) |
whatToTrace |
0 |
Yes |
X |
|
X |
X |
X |
| Custom functions |
customFunctions |
0.9.3 |
No |
X |
|
X |
X |
|
| Headers sent |
exportedHeaders |
0 |
Yes |
X |
|
X |
|
|
| Access rules |
locationRules |
0 |
Yes |
X |
|
X |
|
|
| Portal URL |
portal |
0 |
Yes |
X |
|
X |
|
|
| Name of the cookie |
cookieName |
0 |
Yes |
X |
|
X |
|
|
| Main DNS domain |
domain |
0 |
Yes |
X |
|
X |
|
|
| CDA activation |
cda |
0.9.4 |
No |
X |
|
X |
|
|
| Cookie security |
securedCookie |
0 |
Yes |
X |
|
|
|
|
| Attributes from user backend |
exportedVars |
0 |
Yes |
X |
|
|
|
|
| Local groups |
groups |
0 |
Yes |
X |
|
|
|
|
| Macros |
macros |
0 |
Yes |
X |
|
|
|
|
| Session lifetime for cronjob |
timeout |
0 |
Yes |
(purge script) |
|
|
|
|
| Syslog facility |
syslog |
0.9.3 |
No |
X |
|
|
|
|
| SOAP activation |
Soap |
0.9.4 |
No |
X |
|
|
|
|
| Attributes exported in SOAP |
exportedAttr |
0.9.4 |
No |
X |
|
|
|
|
| Store password in session |
storePassword |
0.9.3 |
No |
X |
|
|
|
|
| Notification activation |
notification |
0.9.3 |
No |
X |
|
|
|
|
| Trusted domains |
trustedDomains |
0.9.4 |
No |
X |
|
|
|
|
| Portal object in Menu |
portalObject |
0.9.3 |
No |
|
X |
|
|
|
| XML file for applications |
apps / xmlfile |
0.9.3 |
No |
|
X |
|
|
|
| Path for applications logos |
apps / imgpath |
0.9.3 |
No |
|
X |
|
|
|
| Display application tab |
modules / appslist |
0.9.3 |
No |
|
X |
|
|
|
| Display password tab |
modules / password |
0.9.3 |
No |
|
X |
|
|
|
| Display logout tab |
modules / logout |
0.9.3 |
No |
|
X |
|
|
|
| Status module |
status |
0.9 |
No |
|
|
X |
|
|
| Force HTTPS in redirection |
https |
0 |
No |
|
|
X |
|
|
| Force port in redirection |
port |
0 |
No |
|
|
X |
|
|
| Protection scheme |
protection |
0 |
No |
|
|
(CGI) |
X |
X |
| Manager images path |
dhtmlXTreeImageLocation |
0 |
No |
|
|
|
X |
|
| File apply.conf |
applyConfFile |
0 |
No |
|
|
|
X |
|
| CSS file |
cssFile |
0 |
No |
|
|
|
X |
|
| Javascript file |
jsFile |
0 |
No |
|
|
|
X |
|
| Text area width |
textareaW |
0 |
No |
|
|
|
X |
|
| Text area height |
textareaH |
0 |
No |
|
|
|
X |
|
| Input width |
inputSize |
0 |
No |
|
|
|
X |
|
| Sessions image path |
imagePath |
0.9.3 |
No |
|
|
|
|
X |
| jQuery URI |
jqueryUri |
0.9.3 |
No |
|
|
|
|
X |
| Use XForwardedFor for IP |
useXForwardedForIP |
0.9.4 |
No |
|
|
|
|
X |
SMTP
(reset password by mail)
| Full name |
Key name |
Version |
GUI |
Portal |
Menu |
Handler |
Manager |
Sessions |
| SMTP server |
SMTPServer |
0.9.4 |
No |
X |
|
|
|
|
| Mail From address |
mailFrom |
0.9.4 |
No |
X |
|
|
|
|
| Mail subject |
mailSubject |
0.9.4 |
No |
X |
|
|
|
|
| Regexp for random password |
randomPasswordRegexp |
0.9.4 |
No |
X |
|
|
|
|
| Body of the mail |
mailBody |
0.9.4 |
No |
X |
|
|
|
|
Authentication configuration
(Portal only)
LDAP
| Full name |
Key name |
Version |
GUI |
| Server |
ldapServer |
0 |
Yes |
| Port |
ldapPort |
0 |
Yes |
| Search base |
ldapBase |
0 |
Yes |
| Bind DN |
managerDn |
0 |
Yes |
| Bind Password |
managerPassword |
0 |
Yes |
| Main search filter |
LDAPFilter |
0 |
No |
| Authentication search filter |
AuthLDAPFilter |
0.9 |
No |
| Mail search filter |
mailLDAPFilter |
0.9.4 |
No |
| Password policy control |
ldapPpolicyControl |
0.9.1 |
No |
| Extended SetPassword modify |
ldapSetPassword |
0.9.4 |
No |
| Groups base |
ldapGroupBase |
0.8 |
No |
| Groups objectClass |
ldapGroupObjectClass |
0.9.4 |
No |
| Groups member attribute |
ldapGroupAttributeName |
0.9.4 |
No |
| Groups member link value |
ldapGroupAttributeNameUser |
0.9.4 |
No |
| Groups name attribute |
ldapGroupAttributeNameSearch |
0.9.4 |
No |
SSL
| Full name |
Key name |
Version |
GUI |
| User field in certificate |
SSLvar |
0 |
No |
| Map with LDAP attribute |
SSLLDAPField |
0 |
No |
| Force SSL authentication |
SSLRequire |
0 |
No |
CAS
| Full name |
Key name |
Version |
GUI |
| CAS server URL |
CAS_url |
0 |
No |
| CAS login URL |
CAS_loginUrl |
0 |
No |
| CAS validation URL |
CAS_validationUrl |
0 |
No |
| CAS CA file |
CAS_CAFile |
0 |
No |
Remote
| Full name |
Key name |
Version |
GUI |
| Remote portal |
remotePortal |
0.9.4 |
No |
| Remote Session backend |
remoteGlobalStorage |
0.9.4 |
No |
| Remote Session backend options |
remoteGlobalStorageOptions |
0.9.4 |
No |
Liberty
Alliance
| Full name |
Key name |
Version |
GUI |
| SP certificate |
laSP / certificate |
0.9 |
No |
| SP metadata (XML file) |
laSP / metadata |
0.9 |
No |
| SP private key |
laSP / privkey |
0.9 |
No |
| SP secret key |
laSP / secretkey |
0.9 |
No |
| IDPs list (XML file) |
laIdpsFile |
0.9 |
No |
| Debug activation |
laDebug |
0.9 |
No |
| LDAP attribute in assertion |
laLdapLoginAttribute |
0.9 |
No |
| Federation storage |
laStorage |
0.9 |
No |
| Federation storage options |
laStorageOptions |
0.9 |
No |