Sympa Logo
Translations of this page:

sympa.conf parameters part 2

Directories

home

(Default value: /home/sympa/list_data)

The directory whose subdirectories correspond to the different lists.

Example: home /home/sympa/list_data

etc

(Default value: /home/sympa/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;
  • list_task_models for local list task models.

Example:

etc /home/sympa/etc

System related

syslog

(Default value: LOCAL1)

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

Example:

syslog LOCAL2

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

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.

pidfile

Deprecated by 6.1.18.

(Default value: /home/sympa/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 does not exist.

Example:

pidfile /var/run/sympa.pid

pidfile_creation

Deprecated by 6.1.18.

(Default value: /home/sympa/etc/sympa-creation.pid)

The file where the automatic list creation dedicated 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 does not exist.

Example:

pidfile_creation /var/run/sympa-creation.pid

umask

(Default value: 027)

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

Example:

umask 007

Sending related

distribution_mode

(Default value: single)

Use this parameter to determine whether your installation runs only one sympa.pl daemon that processes both messages to distribute and commands (single), or if sympa.pl will fork to run two separate processes, one dedicated to message distribution and one dedicated to commands and message pre-processing (fork). The second choice makes a better priority processing for message distribution and faster command response, but it requires a bit more computer resources.

Example:

distribution_mode fork

maxsmtp

(Default value: 20)

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

Example:

maxsmtp 500

log_smtp

(Default value: off)

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

Example:

log_smtp on

use_blacklist

(Default value: send,create_list”)

Sympa provides a blacklist feature available for list editors and owners. The use_blacklist parameter defines which operations use the blacklist. Search in blacklist is mainly useful for the send service (distribution of a message to the subscribers). You may use blacklist for other operations such as review, archive, etc., but be aware that those web services need fast response and blacklist may require some resources.

If you do not want blacklist at all, define use_blacklist to none so that the user interface to manage blacklist will disappear from the web interface.

Sympa black list uses scenario. See blacklist implicit rule

reporting_spam_script_path

Added in sympa-6.2.

This parameter can be set to some local script. In that case list editor can report undetected spams in web interface for list moderation. Then messages are flushed in this script stdin.

max_size

(Default value: 5 Mb)

Maximum size (in bytes) 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

misaddressed_commands

(Default value: reject)

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

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.

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 recipients for a particular domain. Check the nrcpt_by_domain configuration file (see nrcpt_by_domain).

avg

(Default value: 10)

Maximum number of different Internet domains within addresses per sendmail call.

alias_manager

(Default value: /home/sympa/bin/alias_manager.pl)

The absolute path to the script that will add/remove mail aliases, see Mail aliases.

Example:

alias_manager /home/sympa/bin/ldap_alias_manager.pl

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

sendmail_args

(Default value: -oi -odi -oem)

Arguments passed to the SMTP message transfer agent.

sendmail_aliases

(Default value: defined by makefile, sendmail_aliases | none)

Path of the alias file that contains all list related aliases. It is recommended to create a specific alias file so that Sympa never overwrites the standard alias file, but only a dedicated file. You must refer to this aliases file in your sendmail.mc: set this parameter to none if you want to disable alias management in Sympa (e.g. if you use virtual_transport with Postfix).

aliases_db_type

(Default value: hash)

Type of aliases database. btree, dbm, hash and so on. Available when aliases_program is makemap, postalias or postmap.

This parameter was introduced by release 6.1.18.

aliases_program

(Default value: newaliases)

Program used to update aliases database. makemap, newaliases, postalias, postmap or full path to custom program.

This parameter was introduced by release 6.1.18.

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.

Starting with version 6.2, Sympa also adds Archived-At SMTP header field, as defined in RFC 5064.

remove_headers

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

This is the list of SMTP headers fields that Sympa should remove from incoming messages. Use it, for example, to ensure some privacy for your users by discarding anonymous options. An equivalent parameter can be set in list configuration files. The removal of these header fields is applied before Sympa adds his own header fields (rfc2369_header_fields and custom_header).

Example:

remove_headers Resent-Date,Resent-From,Resent-To,Resent-Message-Id,Sender,Delivered-To"

remove_outgoing_headers

(Default value: none)

You can define a comma-separated list of SMTP header fields that you wish Sympa to remove from outgoing headers. An equivalent parameter can be set in list configuration files. The removal happens after Sympa's own header fields are added ; therefore, it is a convenient way to remove Sympa's own header fields (like X-Loop or X-No-Archive) if you wish.

Example:

remove_outgoing_headers X-no-archive"

reject_mail_from_automates_feature

(Default value: on)

Sympa can be configured to reject messages that seem to be from an automates, based on the From header field value (see loop_prevention_regex) and other SMTP header fields (Content-Identifier, Auto-Submitted). Note that you can disable this feature at a list level too, see reject_mail_from_automates_feature.

Example:

reject_mail_from_automates_feature off

ignore_x_no_archive_header_feature

(Default value: off)

Sympa's default behavior is to skip archiving of incoming messages that have an X-no-archive SMTP header filed set. The ignore_x_no_archive_header_feature parameter allows to change this behavior.

Example:

ignore_x_no_archive_header_feature on

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 anonymous_sender).

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 are creating 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.

list_check_suffixes

(Default value: request,owner,unsubscribe)

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

urlize_min_size

(Default value: 10240)

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

sender_headers

(Default value: From)

Header field name(s) used to determine sender of the messages.

Return-Path means envelope sender (a.k.a. “UNIX From”) which will be alternative to sender of messages without From field. Resent-From may also be inserted before From, because some mailers add it into redirected messages and keep original From field intact.

In particular cases, Return-Path can not give right sender: several mail gateway products rewrite envelope sender and add original one as non-standard field such as X-Envelope-From. If that is the case, you might want to insert it in place of Return-Path.

Example:

Resent-From,From,Return-Path

This parameter was introduced by release 6.1.18.

Bulk mailer

pidfile_bulk

Deprecated by 6.1.18.

Default: <default_pid_dir>/bulk.pid

The location in which the bulk.pl pidfile is created.

sympa_packet_priority

Default: 5

The default priority set to a packet to be sent by the bulk.

bulk_fork_threshold

Default: 1

The minimum number of packets in database before the bulk forks to increase sending rate.

bulk_max_count

Default: 3

The max number of bulks that will run on the same server.

bulk_lazytime

Default: 600

The number of seconds a slave bulk will remain running without processing a message before it spontaneously dies.

bulk_wait_to_fork

Default: 10

The number of seconds a master bulk waits between two packets number checks.

Quotas

default_shared_quota

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

default_archive_quota

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

Spool related

spool

(Default value: /home/sympa/spool)

The parent directory which contains all the other spools.

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:

/home/sympa/spool/msg

queuebounce

(Default value: /home/sympa/spool/bounce)

This parameters value contains the full path to the spool for bounces (non-delivery reports).

Any message addressed to the mylist-owner (unless this suffix was customized) or bounce+* addresses (when using VERP) are transmitted by the incoming MTA to the bouncequeue program.

This program will then put the messages into the directory defined by queuebounce.

This parameter must be an absolute path.

Warning: this parameter must not be mistaken with bounce_path which defines the directory where the last bounce message for each list member is kept for consultation purpose.

queueautomatic

(Default value: none)

The absolute path of the directory which contains the queue for automatic list creation, used by both the familyqueue program and the sympa.pl daemon. This parameter is mandatory when enabling automatic_list_creation.

Example:

/home/sympa/spool/msg

queuedistribute

(Default value: /home/sympa/spool/distribute)

This parameter is optional and retained solely for backward compatibility.

queuemod

(Default value: /home/sympa/spool/moderation)

This parameter is optional and retained solely for backward compatibility.

queuedigest

This parameter is optional and retained solely for backward compatibility.

queueauth

(Default value: /home/sympa/spool/auth)

This parameter is optional and retained solely for backward compatibility.

queueoutgoing

(Default value: /home/sympa/spool/outgoing)

This parameter is optional and retained solely for backward compatibility.

queuetopic

(Default value: /home/sympa/spool/topic)

This parameter is optional and retained solely for backward compatibility.

queuetask

(Default value: /home/sympa/spool/task)

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

tmpdir

(Default value: /home/sympa/spool/tmp)

Temporary directory used by OpenSSL and antiviruses.

sleep

(Default value: 5)

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

clean_delay_queue

(Default value: 7)

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

Example:

clean_delay_queue 3

clean_delay_queueoutgoing

(Default value: 7)

Retention period (in days) for “bad” messages in the outgoing spool (as specified by queueoutgoing). Sympa keeps messages rejected for various reasons (unable to create archive directory, to copy file, etc.) in this directory. This configuration variable controls the number of days these messages are kept.

Example:

clean_delay_queueoutgoing 3

clean_delay_queuebounce

(Default value: 7)

Retention period (in days) for “bad” messages in the bounce spool (as specified by queuebounce). Sympa keeps messages rejected for various reasons (unknown original sender, unknown feedback type) in this directory. This configuration variable controls the number of days these messages are kept.

Example:

clean_delay_queuebounce 3

clean_delay_queuemod

(Default value: 30)

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.

clean_delay_queueauth

(Default value: 30)

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

clean_delay_queuesubscribe

(Default value: 30)

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

clean_delay_queuetopic

(Default value: 30)

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

clean_delay_queueautomatic

(Default value: 10)

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

clean_delay_tmpdir

(Default value: 7)

Retention period (in days) for files put in the tmp dir (as specified by tmpdir). This configuration variable controls the number of days these files are kept.

manual_6.2/conf-parameters/part2.txt · Last modified: 2014/07/08 04:14 (external edit)

The Sympa software is provided by RENATER
Faq | News | Contact | Legal Notices