Next: 8. Sympa and its database Up: Sympa Mailing Lists Management Software version Previous: 6. Mail aliases Contents Index
Subsections

- 7.1 Site customization
  - 7.1.1 `domain`
  - 7.1.2 `email`
  - 7.1.3 `listmaster`
  - 7.1.4 `listmaster_email`
  - 7.1.5 `wwsympa_url`
  - 7.1.6 `soap_url`
  - 7.1.7 `spam_protection`
  - 7.1.8 `web_archive_spam_protection`
  - 7.1.9 `color_0`, `color_1` .. `color_15`
  - 7.1.10 `dark_color` `light_color` `text_color` `bg_color` `error_color` `selected_color` `shaded_color`
  - 7.1.11 `logo_html_definition`
  - 7.1.12 `css_path`
  - 7.1.13 `css_url`
  - 7.1.14 `cookie`
  - 7.1.15 `create_list`
  - 7.1.16 `global_remind`
- 7.2 Directories
  - 7.2.1 `home`
  - 7.2.2 `etc`
- 7.3 System related
  - 7.3.1 `syslog`
  - 7.3.2 `log_level`
  - 7.3.3 `log_socket_type`
  - 7.3.4 `pidfile`
  - 7.3.5 `umask`
- 7.4 Sending related
  - 7.4.1 `distribution_mode`
  - 7.4.2 `maxsmtp`
  - 7.4.3 `log_smtp`
  - 7.4.4 `max_size`
  - 7.4.5 `misaddressed_commands`
  - 7.4.6 `misaddressed_commands_regexp`
  - 7.4.7 `nrcpt`
  - 7.4.8 `avg`
  - 7.4.9 `sendmail`
  - 7.4.10 `sendmail_args`
  - 7.4.11 `sendmail_aliases`
  - 7.4.12 `rfc2369_header_fields`
  - 7.4.13 `remove_headers`
  - 7.4.14 `anonymous_headers_fields`
  - 7.4.15 `list_check_smtp`
  - 7.4.16 `list_check_suffixes`
  - 7.4.17 `urlize_min_size`
- 7.5 Quotas
  - 7.5.1 `default_shared_quota`
  - 7.5.2 `default_archive_quota`
- 7.6 Spool related
  - 7.6.1 `spool`
  - 7.6.2 `queue`
  - 7.6.3 `queuedistribute`
  - 7.6.4 `queuemod`
  - 7.6.5 `queuedigest`
  - 7.6.6 `queueauth`
  - 7.6.7 `queueoutgoing`
  - 7.6.8 `queuetopic`
  - 7.6.9 `queuebounce`
  - 7.6.10 `queuetask`
  - 7.6.11 `tmpdir`
  - 7.6.12 `sleep`
  - 7.6.13 `clean_delay_queue`
  - 7.6.14 `clean_delay_queuemod`
  - 7.6.15 `clean_delay_queueauth`
  - 7.6.16 `clean_delay_queuesubscribe`
  - 7.6.17 `clean_delay_queuetopic`
- 7.7 Internationalization related
  - 7.7.1 `localedir`
  - 7.7.2 `supported_lang`
  - 7.7.3 `lang`
  - 7.7.4 `web_recode_to`
- 7.8 Bounce related
  - 7.8.1 `verp_rate`
  - 7.8.2 `welcome_return_path`
  - 7.8.3 `remind_return_path`
  - 7.8.4 `return_path_suffix`
  - 7.8.5 `expire_bounce_task`
  - 7.8.6 `purge_orphan_bounces_task`
  - 7.8.7 `eval_bouncers_task`
  - 7.8.8 `process_bouncers_task`
  - 7.8.9 `minimum_bouncing_count`
  - 7.8.10 `minimum_bouncing_period`
  - 7.8.11 `bounce_delay`
  - 7.8.12 `default_bounce_level1_rate`
  - 7.8.13 `default_bounce_level2_rate`
  - 7.8.14 `bounce_email_prefix`
  - 7.8.15 `bounce_warn_rate`
  - 7.8.16 `bounce_halt_rate`
  - 7.8.17 `default_remind_task`
- 7.9 Tuning
  - 7.9.1 `cache_list_config`
  - 7.9.2 `sympa_priority`
  - 7.9.3 `request_priority`
  - 7.9.4 `owner_priority`
  - 7.9.5 `default_list_priority`
- 7.10 Database related
  - 7.10.1 `update_db_field_types`
  - 7.10.2 `db_type`
  - 7.10.3 `db_name`
  - 7.10.4 `db_host`
  - 7.10.5 `db_port`
  - 7.10.6 `db_user`
  - 7.10.7 `db_passwd`
  - 7.10.8 `db_timeout`
  - 7.10.9 `db_options`
  - 7.10.10 `db_env`
  - 7.10.11 `db_additional_subscriber_fields`
  - 7.10.12 `db_additional_user_fields`
  - 7.10.13 `purge_user_table_task`
- 7.11 Loop prevention
  - 7.11.1 `loop_command_max`
  - 7.11.2 `loop_command_sampling_delay`
  - 7.11.3 `loop_command_decrease_factor`
  - 7.11.4 `loop_prevention_regex`
- 7.12 S/MIME configuration
  - 7.12.1 `openssl`
  - 7.12.2 `capath`
  - 7.12.3 `cafile`
  - 7.12.4 `key_passwd`
  - 7.12.5 `chk_cert_expiration_task`
  - 7.12.6 `crl_update_task`
- 7.13 Antivirus plug-in
  - 7.13.1 `antivirus_path`
  - 7.13.2 `antivirus_args`
  - 7.13.3 `antivirus_notify`

#
7. sympa.conf parameters

The `/usr/local/sympa-stable/etc/sympa.conf` configuration file contains numerous parameters which are read on start-up of Sympa. If you change this file, do not forget that you will need to restart Sympa afterwards.

The `/usr/local/sympa-stable/etc/sympa.conf` file contains directives in the following format:

> keyword value

Comments start with the `#` character at the beginning of a line. Empty lines are also considered as comments and are ignored. There should only be one directive per line, but their order in the file is of no importance.

# 7.1 Site customization

##
7.1.1 `domain`

This keyword is mandatory. It is the domain name used in the `From:` header in replies to administrative requests. So the smtp engine (qmail, sendmail, postfix or whatever) must recognize this domain as a local address. The old keyword `host` is still recognized but should not be used anymore.

Example: `domain cru.fr`

##
7.1.2 `email`

(Default value: `sympa`)

Username (the part of the address preceding the `@` sign) used in the `From:` header in replies to administrative requests.

Example: `email listserv`

##
7.1.3 `listmaster`

The list of e-mail addresses of listmasters (users authorized to perform global server commands). Listmasters can be defined for each virtual host.

Example: `listmaster postmaster@cru.fr,root@cru.fr`

##
7.1.4 `listmaster_email`

(Default value: `listmaster`)

Username (the part of the address preceding the `@` sign) used in the listmaster email. This parameter is useful if you want to run more than one sympa on the same host (a sympa test for example).

If you change the default value, you must modify the sympa aliases too.

For example, if you put :

> listmaster listmaster-test

you must modify the sympa aliases like this :

> listmaster-test: "| /home/sympa/bin/queue listmaster@my.domain.org"

See 6.1,page for all aliases.

##
7.1.5 `wwsympa_url`

(Default value: `http://`<`host`>`/wws`)

This is the root URL of WWSympa.

Example: `wwsympa_url https://my.server/sympa`

##
7.1.6 `soap_url`

This is the root URL of Sympa's SOAP server. Sympa's WSDL document refer to this URL in its `service` section.

Example: `soap_url http://my.server/sympasoap`

##
7.1.7 `spam_protection`

spam_protection (Default value: `javascript`)

There is a need to protection Sympa web site against spambot which collect email adresse in public web site. Various method are availble into Sympa and you can choose it with `spam_protection` and `web_archive_spam_protection` parameters. Possible value are :

- javascript : the adresse is hidden using a javascript. User who enable javascript can see a nice mailto adresses where others have nothing.
- at : the @ char is replaced by the string " AT ".
- none : no protection against spammer.

##
7.1.8 `web_archive_spam_protection`

(Default value: `cookie`)

Idem `spam_protection` but restricted to web archive. A additional value is availible : cookie which mean that users must submit a small form in order to receive a cookie before browsing archives. This block all robot, even google and co.

##
7.1.9 `color_0`, `color_1` .. `color_15`

They are the color definition for web interface. These parameters can be overwritten in each virtual host definition. The color are used in the CSS file and unfortunitly they are also in use in some web templates. The sympa admin interface show every colors in use.

##
7.1.10 `dark_color` `light_color` `text_color` `bg_color` `error_color` `selected_color` `shaded_color`

Deprecated. They are the color definition for previous web interface. These parameters are unused in 5.1 and higher version but still availible.style.css, print.css, print-preview.css and fullPage.css

##
7.1.11 `logo_html_definition`

This parameter allow you to insert in the left top page corner oa piece of html code, usually to insert la logo in the page. This is a very basic but easy customization. Example: `logo_html_definition <a href="http://www.mycompagnie.com"><img style="float: left; margin-top: 7px; margin-left: 37px;" src="http:/logos/mylogo.jpg" alt="my compagnie" /></a>`

##
7.1.12 `css_path`

Pre-parsed CSS files (let's say static css files) can be installed using Sympa server skins module. These CSS files are installed in a part of the web server that can be reached without using sympa web engine. In order to do this edit the robot.conf file and set the css_path parameter. Then retart the server and use skins module from the "admin sympa" page to install preparsed CSS file. The in order to replace dynamic CSS by these static files set the `css_url` parameter.

##
7.1.13 `css_url`

By default, CSS files style.css, print.css, print-preview.css and fullPage.css are delivred by Sympa web interface itself using a sympa action named css. URL look like http://foo.org/sympa/css/style.css . CSS file are made parsing a web_tt2 file named css.tt2. This allow dynamique definition of colors and in a near futur a complete definition of the skin, user preference skins etc.

In order to make sympa web interface faster, it is strongly recommended to install static css file somewhere in your web site. This way sympa will deliver only one page insteed of one page and four css page at each clic. This can be done using css_url parameter. The parameter must contain the URL of the directory where style.css, print.css, print-preview.css and fullPage.css are installed. You can make your own a sophisticated new skin editing these files. The server admin module include a CSS administration page that can help you to install static CSS.

##
7.1.14 `cookie`

This string is used to generate MD5 authentication keys. It allows generated authentication keys to differ from one site to another. It is also used for reversible encryption of user passwords stored in the database. The presence of this string is one reason why access to `sympa.conf` needs to be restricted to the Sympa user.

Note that changing this parameter will break all http cookies stored in users' browsers, as well as all user passwords and lists X509 private keys. To prevent a catastroph, sympa.pl refuse to start if the cookie parameter was changed.

Example: `cookie gh869jku5`

##
7.1.15 `create_list`

(Default value: `public_listmaster`)

`create_list` parameter is defined by an authorization scenario (see 13, page )

Defines who can create lists (or request list creations). Sympa will use the corresponding authorization scenario.

Example: `create_list intranet`

##
7.1.16 `global_remind`

(Default value: `listmaster`)

`global_remind` parameter is defined by an authorization scenario (see 13, page )

Defines who can run a `REMIND *` command.

# 7.2 Directories

##
7.2.1 `home`

(Default value: ``/usr/local/sympa-stable/expl``)

The directory whose subdirectories correspond to the different lists.

Example: `home /home/sympa/expl`

##
7.2.2 `etc`

(Default value: ``/usr/local/sympa-stable/etc``)

This is the local directory for configuration files (such as `edit_list.conf`. It contains 5 subdirectories: `scenari` for local authorization scenarios; `mail_tt2` for the site's local mail templates and default list templates; `web_tt2` for the site's local html templates; `global_task_models` for local global task models; and `list_task_models` for local list task models

Example: `etc /home/sympa/etc`

# 7.3 System related

##
7.3.1 `syslog`

(Default value: `LOCAL1`)

Name of the sub-system (facility) for logging messages.

Example: `syslog LOCAL2`

##
7.3.2 `log_level`

(Default value: `0`)

This parameter sets the verbosity of Sympa processes (including) in log files. With level 0 only main operations are logged, in level 3 almost everything is logged.

Example: `log_level 2`

##
7.3.3 `log_socket_type`

(Default value: `unix`)

Sympa communicates with `syslogd` using either UDP or UNIX sockets. Set `log_socket_type` to `inet` to use UDP, or `unix` for UNIX sockets.

##
7.3.4 `pidfile`

(Default value: ``/usr/local/sympa-stable/etc/sympa.pid``)

The file where the `sympa.pl` daemon stores its process number. Warning: the `sympa` user must be able to write to this file, and to create it if it doesn't exist.

Example: `pidfile /var/run/sympa.pid`

##
7.3.5 `umask`

(Default value: `027`)

Default mask for file creation (see `umask`(2)). Note that it will be interpreted as an octual value.

Example: `umask 007`

# 7.4 Sending related

##
7.4.1 `distribution_mode`

(Default value: `single`) Use this parameter to determine if your installation nrun only one sympa.pl daemon that process both messages to distribute and commands (single) or if sympa.pl will fork to run two separate processus one dedicated to message distribution and one dedicated to commands and message pre-processing (fork). The second choice make a better priority processing for message distribution and faster command response, but it require a bit more computer ressources.

Example: `distribution_mode fork`

##
7.4.2 `maxsmtp`

(Default value: `20`)

Maximum number of SMTP delivery child processes spawned by Sympa. This is the main load control parameter.

Example: `maxsmtp 500`

##
7.4.3 `log_smtp`

(Default value: `off`)

Set logging of each MTA call. Can be overwritten by -m sympa option.

Example: `log_smtp on`

##
7.4.4 `max_size`

(Default value: `5 Mb`)

Maximum size allowed for messages distributed by Sympa. This may be customized per virtual host or per list by setting the `max_size` robot or list parameter.

Example: `max_size 2097152`

##
7.4.5 `misaddressed_commands`

(Default value: `reject`)

When a robot command is sent to a list, by default Sympa reject this message. This feature can be turned off setting this parameter to `ignore`.

##
7.4.6 `misaddressed_commands_regexp`

(Default value: `(subscribe|unsubscribe|signoff)`)

This is the Perl regular expression applied on messages subject and body to detect misaddressed commands, see `misaddressed_commands` parameter above.

##
7.4.7 `nrcpt`

(Default value: `25`)

Maximum number of recipients per `sendmail` call. This grouping factor makes it possible for the (`sendmail`) MTA to optimize the number of SMTP sessions for message distribution. If needed, you can limit the number of receipient for a particular domain. Check nrcpt_by_domain configuration file. (see 2.3, page )

##
7.4.8 `avg`

(Default value: `10`)

Maximum number of different internet domains within addresses per `sendmail` call.

##
7.4.9 `sendmail`

(Default value: `/usr/sbin/sendmail`)

Absolute path to SMTP message transfer agent binary. Sympa expects this binary to be sendmail compatible (postfix, Qmail and Exim binaries all provide sendmail compatibility).

Example: `sendmail /usr/sbin/sendmail`

##
7.4.10 `sendmail_args`

(Default value: `-oi -odi -oem`)

Arguments passed to SMTP message transfer agent

##
7.4.11 `sendmail_aliases`

(Default value: `defined by makefile, sendmail_aliases`)

Path of the alias file that contain all lists related aliases. It is recommended to create a specific alias file so Sympa never overright the standard alias file but only a dedicated file.You must refer to this aliases file in your `sendmail.mc` :

##
7.4.12 `rfc2369_header_fields`

(Default value: `help,subscribe,unsubscribe,post,owner,archive`)

RFC2369 compliant header fields (List-xxx) to be added to distributed messages. These header-fields should be implemented by MUA's, adding menus.

##
7.4.13 `remove_headers`

(Default value: `Return-Receipt-To,Precedence,X-Sequence,Disposition-Notification-To`)

This is the list of headers that Sympa should remove from outgoing messages. Use it, for example, to ensure some privacy for your users by discarding anonymous options. It is (for the moment) site-wide. It is applied before the Sympa, rfc2369_header_fields, and custom_header fields are added.

Example: `remove_headers Resent-Date,Resent-From,Resent-To,Resent-Message-Id,Sender,Delivered-To,Return-Receipt-To,Precedence,X-Sequence,Disposition-Notification-To`

##
7.4.14 `anonymous_headers_fields`

(Default value: `Sender,X-Sender,Received,Message-id,From,X-Envelope-To,Resent-From,Reply-To,Organization,Disposition-Notification-To,X-Envelope-From,X-X-Sender`)

This parameter defines the list of SMTP header fields that should be removed when a mailing list is setup in anonymous mode (see 20.4.3, page ).

##
7.4.15 `list_check_smtp`

(Default value: `NONE`)

If this parameter is set with a SMTP server address, Sympa will check if alias with the same name as the list you're gonna create already exists on the SMTP server. It is robot specific, i.e. you can specify a different SMTP server for every virtual host you are running. This is needed if you are running Sympa on somehost.foo.org, but you handle all your mail on a separate mail relay.

##
7.4.16 `list_check_suffixes`

(Default value: `request,owner,unsubscribe`)

This paramater is a comma-separated list of admin suffixes you're using for Sympa aliases, i.e. mylist-request, mylist-owner etc... This parameter is used with `list_check_smtp` parameter. It is also used to check list names at list creation time.

##
7.4.17 `urlize_min_size`

(Default value: `10240`)

This parameter is related to the `URLIZE` subscriber reception mode ; it defines the minimum size (in bytes) for MIME attachments to be urlized.

#
7.5 Quotas

##
7.5.1 `default_shared_quota`

The default disk quota (the unit is Kbytes) for lists' document repository.

##
7.5.2 `default_archive_quota`

The default disk quota (the unit is Kbytes) for lists' web archives.

#
7.6 Spool related

##
7.6.1 `spool`

(Default value: ``/usr/local/sympa-stable/spool``)

The parent directory which contains all the other spools.

##
7.6.2 `queue`

The absolute path of the directory which contains the queue, used both by the `queue` program and the `sympa.pl` daemon. This parameter is mandatory.

Example: ``/usr/local/sympa-stable/spool/msg``

##
7.6.3 `queuedistribute`

(Default value: ``/usr/local/sympa-stable/spool/distribute``)

This parameter is optional and retained solely for backward compatibility.

##
7.6.4 `queuemod`

(Default value: ``/usr/local/sympa-stable/spool/moderation``)

This parameter is optional and retained solely for backward compatibility.

##
7.6.5 `queuedigest`

This parameter is optional and retained solely for backward compatibility.

##
7.6.6 `queueauth`

(Default value: ``/usr/local/sympa-stable/spool/auth``)

This parameter is optional and retained solely for backward compatibility.

##
7.6.7 `queueoutgoing`

(Default value: ``/usr/local/sympa-stable/spool/outgoing``)

This parameter is optional and retained solely for backward compatibility.

##
7.6.8 `queuetopic`

(Default value: ``/usr/local/sympa-stable/spool/topic``)

This parameter is optional and retained solely for backward compatibility.

##
7.6.9 `queuebounce`

(Default value: ``/usr/local/sympa-stable/spool/bounce``)

Spool to store bounces (non-delivery reports) received by the `bouncequeue` program via the mylist-owner (unless this suffix was customized) or bounce+* addresses (VERP) . This parameter is mandatory and must be an absolute path.

##
7.6.10 `queuetask`

(Default value: ``/usr/local/sympa-stable/spool/task``)

Spool to store task files created by the task manager. This parameter is mandatory and must be an absolute path.

##
7.6.11 `tmpdir`

(Default value: ``/usr/local/sympa-stable/spool/tmp``)

Temporary directory used by OpenSSL and antiviruses.

##
7.6.12 `sleep`

(Default value: `5`)

Waiting period (in seconds) between each scan of the main queue. Never set this value to 0!

##
7.6.13 `clean_delay_queue`

(Default value: `1`)

Retention period (in days) for ``bad'' messages in spool (as specified by `queue`). Sympa keeps messages rejected for various reasons (badly formatted, looping, etc.) in this directory, with a name prefixed by `BAD`. This configuration variable controls the number of days these messages are kept.

Example: `clean_delay_queue 3`

##
7.6.14 `clean_delay_queuemod`

(Default value: `10`)

Expiration delay (in days) in the moderation spool (as specified by `queuemod`). Beyond this deadline, messages that have not been processed are deleted. For moderated lists, the contents of this spool can be consulted using a key along with the `MODINDEX` command.

##
7.6.15 `clean_delay_queueauth`

(Default value: `3`)

Expiration delay (in days) in the authentication queue. Beyond this deadline, messages not enabled are deleted.

##
7.6.16 `clean_delay_queuesubscribe`

(Default value: `10`)

Expiration delay (in days) in the subscription requests queue. Beyond this deadline, requests not validated are deleted.

##
7.6.17 `clean_delay_queuetopic`

(Default value: `7`)

Delay for keeping message topic files (in days) in the topic queue. Beyond this deadline, files are deleted.

# 7.7 Internationalization related

##
7.7.1 `localedir`

(Default value: ``/usr/local/sympa-stable/locale``)

The location of multilingual catalog files. Must correspond to `~src/locale/Makefile`.

##
7.7.2 `supported_lang`

Example: `supported_lang fr,en_US,de,es`

This parameter lists all supported languages (comma separated) for the user interface. The default value will include all message catalogues but it can be narrowed by the listmaster.

##
7.7.3 `lang`

(Default value: `en_US`)

This is the default language for Sympa. The message catalog (.po, compiled as a .mo file) located in the corresponding `locale` directory will be used.

##
7.7.4 `web_recode_to`

If you set this parameter to a charset then web pages will be recoded to this specified charset. This is usefull to have web pages in UTF-8, allowing multi-lingual contents. You should check that customized web templates, topics.conf, list config files, info files are all using the same charset.

Example :

    web_recode_to   utf-8

Note : if you recode web pages to utf-8, you should also add the following tag to your `mhonarc-ressources.tt2` file :

    <TextEncode>
    utf-8; MHonArc::UTF8::to_utf8; MHonArc/UTF8.pm
    </TextEncode>

# 7.8 Bounce related

##
7.8.1 `verp_rate`

(Default value: `0%`)

See 23.1,page for more information on VERP in Sympa.

When `verp_rate` is null VERP is not used ; if `verp_rate` is 100% VERP is alway in use.

VERP requires plussed aliases to be supported and the bounce+* alias to be installed.

##
7.8.2 `welcome_return_path`

(Default value: `owner`)

If set to string `unique`, Sympa enable VERP for welcome message and bounce processing will remove the subscription if a bounce is received for the welcome message. This prevent to add bad address in subscriber list.

##
7.8.3 `remind_return_path`

(Default value: `owner`)

Like `welcome_return_path`, but relates to the remind message.

##
7.8.4 `return_path_suffix`

(Default value: `-owner`)

This defines the suffix that is appended to the list name to build the return-path of messages sent to the lists. This is the address that will receive all non delivery reports (also called bounces).

##
7.8.5 `expire_bounce_task`

(Default value: `daily`)

This parameter tells what task will be used by `task_manager.pl` to perform bounces expiration. This task resets bouncing information for addresses not bouncing in the last 10 days after the latest message distribution.

##
7.8.6 `purge_orphan_bounces_task`

(Default value: `Monthly`)

This parameter tells what task will be used by `task_manager.pl` to perform bounces cleaning. This task delete bounces archives for unsubscribed users.

##
7.8.7 `eval_bouncers_task`

(Default value: `daily`)

The task eval_bouncers evaluate all bouncing users for all lists, and fill the field `bounce_score_suscriber` in table `suscriber_table` with a score. This score allow the auto-management of bouncing-users.

##
7.8.8 `process_bouncers_task`

(Default value: `monthly`)

The task process_bouncers execute configured actions on bouncing users, according to their Score. The association between score and actions has to be done in List configuration, This parameter define the frequency of execution for this task.

##
7.8.9 `minimum_bouncing_count`

(Default value: `10`)

This parameter is for the bounce-score evaluation : the bounce-score is a note that allows the auto-management of bouncing users. This score is evaluated with,in particular, the number of messages bounces received for the user. This parameter sets the minimum number of these messages to allow the bounce-score evaluation for a user.

##
7.8.10 `minimum_bouncing_period`

(Default value: `10`)

Determine the minimum bouncing period for a user to allow his bounce-score evaluation. Like previous parameter, if this value is too low, bounce-score will be 0.

##
7.8.11 `bounce_delay`

(Default value: `0`) Days

Another parameter for the bounce-score evaluation : This one represent the average time (days) for a bounce to come back to sympa-server after a post was send to a list. Usually bounces are arriving same day as the original message.

##
7.8.12 `default_bounce_level1_rate`

(Default value: `45`)

This is the default value for `bouncerslevel1` `rate` entry (, page )

##
7.8.13 `default_bounce_level2_rate`

(Default value: `75`)

This is the default value for `bouncerslevel2` `rate` entry (20.5.3, page )

##
7.8.14 `bounce_email_prefix`

(Default value: `bounce`)

The prefix string used to build variable envelope return path (VERP). In the context of VERP enabled, the local part of the address start with a constant string specified by this parameter. The email is used to collect bounce. Plussed aliases are used in order to introduce the variable part of the email that encode the subscriber address. This parameter is useful if you want to run more than one sympa on the same host (a sympa test for example).

If you change the default value, you must modify the sympa aliases too.

For example, if you set it as :

> bounce_email_prefix bounce-test

you must modify the sympa aliases like this :

> bounce-test+*: "| /home/sympa/bin/queuebounce sympa@my.domain.org"

See 6.1,page for all aliases.

##
7.8.15 `bounce_warn_rate`

(Default value: `30`)

Site default value for `bounce`. The list owner receives a warning whenever a message is distributed and the number of bounces exceeds this value.

##
7.8.16 `bounce_halt_rate`

(Default value: `50`)

`FOR FUTURE USE`

Site default value for `bounce`. Messages will cease to be distributed if the number of bounces exceeds this value.

##
7.8.17 `default_remind_task`

(Default value: `2month`)

This parameter defines the default `remind_task` list parameter.

# 7.9 Tuning

##
7.9.1 `cache_list_config`

`Format: none | binary_file` (Default value: `none`)

If this parameter is set to binary_file, then Sympa processes will maintain a binary version of the list config structure on disk (`config.bin` file). This file is bypassed whenever the `config` file changes on disk. Thanks to this method, the startup of Sympa processes is much faster because it saves the time for parse all config files. The drawback of this method is that the list config cache could live for a long time (not recreated when Sympa process restart) ; Sympa processes could still use authorization scenario rules that have changed on disk in the meanwhile.

You should use list config cache if you are managing a big amount of lists (1000+).

##
7.9.2 `sympa_priority`

(Default value: `1`)

Priority applied to Sympa commands while running the spool.

Available since release 2.3.1.

##
7.9.3 `request_priority`

(Default value: `0`)

Priority for processing of messages for mylist-request, i.e. for owners of the list.

Available since release 2.3.3

##
7.9.4 `owner_priority`

(Default value: `9`)

Priority for processing messages for mylist-owner in the spool. This address will receive non-delivery reports (bounces) and should have a low priority.

Available since release 2.3.3

##
7.9.5 `default_list_priority`

(Default value: `5`)

Default priority for messages if not defined in the list configuration file.

Available since release 2.3.1.

# 7.10 Database related

The following parameters are needed when using an RDBMS, but are otherwise not required:

##
7.10.1 `update_db_field_types`

`Format: update_db_field_types auto | disabled`

(Default value: `auto`)

This parameter defines if Sympa may automatically update database structure to match the expected datafield types. This feature is only available with mysql.

##
7.10.2 `db_type`

`Format: db_type mysql | SQLite | Pg | Oracle | Sybase`

Database management system used (e.g. MySQL, Pg, Oracle)

This corresponds to the PERL DataBase Driver (DBD) name and is therefore case-sensitive.

##
7.10.3 `db_name`

(Default value: `sympa`)

Name of the database containing user information. See detailed notes on database structure, , page . If you are using SQLite, then this parameter is the DB file name.

##
7.10.4 `db_host`

Database host name.

##
7.10.5 `db_port`

Database port.

##
7.10.6 `db_user`

User with read access to the database.

##
7.10.7 `db_passwd`

Password for `db_user`.

##
7.10.8 `db_timeout`

This parameter is used for SQLite only.

##
7.10.9 `db_options`

If these options are defined, they will be appended to the database connect string.

Example for MySQL:

    db_options	mysql_read_default_file=/home/joe/my.cnf

##
7.10.10 `db_env`

Gives a list of environment variables to set before database connexion. This is a ';' separated list of variable assignments.

Example for Oracle:

    db_env	ORACLE_TERM=vt100;ORACLE_HOME=/var/hote/oracle/7.3.4

##
7.10.11 `db_additional_subscriber_fields`

If your subscriber_table database table has more fields than required by Sympa (because other programs access this table), you can make Sympa recognize these fields. You will then be able to use them from within mail/web templates and authorization scenarios (as [subscriber-`>`field]). These fields will also appear in the list members review page and will be editable by the list owner. This parameter is a comma-separated list.

Example :

    db_additional_subscriber_fields 	billing_delay,subscription_expiration

##
7.10.12 `db_additional_user_fields`

If your user_table database table has more fields than required by Sympa (because other programs access this table), you can make Sympa recognize these fields. You will then be able to use them from within mail/web templates (as [user-`>`field]).

This parameter is a comma-separated list.

Example :

    db_additional_user_fields 	address,gender

##
7.10.13 `purge_user_table_task`

This parameter refers to the name of the task (Example: `monthly`) that will be regularly run by the `task_manager.pl` to remove entries in the user_table table that have no corresponding entries in the subscriber_table table.

# 7.11 Loop prevention

The following define your loop prevention policy for commands. (see 16.7, page )

##
7.11.1 `loop_command_max`

(Default value: `200`)

The maximum number of command reports sent to an e-mail address. When it is reached, messages are stored with the BAD prefix, and reports are no longer sent.

##
7.11.2 `loop_command_sampling_delay`

(Default value: `3600`)

This parameter defines the delay in seconds before decrementing the counter of reports sent to an e-mail address.

##
7.11.3 `loop_command_decrease_factor`

(Default value: `0.5`)

The decrementation factor (`from 0 to 1`), used to determine the new report counter after expiration of the delay.

##
7.11.4 `loop_prevention_regex`

(Default value: `mailer-daemon|sympa|listserv|majordomo|smartlist|mailman`)

This regular expression is applied to messages sender address. If the sender address matches the regular expression, then the message is rejected. The goal of this parameter is to prevent loops between Sympa and other robots.

# 7.12 S/MIME configuration

Sympa can optionally verify and use S/MIME signatures for security purposes. In this case, the three first following parameters must be set by the listmaster (see 26.4.2, page ). The two others are optionnal.

##
7.12.1 `openssl`

The path for the openSSL binary file.

##
7.12.2 `capath`

The directory path use by openssl for trusted CA certificates.

A directory of trusted certificates. The certificates should have names of the form: hash.0 or have symbolic links to them of this form ("hash" is the hashed certificate subject name: see the -hash option of the openssl x509 utility). This directory should be the same as the directory SSLCACertificatePath specified for mod_ssl module for Apache.

##
7.12.3 `cafile`

This parameter sets the all-in-one file where you can assemble the Certificates of Certification Authorities (CA) whose clients you deal with. These are used for Client Authentication. Such a file is simply the concatenation of the various PEM-encoded Certificate files, in order of preference. This can be used alternatively and/or additionally to `capath`.

##
7.12.4 `key_passwd`

The password for list private key encryption. If not defined, Sympa assumes that list private keys are not encrypted.

##
7.12.5 `chk_cert_expiration_task`

States the model version used to create the task which regularly checks the certificate expiration dates and warns users whose certificate have expired or are going to. To know more about tasks, see 16.8, page .

##
7.12.6 `crl_update_task`

Specifies the model version used to create the task which regurlaly updates the certificate revocation lists.

#
7.13 Antivirus plug-in

Sympa can optionally check incoming messages before delivering them, using an external antivirus solution. You must then set two parameters.

##
7.13.1 `antivirus_path`

The path to your favorite antivirus binary file (including the binary file).

Example :

    antivirus_path		/usr/local/bin/uvscan

##
7.13.2 `antivirus_args`

The arguments used by the antivirus software to look for viruses. You must set them so as to get the virus name. You should use, if available, the 'unzip' option and check all extensions.

Example with uvscan :

    antivirus_args		--summary --secure

Example with fsav :

    antivirus_args		--dumb	--archive

Exemple with AVP :

    antivirus_path  /opt/AVP/kavscanner
    antivirus_args  -Y -O- -MP -I0

Exemple with Sophos :

    antivirus_path  /usr/local/bin/sweep
    antivirus_args  -nc -nb -ss -archive

Exemple with Clam :

    antivirus_path  /usr/local/bin/clamscan
    antivirus_args  --stdout

##
7.13.3 `antivirus_notify`

`sender` | `nobody`

(Default value: `sender`)

This parameter tells if Sympa should notify the email sender when a virus has been detected.

Next: 8. Sympa and its database Up: Sympa Mailing Lists Management Software version Previous: 6. Mail aliases Contents Index