2.5. The Config File¶
privacyIDEA reads its configuration from different locations:
- default configuration from the module
privacyidea/config.py
- then from the config file
/etc/privacyidea/pi.cfg
if it exists and then- from the file specified in the environment variable
PRIVACYIDEA_CONFIGFILE
.
The configuration is overwritten and extended in each step. I.e. values define
in privacyidea/config.py
that are not redefined in one of the other config files, stay the same.
You can create a new config file (either /etc/privacyidea/pi.cfg
) or any other
file at any location and set the environment variable.
The file should contain the following contents:
# The realm, where users are allowed to login as administrators
SUPERUSER_REALM = ['super', 'administrators']
# Your database
SQLALCHEMY_DATABASE_URI = 'sqlite:////etc/privacyidea/data.sqlite'
# This is used to encrypt the auth_token
SECRET_KEY = 't0p s3cr3t'
# This is used to encrypt the admin passwords
PI_PEPPER = "Never know..."
# This is used to encrypt the token data and token passwords
PI_ENCFILE = '/etc/privacyidea/enckey'
# This is used to sign the audit log
PI_AUDIT_KEY_PRIVATE = '/home/cornelius/src/privacyidea/private.pem'
PI_AUDIT_KEY_PUBLIC = '/home/cornelius/src/privacyidea/public.pem'
# PI_LOGFILE = '....'
# PI_LOGLEVEL = 20
# PI_INIT_CHECK_HOOK = 'your.module.function'
Note
The config file is parsed as python code, so you can use variables to set the path and you need to take care for indentations.
If you are using a config file other than /etc/privacyidea/pi.cfg
you need to set the environment variable:
export PRIVACYIDEA_CONFIGFILE=/your/config/file
The SUPERUSER_REALM
is a list of realms, in which the users get the role
of an administrator.
PI_INIT_CHECK_HOOK
is a function in an external module, that will be
called as decorator to token/init
and token/assign
. This function
takes the request
and action
(either “init” or “assing”) as an
arguments and can modify the request or raise an exception to avoid the
request being handled.
There are three config entries, that can be used to define the logging. These
are PI_LOGLEVEL
, PI_LOGFILE
, PI_LOGCONFIG
. These are described in
Debugging and Logging.