imip-agent

Annotated docs/wiki/Configuration

1024:48b37822d2a0
2016-01-29 Paul Boddie Moved common test initialisation into a separate script.
paul@955 1
= Configuration =
paul@955 2
paul@961 3
There are three levels of configuration in imip-agent:
paul@955 4
paul@955 5
 * `config.sh` provides system-level and tool configuration
paul@961 6
 * `config.py` provides the configuration of the software itself
paul@961 7
 * User preferences reside as files in separate user-specific directories
paul@955 8
paul@955 9
These files are by default installed into the `/etc/imip-agent` directory
paul@955 10
and they can be changed in that location once the system is installed.
paul@955 11
paul@999 12
{{{#!wiki tip
paul@999 13
=== Text Encoding ===
paul@999 14
The textual encoding employed by the preferences files is UTF-8.
paul@999 15
}}}
paul@999 16
paul@961 17
== System-Level and Tool Configuration ==
paul@955 18
paul@955 19
Given a choice of [[../SystemUsers|system users and groups]], the
paul@955 20
resulting configuration must be indicated in the `config.sh` file. Since
paul@955 21
the `tools/install.sh` script depends on this configuration, changes must
paul@955 22
be made to the file in the `tools/config.sh` location before installation
paul@955 23
can occur.
paul@955 24
paul@961 25
== Software Configuration ==
paul@955 26
paul@955 27
Any changes to filesystem locations may need to be incorporated into the
paul@955 28
`config.py` file, which is found in the `imiptools/config.py` location of
paul@955 29
the distribution. There is, however, no urgency in changing this file
paul@955 30
before installation, and it can be edited in its installed location to
paul@955 31
achieve the same effects.
paul@955 32
paul@955 33
The agent system configuration dictates how the software behaves, and the
paul@955 34
`config.py` file provides system-level settings (filesystem locations
paul@955 35
and file permissions), service-level settings (e-mail address and Web site
paul@955 36
choices), and default policies for users of the software.
paul@961 37
paul@961 38
== User Preferences ==
paul@961 39
paul@961 40
Although the software configuration in `config.py` provides default policies,
paul@961 41
users can choose to override these defaults by editing their own preferences.
paul@961 42
The most convenient way of doing this is to use the profile page provided by
paul@961 43
the [[../CalendarManager|management interface]].
paul@961 44
paul@961 45
The settings for the different policies are described in the
paul@961 46
[[../Preferences|preferences guide]].