Configuration of Sympa may be classified into multiple scopes: “List”, “mail domain”, “site” and distribution default.
- In earlier documentations, a term “robot” was chosen to refer to “mail domain” scope. If you see this word in the other place of this document, please replace it with “mail domain”.
To find a configuration file, Sympa searches following four directories in order, i.e. from narrower to wider scopes:
/— List scope (see the note below)
/mail domain name
/— Mail domain scope
/— Site scope
/— Distribution default
Once desired file is found in a directory, Sympa no longer does search subsequent directories. By this hierarchical system, configuration applied to wider scopes can be customized for particular domains and/or lists.
For example, given following
configuration files placed:
On a list
email@example.com, the first file will be used.
However, on the other lists of
firstname.lastname@example.org), the second file will be used.
On the lists of the other domain (e.g.
email@example.com), the third
file will be used.
The last file, distribution default, will never be used in this example,
because the other file supersedes it.
- On list scope, canonical path of configuration is:
$EXPLDIR/mail domain name
The former style is recommended. The latter style may be deprecated by the future version of Sympa.
Some configuration files are not available in “list” and/or “mail domain” scopes. For example:
auth.confis available only in “mail domain” or “site” scope;
charset.confis available only in “site” scope.
See also documentation on each file.
Changing configuration files
When you customize configuration files, don’t edit files under
$DEFAULTDIR directly. Changes on the files
under this directory will be overwritten by new version during upgrade
Instead, you should copy files under $DEFAULTDIR directory into the directory of appropriate scope (see previous section), then edit these copies.
Main configuration files have different names by each scope:
/config— List configuration
/mail domain name
/robot.conf— Mail domain configuration
/sympa.conf— Site configuration
- Distribution defaults of parameters are defined in the source code of Sympa.
These files will not override the others. Instead, several parameters in
these files override parameters in wider scopes by each. See documentation on