1.1 --- a/docs/wiki/Configuration Sun Oct 01 22:32:11 2017 +0200
1.2 +++ b/docs/wiki/Configuration Sun Oct 01 23:09:50 2017 +0200
1.3 @@ -90,8 +90,10 @@
1.4 * `config.txt` provides the configuration of the software itself
1.5 * User preferences reside as files in separate user-specific directories
1.6
1.7 -These files are by default installed into the `/etc/imip-agent` directory
1.8 -and they can be changed in that location once the system is installed.
1.9 +The `config` files are by default installed into the `/etc/imip-agent` directory
1.10 +and they can be changed in that location once the system is installed. User
1.11 +preferences can be configured directly in the filesystem or can be edited in the
1.12 +[[../CalendarManager|management interface]] by each user.
1.13
1.14 === System-Level and Tool Configuration ===
1.15
1.16 @@ -138,6 +140,71 @@
1.17 and file permissions), service-level settings (e-mail address and Web site
1.18 choices), and default policies for users of the software.
1.19
1.20 +The syntax of `config.txt` is the same as Python, but only simple value
1.21 +assignments can be defined, along with comments. Strings must appear within
1.22 +quotes and thus numbers, boolean values and strings can be expressed. The
1.23 +following examples employ necessary quoting.
1.24 +
1.25 +{{{#!table
1.26 +'''Setting''' || '''Example Value''' || '''Description'''
1.27 +==
1.28 +`MESSAGE_SENDER` || `"calendar@example.com"`
1.29 +|| The address from which messages sent by the agent originate
1.30 +==
1.31 +`LOCAL_PREFIX` || `"local"`
1.32 +|| The prefix employed by the mail system to identify local recipients
1.33 +==
1.34 +`OUTGOING_PREFIX` || `"people-outgoing"`
1.35 +|| The prefix employed by the mail system to identify local recipients
1.36 +.. being the senders of outgoing messages
1.37 +==
1.38 +`STORE_TYPE` || `"file"`
1.39 +|| The store and journal type
1.40 +==
1.41 +`STORE_DIR` || `"/var/lib/imip-agent/store"`
1.42 +|| The location of the stored calendar information, defined in a form
1.43 +.. appropriate to the selected `STORE_TYPE`
1.44 +==
1.45 +`PUBLISH_DIR` || `"/var/www/imip-agent/static"`
1.46 +|| The location of published static free/busy information, which if
1.47 +.. given as `None` will cause any such publishing to be disabled
1.48 +==
1.49 +`PREFERENCES_DIR` || `"/var/lib/imip-agent/preferences"`
1.50 +|| The location of user preferences information
1.51 +==
1.52 +`JOURNAL_DIR` || `"/var/lib/imip-agent/journal"`
1.53 +|| The location of quota-related journal information
1.54 +==
1.55 +`DEFAULT_PERMISSIONS` || `0660`
1.56 +|| The octal permission flags for files accessed by Web users and the
1.57 +.. agent programs
1.58 +==
1.59 +`DEFAULT_DIR_PERMISSIONS` || `02770`
1.60 +|| The octal permission flags for directories, intended to preserve
1.61 +.. group ownership
1.62 +==
1.63 +`LOCALE_DIR` || `"/usr/share/locale"`
1.64 +|| The location of message translations on the system
1.65 +==
1.66 +`TRANS_DOMAIN` || `"imip-agent"`
1.67 +|| The name of the application used to find message translations
1.68 +==
1.69 +`MANAGER_INTERFACE` || `True`
1.70 +|| Advertise the Web management interface in mails sent to calendar users
1.71 +==
1.72 +`MANAGER_PATH` || `"/imip-manager"`
1.73 +|| The server-relative path at which the management interface is deployed
1.74 +.. in the Web server environment
1.75 +==
1.76 +`MANAGER_URL` || `None`
1.77 +|| The full URL of the manager application excluding the above path,
1.78 +.. used to provide specific hostname details instead of those deduced from
1.79 +.. the environment (when set to None)
1.80 +==
1.81 +`MANAGER_URL_SCHEME` || `"http://"`
1.82 +|| The protocol scheme used if constructing URLs
1.83 +}}}
1.84 +
1.85 === User Preferences ===
1.86
1.87 Although the software configuration in `config.txt` provides default policies,