man/ipsilon.conf.5

   1 .\" Copyright (C) 2015 Ipsilon Project Contributors
   2 .\"
   3 .TH "ipsilon.conf" "5" "1.1.0" "Ipsilon" "Ipsilon Manual Pages"
   4 .SH "NAME"
   5 ipsilon.conf \- Ipsilon IdP configuration file
   6 .SH "SYNOPSIS"
   7 /etc/ipsilon/<instancename>/ipsilon.conf
   8 .SH "DESCRIPTION"
   9 \fIipsilon.conf\fR is used to set instance\-specific configuration options for an Ipsilon instance. It should be stored in a subdirectory representing the instance under the the system configuration directory, normally /etc/ipsilon. For example \fI/etc/ipsilon/idp/ispilon.conf\fR.
  10
  11 .SH "SYNTAX"
  12 The configuration options are not case sensitive. The values may be case sensitive, depending on the option.
  13
  14 Blank lines are ignored.
  15 Lines beginning with # are comments and are ignored.
  16
  17 Valid lines consist of an option name, an equals sign and a value. Spaces surrounding equals sign are ignored. An option terminates at the end of a line.
  18
  19 Non\-string values should not be quoted, the quotes will not be stripped.
  20
  21 .np
  22     # Wrong \- don't include quotes with boolean options
  23     verbose = "True"
  24
  25     # Right \- Properly formatted options
  26     verbose = True
  27     verbose=True
  28 .fi
  29
  30 Options must appear in the section named [global]. There are no other sections defined or used currently.
  31
  32 .SH "OPTIONS"
  33 The following options are defined:
  34 .TP
  35 .B debug
  36 Enables additional debugging output. log.screen must also be True for this to be written.
  37 .TP
  38 .B tools.log_request_response.on
  39 Logs the full SAML 2 request and response information.
  40 .TP
  41 .B db.conn.log
  42 Enable verbose database connection tracing logs. debug and log.screen both need to be True for this to be written.
  43 .TP
  44 .B template_dir
  45 Location of the template directory used for buidling the UI. This can be relative to \fIbase.dir\fR.
  46 .TP
  47 .B log.screen
  48 Send logs to the console, which Apache grabs and adds to its own error log.
  49 .TP
  50 .B base.mount
  51 The base mount mount for UI pages. This should match the name of the IdP.
  52 .TP
  53 .B base.dir
  54 The Ipsilon UI base directory, e.g. \fI/usr/share/ipsilon\fR.
  55 .TP
  56 .B admin.config.db
  57 Database URL for storing Ipsilon administrative settings.
  58 .TP
  59 .B user.prefs.db
  60 Database URL for storing persistent user information. This is where users are marked as administrators by setting is_admin to 1.
  61 .TP
  62 .B transactions.db
  63 Database URL for storing login transactions.
  64 .TP
  65 .B tools.sessions.on
  66 Enable sessions in CherryPy. This should always be True.
  67 .TP
  68 .B tools.sessions.name
  69 The session name to be used in session cookies.
  70 .TP
  71 .B tools.sessions.storage_type
  72 Type of storage for the sessions. See CherryPy documentation for more details. Ipsilon defaults to using file. Ipsilon adds a session storage type "Sql" for storing the sesions in an SQL database for load\-balanced servers.
  73 .TP
  74 .B tools.sessions.storage_path
  75 The directory where the CherryPy sessions are stored.
  76 .TP
  77 .B tools.sessions.storage_dburi
  78 The database URL used for session storage if storage_type is set to "Sql".
  79 .TP
  80 .B tools.sessions.path
  81 The URI for where the session is valid, this should conform to the instance name, e.g. /idp.
  82 .TP
  83 .B tools.sessions.timeout
  84 The time in minutes the session is valid for. Default is 60.
  85 .TP
  86 .B tools.sessions.httponly
  87 If False (the default) the cookie \fIhttponly\fR value will not be set. If True, the cookie \fIhttponly\fR value will be set (to 1). Of this is set to True, browsers are instructed to only send cookies with http requests, resulting in them not being available for Javascript\-based requests.
  88 .TP
  89 .B tools.sessions.secure
  90 If False the cookie \fIsecure\fR value will not be set. If True (the default), the cookie \fIsecure\fR value will be set (to 1). If this is set to True, browsers are instructed to only send cookies to secure (TLS\-protected) URLs.
  91 .SH "SEE ALSO"
  92 .BR ipsilon\-server\-install(1)