1SYMPA.CONF(5) sympa 6.2.48 SYMPA.CONF(5)
2
6 sympa.conf, robot.conf - Configuration file for default site and robot
7
9 /etc/sympa/sympa.conf is main configuration file of Sympa. Several
10 parameters defined in this file may be overridden by robot.conf
11 configuration file for each virtual domain, or by config configuration
12 file for each mailing list.
13 Format of sympa.conf and robot.conf is as following:
15 · Lines beginning with "#" and containing only spaces are ignored.
17 · Each line has the form "parameter value". value may contain spaces
19 but may not contain newlines.
20
22 Below is entire list of configuration parameters. "Default" is built-
23 in default value if any. "Overrides" lists contexts (with parameter
24 name) which can override settings in site-wide context (sympa.conf):
25 Virtual domain (robot.conf) and/or List (config).
26 Service description
28 "domain"
29 Primary mail domain name
31 Default:
33 None, mandatory.
34 Overrides:
36 Virtual domain
37 Example:
39 domain mail.example.org
41 "listmaster"
43 Email addresses of listmasters
45 Default:
47 None, mandatory.
48 Overrides:
50 Virtual domain
51 Email addresses of the listmasters (users authorized to perform global
53 server commands). Some error reports may also be sent to these
54 addresses. Listmasters can be defined for each virtual host, however,
55 the default listmasters will have privileges to manage all virtual
56 hosts.
57 Example:
59 listmaster your_email_address@domain.tld
61 "lang"
63 Default language
65 Default:
67 "en-US"
68 Overrides:
70 Virtual domain
71 List
73 This is the default language used by Sympa. One of supported languages
75 should be chosen.
76 "supported_lang"
78 Supported languages
80 Default:
82 "ca,cs,de,el,en-US,es,et,eu,fi,fr,gl,hu,it,ja,ko,nb,nl,oc,pl,pt-BR,ru,sv,tr,vi,zh-CN,zh-TW"
83 Overrides:
85 Virtual domain
86 All supported languages for the user interface. Languages proper locale
88 information not installed are ignored.
89 "title"
91 Title of service
93 Default:
95 "Mailing lists service"
96 Overrides:
98 Virtual domain
99 The name of your mailing list service. It will appear in the header of
101 web interface and subjects of several service messages.
102 "gecos"
104 Display name of Sympa
106 Default:
108 "SYMPA"
109 Overrides:
111 Virtual domain
112 This parameter is used for display name in the "From:" header field for
114 the messages sent by Sympa itself.
115 "legacy_character_support_feature"
117 Support of legacy character set
119 Default:
121 "off"
122 Overrides:
124 None.
125 If set to "on", enables support of legacy character set according to
127 charset.conf(5) configuration file.
128 In some language environments, legacy encoding (character set) can be
130 preferred for e-mail messages: for example iso-2022-jp in Japanese
131 language.
132 Database related
134 "update_db_field_types"
135 Update database structure
137 Default:
139 "auto"
140 Overrides:
142 None.
143 auto: Updates database table structures automatically.
145 However, since version 5.3b.5, Sympa will not shorten field size if it
147 already have been longer than the size defined in database definition.
148 "db_type"
150 Type of the database
152 Default:
154 "mysql"
155 Overrides:
157 None.
158 Possible types are "MySQL", "PostgreSQL", "Oracle" and "SQLite".
160 "db_host"
162 Hostname of the database server
164 Default:
166 None.
167 Overrides:
169 None.
170 With PostgreSQL, you can also use the path to Unix Socket Directory,
172 e.g. "/var/run/postgresql" for connection with Unix domain socket.
173 Example:
175 db_host localhost
177 "db_port"
179 Port of the database server
181 Default:
183 None.
184 Overrides:
186 None.
187 "db_name"
189 Name of the database
191 Default:
193 "sympa"
194 Overrides:
196 None.
197 With SQLite, this must be the full path to database file.
199 With Oracle Database, this must be SID, net service name or easy
201 connection identifier (to use net service name, db_host should be set
202 to "none" and HOST, PORT and SERVICE_NAME should be defined in
203 tnsnames.ora file).
204 "db_user"
206 User for the database connection
208 Default:
210 "user_name"
211 Overrides:
213 None.
214 Example:
216 db_user sympa
218 "db_passwd"
220 Password for the database connection
222 Default:
224 "user_password"
225 Overrides:
227 None.
228 What ever you use a password or not, you must protect the SQL server
230 (is it not a public internet service ?)
231 Example:
233 db_passwd your_passwd
235 "db_options"
237 Database options
239 Default:
241 None.
242 Overrides:
244 None.
245 If these options are defined, they will be appended to data source name
247 (DSN) fed to database driver. Check the related DBD documentation to
248 learn about the available options.
249 Example:
251 db_options mysql_read_default_file=/home/joe/my.cnf;mysql_socket=tmp/mysql.sock-test
253 "db_env"
255 Environment variables setting for database
257 Default:
259 None.
260 Overrides:
262 None.
263 With Oracle Database, this is useful for defining ORACLE_HOME and
265 NLS_LANG.
266 Example:
268 db_env NLS_LANG=American_America.AL32UTF8;ORACLE_HOME=/u01/app/oracle/product/11.2.0/server
270 "db_timeout"
272 Database processing timeout
274 Default:
276 None.
277 Overrides:
279 None.
280 Currently, this parameter may be used for SQLite only.
282 "db_additional_subscriber_fields"
284 Database private extension to subscriber table
286 Default:
288 None.
289 Overrides:
291 None.
292 Adds more fields to "subscriber_table" table. Sympa recognizes fields
294 defined with this parameter. You will then be able to use them from
295 within templates and scenarios:
296 * for scenarios: [subscriber->field]
298 * for templates: [% subscriber.field %]
300 These fields will also appear in the list members review page and will
302 be editable by the list owner. This parameter is a comma-separated
303 list.
304 You need to extend the database format with these fields
306 Example:
308 db_additional_subscriber_fields billing_delay,subscription_expiration
310 "db_additional_user_fields"
312 Database private extension to user table
314 Default:
316 None.
317 Overrides:
319 None.
320 Adds more fields to "user_table" table. Sympa recognizes fields defined
322 with this parameter. You will then be able to use them from within
323 templates: [% subscriber.field %]
324 This parameter is a comma-separated list.
326 You need to extend the database format with these fields
328 Example:
330 db_additional_user_fields age,address
332 System log
334 "syslog"
335 System log facility for Sympa
337 Default:
339 "LOCAL1"
340 Overrides:
342 None.
343 Do not forget to configure syslog server.
345 "log_socket_type"
347 Communication mode with syslog server
349 Default:
351 "unix"
352 Overrides:
354 None.
355 "log_level"
357 Log verbosity
359 Default:
361 0
362 Overrides:
364 Virtual domain
365 Sets the verbosity of logs.
367 0: Only main operations are logged
369 3: Almost everything is logged.
371 Example:
373 log_level 2
375 Alias management
377 "aliases_program"
378 Program used to update alias database
380 Default:
382 "newaliases"
383 Overrides:
385 Virtual domain
386 This may be "makemap", "newaliases", "postalias", "postmap" or full
388 path to custom program.
389 "aliases_db_type"
391 Type of alias database
393 Default:
395 "hash"
396 Overrides:
398 Virtual domain
399 "btree", "dbm", "hash" and so on. Available when aliases_program is
401 "makemap", "postalias" or "postmap"
402 "sendmail_aliases"
404 Path of the file that contains all list related aliases
406 Default:
408 $SENDMAIL_ALIASES
409 Overrides:
411 Virtual domain
412 It is recommended to create a specific alias file so that Sympa never
414 overwrites the standard alias file, but only a dedicated file.
415 Set this parameter to "none" if you want to disable alias management in
417 Sympa.
418 "alias_manager"
420 Path to alias manager
422 Default:
424 "$SBINDIR/alias_manager.pl"
425 Overrides:
427 None.
428 The absolute path to the script that will add/remove mail aliases
430 Example:
432 alias_manager /usr/local/libexec/ldap_alias_manager.pl
434 Receiving
436 "default_max_list_members"
437 Default maximum number of list members
439 Default:
441 0
442 Overrides:
444 Virtual domain
445 List ("max_list_members")
447 Default limit for the number of subscribers per list (0 means no
449 limit).
450 "max_size"
452 Maximum size of messages
454 Default:
456 5242880 (bytes)
457 Overrides:
459 Virtual domain
460 List
462 Incoming messages smaller than this size is allowed distribution by
464 Sympa.
465 Example:
467 max_size 2097152
469 "reject_mail_from_automates_feature"
471 Reject mail sent from automated services to list
473 Default:
475 "on"
476 Overrides:
478 List
479 Rejects messages that seem to be from automated services, based on a
481 few header fields ("Content-Identifier:", "Auto-Submitted:").
482 Sympa also can be configured to reject messages based on the "From:"
484 header field value (see "loop_prevention_regex").
485 Example:
487 reject_mail_from_automates_feature off
489 "sender_headers"
491 Header field name(s) used to determine sender of the messages
493 Default:
495 "From"
496 Overrides:
498 None.
499 "Return-Path" means envelope sender (a.k.a. "UNIX From") which will be
501 alternative to sender of messages without "From" field. "Resent-From"
502 may also be inserted before "From", because some mailers add it into
503 redirected messages and keep original "From" field intact. In
504 particular cases, "Return-Path" can not give right sender: several mail
505 gateway products rewrite envelope sender and add original one as non-
506 standard field such as "X-Envelope-From". If that is the case, you
507 might want to insert it in place of "Return-Path".
508 Example:
510 sender_headers Resent-From,From,Return-Path
512 "misaddressed_commands"
514 Reject misaddressed commands
516 Default:
518 "reject"
519 Overrides:
521 None.
522 When a mail command is sent to a list, by default Sympa rejects this
524 message. This feature can be turned off setting this parameter to
525 "ignore".
526 "misaddressed_commands_regexp"
528 Regular expression matching with misaddressed commands
530 Default:
532 "((subscribe\s+(\S+)|unsubscribe\s+(\S+)|signoff\s+(\S+)|set\s+(\S+)\s+(mail|nomail|digest))\s*)"
533 Overrides:
535 None.
536 Perl regular expression applied on messages subject and body to detect
538 misaddressed commands.
539 "sympa_priority"
541 Priority for command messages
543 Default:
545 1
546 Overrides:
548 Virtual domain
549 Priority applied to messages sent to Sympa command address.
551 "request_priority"
553 Priority for messages bound for list owners
555 Default:
557 0
558 Overrides:
560 Virtual domain
561 Priority for processing of messages bound for "LIST-request" address,
563 i.e. owners of the list
564 "owner_priority"
566 Priority for non-VERP bounces
568 Default:
570 9
571 Overrides:
573 Virtual domain
574 Priority for processing of messages bound for "LIST-owner" address,
576 i.e. non-delivery reports (bounces).
577 "default_list_priority"
579 Default priority for list messages
581 Default:
583 5
584 Overrides:
586 Virtual domain
587 List ("priority")
589 Priority for processing of messages posted to list addresses.
591 "incoming_max_count"
593 Max number of sympa.pl workers
595 Default:
597 1
598 Overrides:
600 None.
601 Max number of workers of sympa.pl daemon processing incoming spool.
603 "sleep"
605 Interval between scanning incoming message spool
607 Default:
609 5 (seconds)
610 Overrides:
612 None.
613 Must not be 0.
615 Sending related
617 "anonymous_header_fields"
618 Header fields removed when a mailing list is setup in anonymous mode
620 Default:
622 "Authentication-Results,Disposition-Notification-To,DKIM-Signature,Injection-Info,Organisation,Organization,Original-Recipient,Originator,Path,Received,Received-SPF,Reply-To,Resent-Reply-To,Return-Receipt-To,X-Envelope-From,X-Envelope-To,X-Sender,X-X-Sender"
623 Overrides:
625 None.
626 See "anonymous_sender" list parameter.
628 Default value prior to Sympa 6.1.19 is:
630 Sender,X-Sender,Received,Message-id,From,X-Envelope-To,Resent-From,Reply-To,Organization,Disposition-Notification-To,X-Envelope-From,X-X-Sender
632 "merge_feature"
634 Allow message personalization by default
636 Default:
638 "off"
639 Overrides:
641 List
642 This parameter defines the default "merge_feature" list parameter.
644 "remove_headers"
646 Header fields to be removed from incoming messages
648 Default:
650 "X-Sympa-To,X-Family-To,Return-Receipt-To,Precedence,X-Sequence,Disposition-Notification-To,Sender"
651 Overrides:
653 List
654 Use it, for example, to ensure some privacy for your users in case that
656 "anonymous_sender" mode is inappropriate.
657 The removal of these header fields is applied before Sympa adds its own
659 header fields ("rfc2369_header_fields" and "custom_header").
660 Example:
662 remove_headers Resent-Date,Resent-From,Resent-To,Resent-Message-Id,Sender,Delivered-To
664 "remove_outgoing_headers"
666 Header fields to be removed before message distribution
668 Default:
670 "none"
671 Overrides:
673 List
674 The removal happens after Sympa's own header fields are added;
676 therefore, it is a convenient way to remove Sympa's own header fields
677 (like "X-Loop:" or "X-no-archive:") if you wish.
678 Example:
680 remove_outgoing_headers X-no-archive
682 "rfc2369_header_fields"
684 RFC 2369 header fields
686 Default:
688 "help,subscribe,unsubscribe,post,owner,archive"
689 Overrides:
691 List
692 Specify which RFC 2369 mailing list header fields to be added.
694 "List-Id:" header field defined in RFC 2919 is always added. Sympa also
696 adds "Archived-At:" header field defined in RFC 5064.
697 "urlize_min_size"
699 Minimum size to be urlized
701 Default:
703 10240 (bytes)
704 Overrides:
706 Virtual domain
707 When a subscriber chose "urlize" reception mode, attachments not
709 smaller than this size will be urlized.
710 "allowed_external_origin"
712 Allowed external links in sanitized HTML
714 Default:
716 None.
717 Overrides:
719 Virtual domain
720 When the HTML content of a message must be sanitized, links ("href" or
722 "src" attributes) with the hosts listed in this parameter will not be
723 scrubbed. If "*" character is included, it matches any subdomains.
724 Single "*" allows any hosts.
725 Example:
727 allowed_external_origin *.example.org,www.example.com
729 "sympa_packet_priority"
731 Default priority for a packet
733 Default:
735 5
736 Overrides:
738 Virtual domain
739 The default priority set to a packet to be sent by the bulk.
741 "bulk_fork_threshold"
743 Fork threshold of bulk daemon
745 Default:
747 1
748 Overrides:
750 None.
751 The minimum number of packets before bulk daemon forks a new worker to
753 increase sending rate.
754 "bulk_max_count"
756 Maximum number of bulk workers
758 Default:
760 3
761 Overrides:
763 None.
764 "bulk_lazytime"
766 Idle timeout of bulk workers
768 Default:
770 600 (seconds)
771 Overrides:
773 None.
774 The number of seconds a bulk worker will remain running without
776 processing a message before it spontaneously exits.
777 "bulk_sleep"
779 Sleep time of bulk workers
781 Default:
783 1 (seconds)
784 Overrides:
786 None.
787 The number of seconds a bulk worker sleeps between starting a new loop
789 if it didn't find a message to send.
790 Keep it small if you want your server to be reactive.
792 "bulk_wait_to_fork"
794 Interval between checks of packet numbers
796 Default:
798 10 (seconds)
799 Overrides:
801 None.
802 Number of seconds a master bulk daemon waits between two packets number
804 checks.
805 Keep it small if you expect brutal increases in the message sending
807 load.
808 "sendmail"
810 Path to sendmail
812 Default:
814 "/usr/sbin/sendmail"
815 Overrides:
817 None.
818 Absolute path to sendmail command line utility (e.g.: a binary named
820 "sendmail" is distributed with Postfix).
821 Sympa expects this binary to be sendmail compatible (exim, Postfix,
823 qmail and so on provide it).
824 "sendmail_args"
826 Command line parameters passed to sendmail
828 Default:
830 "-oi -odi -oem"
831 Overrides:
833 None.
834 Note that "-f", "-N" and "-V" options and recipient addresses should
836 not be included, because they will be included by Sympa.
837 "log_smtp"
839 Log invocation of sendmail
841 Default:
843 "off"
844 Overrides:
846 Virtual domain
847 This can be overwritten by "-m" option for sympa.pl.
849 "maxsmtp"
851 Maximum number of sendmail processes
853 Default:
855 40
856 Overrides:
858 None.
859 Maximum number of simultaneous child processes spawned by Sympa. This
861 is the main load control parameter.
862 Proposed value is quite low, but you can rise it up to 100, 200 or even
864 300 with powerful systems.
865 Example:
867 maxsmtp 500
869 "nrcpt"
871 Maximum number of recipients per call to sendmail
873 Default:
875 25
876 Overrides:
878 None.
879 This grouping factor makes it possible for the sendmail processes to
881 optimize the number of SMTP sessions for message distribution. If
882 needed, you can limit the number of recipients for a particular domain.
883 Check the "nrcpt_by_domain.conf" configuration file.
884 "avg"
886 Maximum number of different mail domains per call to sendmail
888 Default:
890 10
891 Overrides:
893 None.
894 Privileges
896 "create_list"
897 Who is able to create lists
899 Default:
901 "public_listmaster"
902 Overrides:
904 Virtual domain
905 Value of this parameter is name of "create_list" scenario.
907 Defines who can create lists (or request list creation) by creating new
909 lists or by renaming or copying existing lists.
910 Example:
912 create_list intranet
914 "allow_subscribe_if_pending"
916 Allow adding subscribers to a list not open
918 Default:
920 "on"
921 Overrides:
923 Virtual domain
924 If set to "off", adding subscribers to, or removing subscribers from a
926 list with status other than "open" is forbidden.
927 "global_remind"
929 Who is able to send remind messages over all lists
931 Default:
933 "listmaster"
934 Overrides:
936 None.
937 Value of this parameter is name of "global_remind" scenario.
939 "move_user"
941 Who is able to change user's email
943 Default:
945 "auth"
946 Overrides:
948 Virtual domain
949 Value of this parameter is name of "move_user" scenario.
951 "use_blacklist"
953 Use blacklist
955 Default:
957 "send,create_list"
958 Overrides:
960 Virtual domain
961 List of operations separated by comma for which blacklist filter is
963 applied. Setting this parameter to "none" will hide the blacklist
964 feature.
965 "owner_domain"
967 List of required domains for list owner addresses
969 Default:
971 None.
972 Overrides:
974 Virtual domain
975 List
977 Restrict list ownership to addresses in the specified domains. This can
979 be used to reserve list ownership to a group of trusted users from a
980 set of domains associated with an organization, while allowing
981 moderators and subscribers from the Internet at large.
982 Example:
984 owner_domain domain1.tld domain2.tld
986 "owner_domain_min"
988 Minimum number of owners for each list that must match owner_domain
990 restriction
991 Default:
993 0
994 Overrides:
996 Virtual domain
997 List
999 Minimum number of owners for each list must satisfy the owner_domain
1001 restriction. The default of zero (0) means *all* list owners must
1002 match. Setting to 1 requires only one list owner to match owner_domain;
1003 all other owners can be from any domain. This setting can be used to
1004 ensure that there is always at least one known contact point for any
1005 mailing list.
1006 Example:
1008 owner_domain_min 1
1010 Default privileges for the lists
1012 "visibility"
1013 Visibility of the list
1015 Default:
1017 "conceal"
1018 Overrides:
1020 Virtual domain
1021 List
1023 Value of this parameter is name of "visibility" scenario.
1025 "send"
1027 Who can send messages
1029 Default:
1031 "private"
1032 Overrides:
1034 Virtual domain
1035 List
1037 Value of this parameter is name of "send" scenario.
1039 "info"
1041 Who can view list information
1043 Default:
1045 "open"
1046 Overrides:
1048 Virtual domain
1049 List
1051 Value of this parameter is name of "info" scenario.
1053 "subscribe"
1055 Who can subscribe to the list
1057 Default:
1059 "open"
1060 Overrides:
1062 Virtual domain
1063 List
1065 Value of this parameter is name of "subscribe" scenario.
1067 "add"
1069 Who can add subscribers
1071 Default:
1073 "owner"
1074 Overrides:
1076 Virtual domain
1077 List
1079 Value of this parameter is name of "add" scenario.
1081 "unsubscribe"
1083 Who can unsubscribe
1085 Default:
1087 "open"
1088 Overrides:
1090 Virtual domain
1091 List
1093 Value of this parameter is name of "unsubscribe" scenario.
1095 "del"
1097 Who can delete subscribers
1099 Default:
1101 "owner"
1102 Overrides:
1104 Virtual domain
1105 List
1107 Value of this parameter is name of "del" scenario.
1109 "invite"
1111 Who can invite people
1113 Default:
1115 "private"
1116 Overrides:
1118 Virtual domain
1119 List
1121 Value of this parameter is name of "invite" scenario.
1123 "remind"
1125 Who can start a remind process
1127 Default:
1129 "owner"
1130 Overrides:
1132 Virtual domain
1133 List
1135 Value of this parameter is name of "remind" scenario.
1137 "review"
1139 Who can review subscribers
1141 Default:
1143 "owner"
1144 Overrides:
1146 Virtual domain
1147 List
1149 Value of this parameter is name of "review" scenario.
1151 "d_read"
1153 Who can view
1155 Default:
1157 "private"
1158 Overrides:
1160 Virtual domain
1161 List ("shared_doc.d_read")
1163 Value of this parameter is name of "d_read" scenario.
1165 "d_edit"
1167 Who can edit
1169 Default:
1171 "owner"
1172 Overrides:
1174 Virtual domain
1175 List ("shared_doc.d_edit")
1177 Value of this parameter is name of "d_edit" scenario.
1179 "archive_web_access"
1181 access right
1183 Default:
1185 "closed"
1186 Overrides:
1188 Virtual domain
1189 List ("archive.web_access")
1191 Value of this parameter is name of "archive_web_access" scenario.
1193 "archive_mail_access"
1195 access right by mail commands
1197 Default:
1199 "closed"
1200 Overrides:
1202 Virtual domain
1203 List ("archive.mail_access")
1205 Value of this parameter is name of "archive_mail_access" scenario.
1207 "tracking"
1209 who can view message tracking
1211 Default:
1213 "owner"
1214 Overrides:
1216 Virtual domain
1217 List ("tracking.tracking")
1219 Value of this parameter is name of "tracking" scenario.
1221 Archives
1223 "process_archive"
1224 Store distributed messages into archive
1226 Default:
1228 "off"
1229 Overrides:
1231 Virtual domain
1232 List
1234 If enabled, distributed messages via lists will be archived. Otherwise
1236 archiving is disabled.
1237 Note that even if setting this parameter disabled, past archives will
1239 not be removed and will be accessible according to access settings by
1240 each list.
1241 "default_archive_quota"
1243 Default disk quota for lists' archives
1245 Default:
1247 None (Kbytes).
1248 Overrides:
1250 List ("archive.quota")
1251 "ignore_x_no_archive_header_feature"
1253 Ignore "X-no-archive:" header field
1255 Default:
1257 "off"
1258 Overrides:
1260 None.
1261 Sympa's default behavior is to skip archiving of incoming messages that
1263 have an "X-no-archive:" header field set. This parameter allows one to
1264 change this behavior.
1265 Example:
1267 ignore_x_no_archive_header_feature on
1269 "custom_archiver"
1271 Custom archiver
1273 Default:
1275 None.
1276 Overrides:
1278 None.
1279 Activates a custom archiver to use instead of MHonArc. The value of
1281 this parameter is the absolute path to the executable file.
1282 Sympa invokes this file with these two arguments:
1284 --list
1286 The address of the list including domain part.
1288 --file
1290 Absolute path to the message to be archived.
1292 "mhonarc"
1294 Path to MHonArc mail-to-HTML converter
1296 Default:
1298 "/usr/bin/mhonarc"
1299 Overrides:
1301 Virtual domain
1302 This is required for HTML mail archiving.
1304 Bounce management and tracking
1306 "bounce_warn_rate"
1307 Default bounce warn rate
1309 Default:
1311 30
1312 Overrides:
1314 List ("bounce.warn_rate")
1315 The list owner receives a warning whenever a message is distributed and
1317 the number (percentage) of bounces exceeds this value.
1318 "bounce_halt_rate"
1320 Default bounce halt rate
1322 Default:
1324 50
1325 Overrides:
1327 None.
1328 NOT USED YET. If bounce rate reaches the halt_rate, messages for the
1330 list will be halted, i.e. they are retained for subsequent moderation.
1331 "default_bounce_level1_rate"
1333 Default bounce management threshold, 1st level
1335 Default:
1337 45
1338 Overrides:
1340 Virtual domain
1341 List ("bouncers_level1.rate")
1343 "default_bounce_level2_rate"
1345 Default bounce management threshold, 2nd level
1347 Default:
1349 75
1350 Overrides:
1352 Virtual domain
1353 List ("bouncers_level2.rate")
1355 "verp_rate"
1357 Percentage of list members in VERP mode
1359 Default:
1361 "0%"
1362 Overrides:
1364 Virtual domain
1365 List
1367 Uses variable envelope return path (VERP) to detect bouncing subscriber
1369 addresses.
1370 0%: VERP is never used.
1372 100%: VERP is always in use.
1374 VERP requires address with extension to be supported by MTA. If
1376 tracking is enabled for a list or a message, VERP is applied for 100%
1377 of subscribers.
1378 "tracking_delivery_status_notification"
1380 Tracking message by delivery status notification (DSN)
1382 Default:
1384 "off"
1385 Overrides:
1387 List ("tracking.delivery_status_notification")
1388 "tracking_message_disposition_notification"
1390 Tracking message by message disposition notification (MDN)
1392 Default:
1394 "off"
1395 Overrides:
1397 List ("tracking.message_disposition_notification")
1398 "tracking_default_retention_period"
1400 Max age of tracking information
1402 Default:
1404 90 (days)
1405 Overrides:
1407 List ("tracking.retention_period")
1408 Tracking information is removed after this number of days
1410 "welcome_return_path"
1412 Remove bouncing new subscribers
1414 Default:
1416 "owner"
1417 Overrides:
1419 List
1420 If set to unique, the welcome message is sent using a unique return
1422 path in order to remove the subscriber immediately in the case of a
1423 bounce.
1424 "remind_return_path"
1426 Remove subscribers bouncing remind message
1428 Default:
1430 "owner"
1431 Overrides:
1433 List
1434 Same as welcome_return_path, but applied to remind messages.
1436 "default_remind_task"
1438 Periodical subscription reminder task
1440 Default:
1442 None.
1443 Overrides:
1445 List ("remind_task")
1446 This task regularly sends subscribers a message which reminds them of
1448 their list subscriptions.
1449 "expire_bounce_task"
1451 Task for expiration of old bounces
1453 Default:
1455 "daily"
1456 Overrides:
1458 None.
1459 This task resets bouncing information for addresses not bouncing in the
1461 last 10 days after the latest message distribution.
1462 "purge_orphan_bounces_task"
1464 Task for cleaning invalidated bounces
1466 Default:
1468 "monthly"
1469 Overrides:
1471 None.
1472 This task deletes bounce information for unsubscribed users.
1474 "eval_bouncers_task"
1476 Task for updating bounce scores
1478 Default:
1480 "daily"
1481 Overrides:
1483 None.
1484 This task scans all bouncing users for all lists, and updates
1486 "bounce_score_subscriber" field in "subscriber_table" table. The scores
1487 may be used for management of bouncers.
1488 "process_bouncers_task"
1490 Task for management of bouncers
1492 Default:
1494 "weekly"
1495 Overrides:
1497 None.
1498 This task executes actions on bouncing users configured by each list,
1500 according to their scores.
1501 "purge_tables_task"
1503 Task for cleaning tables
1505 Default:
1507 "daily"
1508 Overrides:
1510 None.
1511 This task cleans old tracking information from "notification_table"
1513 table.
1514 "minimum_bouncing_count"
1516 Minimum number of bounces
1518 Default:
1520 10
1521 Overrides:
1523 None.
1524 The minimum number of bounces received to update bounce score of a
1526 user.
1527 "minimum_bouncing_period"
1529 Minimum bouncing period
1531 Default:
1533 10 (days)
1534 Overrides:
1536 None.
1537 The minimum period for which bouncing lasted to update bounce score of
1539 a user.
1540 "bounce_delay"
1542 Delay of bounces
1544 Default:
1546 0 (days)
1547 Overrides:
1549 None.
1550 Average time for a bounce sent back to mailing list server after a post
1552 was sent to a list. Usually bounces are sent back on the same day as
1553 the original message.
1554 "bounce_email_prefix"
1556 Default:
1558 "bounce"
1559 Overrides:
1561 None.
1562 The prefix to consist the return-path of probe messages used for bounce
1564 management, when variable envelope return path (VERP) is enabled. VERP
1565 requires address with extension to be supported by MTA.
1566 If you change the default value, you must modify the mail aliases too.
1568 "return_path_suffix"
1570 Suffix of list return address
1572 Default:
1574 "-owner"
1575 Overrides:
1577 None.
1578 The suffix appended to the list name to form the return-path of
1580 messages distributed through the list. This address will receive all
1581 non-delivery reports (also called bounces).
1582 Loop prevention
1584 "loop_command_max"
1585 Maximum number of responses to command message
1587 Default:
1589 200
1590 Overrides:
1592 None.
1593 The maximum number of command reports sent to an email address.
1595 Messages are stored in "bad" subdirectory of incoming message spool,
1596 and reports are not longer sent.
1597 "loop_command_sampling_delay"
1599 Delay before counting responses to command message
1601 Default:
1603 3600 (seconds)
1604 Overrides:
1606 None.
1607 This parameter defines the delay in seconds before decrementing the
1609 counter of reports sent to an email address.
1610 "loop_command_decrease_factor"
1612 Decrementing factor of responses to command message
1614 Default:
1616 0.5
1617 Overrides:
1619 None.
1620 The decrementation factor (from 0 to 1), used to determine the new
1622 report counter after expiration of the delay.
1623 "loop_prevention_regex"
1625 Regular expression to prevent loop
1627 Default:
1629 "mailer-daemon|sympa|listserv|majordomo|smartlist|mailman"
1630 Overrides:
1632 Virtual domain
1633 List
1635 If the sender address matches the regular expression, then the message
1637 is rejected.
1638 "msgid_table_cleanup_ttl"
1640 Expiration period of message ID table
1642 Default:
1644 86400 (seconds)
1645 Overrides:
1647 None.
1648 Expiration period of entries in the table maintained by sympa_msg.pl
1650 daemon to prevent delivery of duplicate messages caused by loop.
1651 "msgid_table_cleanup_frequency"
1653 Cleanup interval of message ID table
1655 Default:
1657 3600 (seconds)
1658 Overrides:
1660 None.
1661 Interval between cleanups of the table maintained by sympa_msg.pl
1663 daemon to prevent delivery of duplicate messages caused by loop.
1664 Automatic lists
1666 "automatic_list_removal"
1667 Remove empty automatic list
1669 Default:
1671 "none"
1672 Overrides:
1674 Virtual domain
1675 If set to "if_empty", then Sympa will remove automatically created
1677 mailing lists just after their creation, if they contain no list
1678 member.
1679 Example:
1681 automatic_list_removal if_empty
1683 "automatic_list_feature"
1685 Automatic list
1687 Default:
1689 "off"
1690 Overrides:
1692 Virtual domain
1693 "automatic_list_creation"
1695 Who is able to create automatic list
1697 Default:
1699 "public"
1700 Overrides:
1702 Virtual domain
1703 Value of this parameter is name of "automatic_list_creation" scenario.
1705 "automatic_list_families"
1707 Definition of automatic list families
1709 Default:
1711 None.
1712 Overrides:
1714 Virtual domain
1715 Defines the families the automatic lists are based on. It is a
1717 character string structured as follows:
1718 * each family is separated from the other by a semicolon (;)
1720 * inside a family definition, each field is separated from the other by
1722 a colon (:)
1723 * each field has the structure: "<field name>=<field value>"
1725 Basically, each time Sympa uses the automatic lists families, the
1727 values defined in this parameter will be available in the family
1728 object.
1729 * for scenarios: [family->name]
1731 * for templates: [% family.name %]
1733 Example:
1735 automatic_list_families name=family_one:prefix=f1:display=My automatic lists:prefix_separator=+:classes separator=-:family_owners_list=alist@domain.tld;name=family_two:prefix=f2:display=My other automatic lists:prefix_separator=+:classes separator=-:family_owners_list=anotherlist@domain.tld;
1737 "parsed_family_files"
1739 Parsed files for families
1741 Default:
1743 "message_header,message_header.mime,message_footer,message_footer.mime,info"
1744 Overrides:
1746 Virtual domain
1747 comma-separated list of files that will be parsed by Sympa when
1749 instantiating a family (no space allowed in file names)
1750 Tag based spam filtering
1752 "antispam_feature"
1753 Tag based spam filtering
1755 Default:
1757 "off"
1758 Overrides:
1760 Virtual domain
1761 "antispam_tag_header_name"
1763 Header field to tag spams
1765 Default:
1767 "X-Spam-Status"
1768 Overrides:
1770 Virtual domain
1771 If a spam filter (like spamassassin or j-chkmail) add a header field to
1773 tag spams, name of this header field (example X-Spam-Status)
1774 "antispam_tag_header_spam_regexp"
1776 Regular expression to check header field to tag spams
1778 Default:
1780 "^\s*Yes"
1781 Overrides:
1783 Virtual domain
1784 Regular expression applied on this header to verify message is a spam
1786 (example Yes)
1787 "antispam_tag_header_ham_regexp"
1789 Regular expression to determine spam or ham.
1791 Default:
1793 "^\s*No"
1794 Overrides:
1796 Virtual domain
1797 Regular expression applied on this header field to verify message is
1799 NOT a spam (example No)
1800 "spam_status"
1802 Name of header field to inform
1804 Default:
1806 "x-spam-status"
1807 Overrides:
1809 Virtual domain
1810 Value of this parameter is name of "spam_status" scenario.
1812 Messages are supposed to be filtered by an spam filter that adds them
1814 one or more headers. This parameter is used to select a special
1815 scenario in order to decide the message's spam status: ham, spam or
1816 unsure. This parameter replaces antispam_tag_header_name,
1817 antispam_tag_header_spam_regexp and antispam_tag_header_ham_regexp.
1818 Directories
1820 "home"
1821 List home
1823 Default:
1825 $EXPLDIR
1826 Overrides:
1828 None.
1829 Base directory of list configurations.
1831 "etc"
1833 Directory for configuration files
1835 Default:
1837 $SYSCONFDIR
1838 Overrides:
1840 None.
1841 Base directory of global configuration (except "sympa.conf").
1843 "spool"
1845 Base directory of spools
1847 Default:
1849 $SPOOLDIR
1850 Overrides:
1852 None.
1853 Base directory of all spools which are created at runtime. This
1855 directory must be writable by Sympa user.
1856 "queue"
1858 Directory for message incoming spool
1860 Default:
1862 "$SPOOLDIR/msg"
1863 Overrides:
1865 None.
1866 This spool is used both by "queue" program and "sympa_msg.pl" daemon.
1868 "queuemod"
1870 Directory for moderation spool
1872 Default:
1874 "$SPOOLDIR/moderation"
1875 Overrides:
1877 None.
1878 "queuedigest"
1880 Directory for digest spool
1882 Default:
1884 "$SPOOLDIR/digest"
1885 Overrides:
1887 None.
1888 "queueauth"
1890 Directory for held message spool
1892 Default:
1894 "$SPOOLDIR/auth"
1895 Overrides:
1897 None.
1898 This parameter is named such by historical reason.
1900 "queueoutgoing"
1902 Directory for archive spool
1904 Default:
1906 "$SPOOLDIR/outgoing"
1907 Overrides:
1909 None.
1910 This parameter is named such by historical reason.
1912 "queuesubscribe"
1914 Directory for held request spool
1916 Default:
1918 "$SPOOLDIR/subscribe"
1919 Overrides:
1921 None.
1922 This parameter is named such by historical reason.
1924 "queuetopic"
1926 Directory for topic spool
1928 Default:
1930 "$SPOOLDIR/topic"
1931 Overrides:
1933 None.
1934 "queuebounce"
1936 Directory for bounce incoming spool
1938 Default:
1940 "$SPOOLDIR/bounce"
1941 Overrides:
1943 None.
1944 This spool is used both by "bouncequeue" program and "bounced.pl"
1946 daemon.
1947 "queuetask"
1949 Directory for task spool
1951 Default:
1953 "$SPOOLDIR/task"
1954 Overrides:
1956 None.
1957 "queueautomatic"
1959 Directory for automatic list creation spool
1961 Default:
1963 "$SPOOLDIR/automatic"
1964 Overrides:
1966 None.
1967 This spool is used both by "familyqueue" program and
1969 "sympa_automatic.pl" daemon.
1970 "queuebulk"
1972 Directory for message outgoing spool
1974 Default:
1976 "$SPOOLDIR/bulk"
1977 Overrides:
1979 None.
1980 This parameter is named such by historical reason.
1982 "tmpdir"
1984 Temporary directory used by external programs such as virus scanner.
1986 Also, outputs to daemons' standard error are redirected to the files
1987 under this directory.
1988 Default:
1990 "$SPOOLDIR/tmp"
1991 Overrides:
1993 None.
1994 "viewmail_dir"
1996 Directory to cache formatted messages
1998 Default:
2000 "$SPOOLDIR/viewmail"
2001 Overrides:
2003 None.
2004 Base directory path of directories where HTML view of messages are
2006 cached.
2007 "bounce_path"
2009 Directory for storing bounces
2011 Default:
2013 $BOUNCEDIR
2014 Overrides:
2016 None.
2017 The directory where bounced.pl daemon will store the last bouncing
2019 message for each user. A message is stored in the file:
2020 <bounce_path>/<list name>@<mail domain name>/<email address>, or, if
2021 tracking is enabled: <bounce_path>/<list name>@<mail domain
2022 name>/<email address>_<envelope ID>.
2023 Users can access to these messages using web interface in the bounce
2025 management page.
2026 Don't confuse with "queuebounce" parameter which defines the spool
2028 where incoming error reports are stored and picked by bounced.pl
2029 daemon.
2030 "arc_path"
2032 Directory for storing archives
2034 Default:
2036 $ARCDIR
2037 Overrides:
2039 Virtual domain
2040 Where to store HTML archives. This parameter is used by the
2042 "archived.pl" daemon. It is a good idea to install the archive outside
2043 the web document hierarchy to prevent overcoming of WWSympa's access
2044 control.
2045 "purge_spools_task"
2047 Task for cleaning spools
2049 Default:
2051 "daily"
2052 Overrides:
2054 None.
2055 This task cleans old content in spools.
2057 "clean_delay_queue"
2059 Max age of incoming bad messages
2061 Default:
2063 7 (days)
2064 Overrides:
2066 None.
2067 Number of days "bad" messages are kept in message incoming spool (as
2069 specified by "queue" parameter). Sympa keeps messages rejected for
2070 various reasons (badly formatted, looping etc.).
2071 "clean_delay_queueoutgoing"
2073 Max age of bad messages for archives
2075 Default:
2077 7 (days)
2078 Overrides:
2080 None.
2081 Number of days "bad" messages are kept in message archive spool (as
2083 specified by "queueoutgoing" parameter). Sympa keeps messages rejected
2084 for various reasons (unable to create archive directory, to copy file
2085 etc.).
2086 "clean_delay_queuebounce"
2088 Max age of bad bounce messages
2090 Default:
2092 7 (days)
2093 Overrides:
2095 None.
2096 Number of days "bad" messages are kept in bounce spool (as specified by
2098 "queuebounce" parameter). Sympa keeps messages rejected for various
2099 reasons (unknown original sender, unknown report type).
2100 "clean_delay_queuemod"
2102 Max age of moderated messages
2104 Default:
2106 30 (days)
2107 Overrides:
2109 List
2110 Number of days messages are kept in moderation spool (as specified by
2112 "queuemod" parameter). Beyond this deadline, messages that have not
2113 been processed are deleted.
2114 "clean_delay_queueauth"
2116 Max age of held messages
2118 Default:
2120 30 (days)
2121 Overrides:
2123 None.
2124 Number of days messages are kept in held message spool (as specified by
2126 "queueauth" parameter). Beyond this deadline, messages that have not
2127 been confirmed are deleted.
2128 "clean_delay_queuesubscribe"
2130 Max age of held requests
2132 Default:
2134 30 (days)
2135 Overrides:
2137 None.
2138 Number of days requests are kept in held request spool (as specified by
2140 "queuesubscribe" parameter). Beyond this deadline, requests that have
2141 not been validated nor declined are deleted.
2142 "clean_delay_queuetopic"
2144 Max age of tagged topics
2146 Default:
2148 30 (days)
2149 Overrides:
2151 None.
2152 Number of days (automatically or manually) tagged topics are kept in
2154 topic spool (as specified by "queuetopic" parameter). Beyond this
2155 deadline, tagging is forgotten.
2156 "clean_delay_queueautomatic"
2158 Max age of incoming bad messages in automatic list creation spool
2160 Default:
2162 10 (days)
2163 Overrides:
2165 None.
2166 Number of days "bad" messages are kept in automatic list creation spool
2168 (as specified by "queueautomatic" parameter). Sympa keeps messages
2169 rejected for various reasons (badly formatted, looping etc.).
2170 "clean_delay_queuebulk"
2172 Max age of outgoing bad messages
2174 Default:
2176 7 (days)
2177 Overrides:
2179 None.
2180 Number of days "bad" messages are kept in message outgoing spool (as
2182 specified by "queuebulk" parameter). Sympa keeps messages rejected for
2183 various reasons (failed personalization, bad configuration on MTA
2184 etc.).
2185 "clean_delay_queuedigest"
2187 Max age of bad messages in digest spool
2189 Default:
2191 14 (days)
2192 Overrides:
2194 None.
2195 Number of days "bad" messages are kept in digest spool (as specified by
2197 "queuedigest" parameter). Sympa keeps messages rejected for various
2198 reasons (syntax errors in "digest.tt2" template etc.).
2199 "clean_delay_tmpdir"
2201 Max age of temporary files
2203 Default:
2205 7 (days)
2206 Overrides:
2208 None.
2209 Number of days files in temporary directory (as specified by "tmpdir"
2211 parameter), including standard error logs, are kept.
2212 Miscellaneous
2214 "email"
2215 Local part of Sympa email address
2217 Default:
2219 "sympa"
2220 Overrides:
2222 Virtual domain
2223 Local part (the part preceding the "@" sign) of the address by which
2225 mail interface of Sympa accepts mail commands.
2226 If you change the default value, you must modify the mail aliases too.
2228 "listmaster_email"
2230 Local part of listmaster email address
2232 Default:
2234 "listmaster"
2235 Overrides:
2237 Virtual domain
2238 Local part (the part preceding the "@" sign) of the address by which
2240 listmasters receive messages.
2241 If you change the default value, you must modify the mail aliases too.
2243 "custom_robot_parameter"
2245 Custom robot parameter
2247 Default:
2249 None.
2250 Overrides:
2252 Virtual domain
2253 Used to define a custom parameter for your server. Do not forget the
2255 semicolon between the parameter name and the parameter value.
2256 You will be able to access the custom parameter value in web templates
2258 by variable "conf.custom_robot_parameter.<param_name>"
2259 Example:
2261 custom_robot_parameter param_name ; param_value
2263 "cache_list_config"
2265 Use of binary cache of list configuration
2267 Default:
2269 "none"
2270 Overrides:
2272 None.
2273 binary_file: Sympa processes will maintain a binary version of the list
2275 configuration, "config.bin" file on local disk. If you manage a big
2276 amount of lists (1000+), it should make the web interface startup
2277 faster.
2278 You can recreate cache by running "sympa.pl --reload_list_config".
2280 "db_list_cache"
2282 Use database cache to search lists
2284 Default:
2286 "off"
2287 Overrides:
2289 None.
2290 Note that "list_table" database table should be filled at the first
2292 time by running:
2293 # sympa.pl --sync_list_db
2295 "purge_user_table_task"
2297 Task for expiring inactive users
2299 Default:
2301 "monthly"
2302 Overrides:
2304 None.
2305 This task removes rows in the "user_table" table which have not
2307 corresponding entries in the "subscriber_table" table.
2308 "purge_logs_table_task"
2310 Task for cleaning tables
2312 Default:
2314 "daily"
2315 Overrides:
2317 None.
2318 This task cleans old logs from "logs_table" table.
2320 "logs_expiration_period"
2322 Max age of logs in database
2324 Default:
2326 3 (months)
2327 Overrides:
2329 None.
2330 Number of months that elapse before a log is expired
2332 "stats_expiration_period"
2334 Max age of statistics information in database
2336 Default:
2338 3 (months)
2339 Overrides:
2341 None.
2342 Number of months that elapse before statistics information are expired
2344 "umask"
2346 Umask
2348 Default:
2350 027
2351 Overrides:
2353 None.
2354 Default mask for file creation (see umask(2)). Note that it will be
2356 interpreted as an octal value.
2357 "cookie"
2359 Secret string for generating unique keys
2361 Default:
2363 None.
2364 Overrides:
2366 List
2367 This allows generated authentication keys to differ from a site to
2369 another. It is also used for encryption of user passwords stored in the
2370 database. The presence of this string is one reason why access to
2371 "sympa.conf" needs to be restricted to the "sympa" user.
2372 Note that changing this parameter will break all HTTP cookies stored in
2374 users' browsers, as well as all user passwords and lists X509 private
2375 keys. To prevent a catastrophe, Sympa refuses to start if this "cookie"
2376 parameter was changed.
2377 Example:
2379 cookie 123456789
2381 Web interface parameters
2383 "wwsympa_url"
2384 URL prefix of web interface
2386 Default:
2388 None.
2389 Overrides:
2391 Virtual domain
2392 This is used to construct URLs of web interface.
2394 Example:
2396 wwsympa_url https://web.example.org/sympa
2398 "http_host"
2400 URL prefix of WWSympa behind proxy
2402 Default:
2404 None.
2405 Overrides:
2407 Virtual domain
2408 "static_content_url"
2410 URL for static contents
2412 Default:
2414 "/static-sympa"
2415 Overrides:
2417 Virtual domain
2418 HTTP server have to map it with "static_content_path" directory.
2420 "static_content_path"
2422 Directory for static contents
2424 Default:
2426 $STATICDIR
2427 Overrides:
2429 Virtual domain
2430 "log_facility"
2432 System log facility for web interface
2434 Default:
2436 "LOCAL1"
2437 Overrides:
2439 None.
2440 System log facility for WWSympa, archived.pl and bounced.pl. Default is
2442 to use value of "syslog" parameter.
2443 Web interface parameters: Appearances
2445 "logo_html_definition"
2446 Custom logo
2448 Default:
2450 None.
2451 Overrides:
2453 Virtual domain
2454 HTML fragment to insert a logo in the page of web interface.
2456 Example:
2458 logo_html_definition <a href="http://www.example.com"><img style="float: left; margin-top: 7px; margin-left: 37px;" src="http://www.example.com/logos/mylogo.jpg" alt="My Company" /></a>
2460 "favicon_url"
2462 Custom favicon
2464 Default:
2466 None.
2467 Overrides:
2469 Virtual domain
2470 URL of favicon image
2472 "css_path"
2474 Directory for static style sheets (CSS)
2476 Default:
2478 $CSSDIR
2479 Overrides:
2481 None.
2482 After an upgrade, static CSS files are upgraded with the newly
2484 installed "css.tt2" template. Therefore, this is not a good place to
2485 store customized CSS files.
2486 "css_url"
2488 URL for style sheets (CSS)
2490 Default:
2492 "/static-sympa/css"
2493 Overrides:
2495 None.
2496 To use auto-generated static CSS, HTTP server have to map it with
2498 "css_path".
2499 "pictures_path"
2501 Directory for subscribers pictures
2503 Default:
2505 $PICTURESDIR
2506 Overrides:
2508 None.
2509 "pictures_url"
2511 URL for subscribers pictures
2513 Default:
2515 "/static-sympa/pictures"
2516 Overrides:
2518 None.
2519 HTTP server have to map it with "pictures_path" directory.
2521 "color_0", ..., "color_15"
2523 Colors for web interface
2525 Default:
2527 See description on web interface.
2528 Overrides:
2530 Virtual domain
2531 Colors are used in style sheet (CSS). They may be changed using web
2533 interface by listmasters.
2534 "dark_color", "light_color", "text_color", "bg_color", "error_color",
2536 "selected_color", "shaded_color"
2537 Colors for web interface, obsoleted
2539 Default:
2541 See description on web interface.
2542 Overrides:
2544 Virtual domain
2545 "default_home"
2547 Type of main web page
2549 Default:
2551 "home"
2552 Overrides:
2554 Virtual domain
2555 "lists" for the page of list of lists. "home" for home page.
2557 "archive_default_index"
2559 Default index organization of web archive
2561 Default:
2563 "thrd"
2564 Overrides:
2566 None.
2567 thrd: Threaded index.
2569 mail: Chronological index.
2571 "review_page_size"
2573 Size of review page
2575 Default:
2577 25
2578 Overrides:
2580 Virtual domain
2581 Default number of lines of the array displaying users in the review
2583 page
2584 "viewlogs_page_size"
2586 Size of viewlogs page
2588 Default:
2590 25
2591 Overrides:
2593 Virtual domain
2594 Default number of lines of the array displaying the log entries in the
2596 logs page.
2597 "main_menu_custom_button_1_title", ...
2599 "main_menu_custom_button_3_title", "main_menu_custom_button_1_url", ...
2600 "main_menu_custom_button_3_url", "main_menu_custom_button_1_target",
2601 ... "main_menu_custom_button_3_target"
2602 Custom menus
2604 Default:
2606 None.
2607 Overrides:
2609 Virtual domain
2610 You may modify the main menu content by editing the menu.tt2 file, but
2612 you can also edit these parameters in order to add up to 3 buttons.
2613 Each button is defined by a title (the text in the button), an URL and,
2614 optionally, a target.
2615 Example:
2617 main_menu_custom_button_1_title FAQ
2619 main_menu_custom_button_1_url http://www.renater.fr/faq/universalistes/index
2620 main_menu_custom_button_1_target Help
2621 Web interface parameters: Miscellaneous
2623 "cookie_domain"
2624 HTTP cookies validity domain
2626 Default:
2628 "localhost"
2629 Overrides:
2631 Virtual domain
2632 If beginning with a dot ("."), the cookie is available within the
2634 specified Internet domain. Otherwise, for the specified host. The only
2635 reason for replacing the default value would be where WWSympa's
2636 authentication process is shared with an application running on another
2637 host.
2638 Example:
2640 cookie_domain .renater.fr
2642 "cookie_expire"
2644 HTTP cookies lifetime
2646 Default:
2648 0
2649 Overrides:
2651 None.
2652 This is the default value when not set explicitly by users. "0" means
2654 the cookie may be retained during browser sessions.
2655 "cookie_refresh"
2657 Average interval to refresh HTTP session ID.
2659 Default:
2661 60
2662 Overrides:
2664 None.
2665 "purge_session_table_task"
2667 Task for cleaning old sessions
2669 Default:
2671 "daily"
2672 Overrides:
2674 None.
2675 This task removes old entries in the "session_table" table.
2677 "session_table_ttl"
2679 Max age of sessions
2681 Default:
2683 "2d"
2684 Overrides:
2686 None.
2687 Session duration is controlled by "sympa_session" cookie validity
2689 attribute. However, by security reason, this delay also need to be
2690 controlled by server side. This task removes old entries in the
2691 "session_table" table.
2692 Format of values is a string without spaces including "y" for years,
2694 "m" for months, "d" for days, "h" for hours, "min" for minutes and
2695 "sec" for seconds.
2696 "anonymous_session_table_ttl"
2698 Default:
2700 "1h"
2701 Overrides:
2703 None.
2704 "shared_feature"
2706 Enable shared repository
2708 Default:
2710 "off"
2711 Overrides:
2713 Virtual domain
2714 If set to "on", list owners can open shared repository.
2716 "default_shared_quota"
2718 Default disk quota for shared repository
2720 Default:
2722 None (Kbytes).
2723 Overrides:
2725 Virtual domain
2726 List ("shared_doc.quota")
2728 "use_html_editor"
2730 Use HTML editor
2732 Default:
2734 0
2735 Overrides:
2737 Virtual domain
2738 If set to "on", users will be able to post messages in HTML using a
2740 javascript WYSIWYG editor.
2741 Example:
2743 use_html_editor on
2745 "html_editor_url"
2747 URL of HTML editor
2749 Default:
2751 None.
2752 Overrides:
2754 Virtual domain
2755 URL path to the javascript file making the WYSIWYG HTML editor
2757 available. Relative path under <static_content_url> or absolute path.
2758 Example is for TinyMCE 4 installed under
2760 <static_content_path>/js/tinymce/.
2761 Example:
2763 html_editor_url js/tinymce/tinymce.min.js
2765 "html_editor_init"
2767 HTML editor initialization
2769 Default:
2771 None.
2772 Overrides:
2774 Virtual domain
2775 Javascript excerpt that enables and configures the WYSIWYG HTML editor.
2777 Example:
2779 html_editor_init tinymce.init({selector:"#body",language:lang.split(/[^a-zA-Z]+/).join("_")});
2781 "max_wrong_password"
2783 Count limit of wrong password submission
2785 Default:
2787 19
2788 Overrides:
2790 Virtual domain
2791 If this limit is reached, the account is locked until the user renews
2793 their password. The default value is chosen in order to block bots
2794 trying to log in using brute force strategy. This value should never be
2795 reached by real users that will probably uses the renew password
2796 service before they performs so many tries.
2797 "password_case"
2799 Password case
2801 Default:
2803 "insensitive"
2804 Overrides:
2806 None.
2807 "insensitive" or "sensitive".
2809 If set to "insensitive", WWSympa's password check will be insensitive.
2811 This only concerns passwords stored in the Sympa database, not the ones
2812 in LDAP.
2813 Should not be changed! May invalid all user password.
2815 "password_hash"
2817 Password hashing algorithm
2819 Default:
2821 "md5"
2822 Overrides:
2824 None.
2825 "md5" or "bcrypt".
2827 If set to "md5", Sympa will use MD5 password hashes. If set to
2829 "bcrypt", bcrypt hashes will be used instead. This only concerns
2830 passwords stored in the Sympa database, not the ones in LDAP.
2831 Should not be changed! May invalid all user passwords.
2833 "password_hash_update"
2835 Update password hashing algorithm when users log in
2837 Default:
2839 1
2840 Overrides:
2842 None.
2843 On successful login, update the encrypted user password to use the
2845 algorithm specified by "password_hash". This allows for a graceful
2846 transition to a new password hash algorithm. A value of 0 disables
2847 updating of existing password hashes. New and reset passwords will use
2848 the "password_hash" setting in all cases.
2849 "bcrypt_cost"
2851 Bcrypt hash cost
2853 Default:
2855 12
2856 Overrides:
2858 None.
2859 When "password_hash" is set to "bcrypt", this sets the "cost" parameter
2861 of the bcrypt hash function. The default of 12 is expected to require
2862 approximately 250ms to calculate the password hash on a 3.2GHz CPU.
2863 This only concerns passwords stored in the Sympa database, not the ones
2864 in LDAP.
2865 Can be changed but any new cost setting will only apply to new
2867 passwords.
2868 "one_time_ticket_lifetime"
2870 Age of one time ticket
2872 Default:
2874 "2d"
2875 Overrides:
2877 None.
2878 Duration before the one time tickets are expired
2880 "one_time_ticket_lockout"
2882 Restrict access to one time ticket
2884 Default:
2886 "one_time"
2887 Overrides:
2889 Virtual domain
2890 Is access to the one time ticket restricted, if any users previously
2892 accessed? (one_time | remote_addr | open)
2893 "purge_one_time_ticket_table_task"
2895 Default:
2897 "daily"
2898 Overrides:
2900 None.
2901 "one_time_ticket_table_ttl"
2903 Default:
2905 "10d"
2906 Overrides:
2908 None.
2909 "pictures_feature"
2911 Pictures
2913 Default:
2915 "on"
2916 Overrides:
2918 Virtual domain
2919 List
2921 Enables or disables the pictures feature by default. If enabled,
2923 subscribers can upload their picture (from the "Subscriber option"
2924 page) to use as an avatar.
2925 Pictures are stored in a directory specified by the
2927 "static_content_path" parameter.
2928 "pictures_max_size"
2930 The maximum size of uploaded picture
2932 Default:
2934 102400 (bytes)
2935 Overrides:
2937 Virtual domain
2938 "spam_protection"
2940 Protect web interface against spam harvesters
2942 Default:
2944 "javascript"
2945 Overrides:
2947 Virtual domain
2948 These values are supported:
2950 javascript: the address is hidden using a javascript. Users who enable
2952 Javascript can see nice mailto addresses where others have nothing.
2953 at: the "@" character is replaced by the string "AT".
2955 none: no protection against spam harvesters.
2957 "web_archive_spam_protection"
2959 Protect web archive against spam harvesters
2961 Default:
2963 "cookie"
2964 Overrides:
2966 Virtual domain
2967 List
2969 The same as "spam_protection", but restricted to the web archive.
2971 In addition to it:
2973 cookie: users must submit a small form in order to receive a cookie
2975 before browsing the web archive.
2976 gecos:
2978 only gecos is displayed.
2980 "reporting_spam_script_path"
2982 Script to report spam
2984 Default:
2986 None.
2987 Overrides:
2989 Virtual domain
2990 If set, when a list moderator report undetected spams for list
2992 moderation, this external script is invoked and the message is injected
2993 into standard input of the script.
2994 "domains_blacklist"
2996 Prevent people to subscribe to a list with adresses using these domains
2998 Default:
3000 None.
3001 Overrides:
3003 None.
3004 This parameter is a comma-separated list.
3006 Example:
3008 domains_blacklist example.org,spammer.com
3010 "quiet_subscription"
3012 Quiet subscriptions policy
3014 Default:
3016 "optional"
3017 Overrides:
3019 None.
3020 Global policy for quiet subscriptions: "on" means that subscriptions
3022 will never send a notice to the subscriber, "off" will enforce a notice
3023 sending, and "optional" (default) allows the use of the list policy.
3024 S/MIME and TLS
3026 S/MIME authentication, decryption and re-encryption. It requires these
3027 external modules: Crypt-OpenSSL-X509 and Crypt-SMIME.
3028 TLS client authentication. It requires an external module: IO-Socket-
3030 SSL.
3031 "cafile"
3033 File containing trusted CA certificates
3035 Default:
3037 None.
3038 Overrides:
3040 None.
3041 This can be used alternatively and/or additionally to "capath".
3043 Example:
3045 cafile /etc/pki/tls/certs/ca-bundle.crt
3047 "capath"
3049 Directory containing trusted CA certificates
3051 Default:
3053 None.
3054 Overrides:
3056 None.
3057 CA certificates in this directory are used for client authentication.
3059 The certificates need to have names including hash of subject, or
3061 symbolic links to them with such names. The links may be created by
3062 using "c_rehash" script bundled in OpenSSL.
3063 Example:
3065 capath /etc/pki/tls/certs
3067 "key_passwd"
3069 Password used to crypt lists private keys
3071 Default:
3073 None.
3074 Overrides:
3076 None.
3077 If not defined, Sympa assumes that list private keys are not encrypted.
3079 Example:
3081 key_passwd your_password
3083 "ssl_cert_dir"
3085 Directory containing user certificates
3087 Default:
3089 "$EXPLDIR/X509-user-certs"
3090 Overrides:
3092 None.
3093 Data sources setup
3095 Including subscribers, owners and moderators from data sources.
3096 Appropriate database driver (DBD) modules are required: DBD-CSV, DBD-
3097 mysql, DBD-ODBC, DBD-Oracle, DBD-Pg, DBD-SQLite and/or Net-LDAP. And
3098 also, if secure connection (LDAPS) to LDAP server is required: IO-
3099 Socket-SSL.
3100 "default_sql_fetch_timeout"
3102 Default of SQL fetch timeout
3104 Default:
3106 300
3107 Overrides:
3109 List ("sql_fetch_timeout")
3110 Default timeout while performing a fetch with include_sql_query.
3112 "default_ttl"
3114 Default of inclusion timeout
3116 Default:
3118 3600
3119 Overrides:
3121 List ("ttl")
3122 Default timeout between two scheduled synchronizations of list members
3124 with data sources.
3125 DKIM and ARC
3127 DKIM signature verification and re-signing. It requires an external
3128 module: Mail-DKIM.
3129 ARC seals on forwarded messages. It requires an external module: Mail-
3131 DKIM.
3132 "dkim_feature"
3134 Enable DKIM
3136 Default:
3138 "off"
3139 Overrides:
3141 Virtual domain
3142 List
3144 If set to "on", Sympa may verify DKIM signatures of incoming messages
3146 and/or insert DKIM signature to outgoing messages.
3147 "dkim_add_signature_to"
3149 Which service messages to be signed
3151 Default:
3153 "robot,list"
3154 Overrides:
3156 Virtual domain
3157 Inserts a DKIM signature to service messages in context of robot, list
3159 or both
3160 "dkim_private_key_path"
3162 File path for DKIM private key
3164 Default:
3166 None.
3167 Overrides:
3169 Virtual domain
3170 List ("dkim_parameters.private_key_path")
3172 The file must contain a PEM encoded private key
3174 "dkim_signature_apply_on"
3176 Which messages delivered via lists to be signed
3178 Default:
3180 "md5_authenticated_messages,smime_authenticated_messages,dkim_authenticated_messages,editor_validated_messages"
3181 Overrides:
3183 Virtual domain
3184 List
3186 Type of message that is added a DKIM signature before distribution to
3188 subscribers. Possible values are "none", "any" or a list of the
3189 following keywords: "md5_authenticated_messages",
3190 "smime_authenticated_messages", "dkim_authenticated_messages",
3191 "editor_validated_messages".
3192 "dkim_signer_domain"
3194 The "d=" tag as defined in rfc 4871
3196 Default:
3198 None.
3199 Overrides:
3201 Virtual domain
3202 List ("dkim_parameters.signer_domain")
3204 The DKIM "d=" tag is the domain of the signing entity. The virtual host
3206 domain name is used as its default value
3207 "dkim_signer_identity"
3209 The "i=" tag as defined in rfc 4871
3211 Default:
3213 None.
3214 Overrides:
3216 Virtual domain
3217 Default is null.
3219 "dkim_selector"
3221 Selector for DNS lookup of DKIM public key
3223 Default:
3225 None.
3226 Overrides:
3228 Virtual domain
3229 List ("dkim_parameters.selector")
3231 The selector is used in order to build the DNS query for public key. It
3233 is up to you to choose the value you want but verify that you can query
3234 the public DKIM key for "<selector>._domainkey.your_domain"
3235 "arc_feature"
3237 Enable ARC
3239 Default:
3241 "off"
3242 Overrides:
3244 Virtual domain
3245 List
3247 If set to "on", Sympa may add ARC seals to outgoing messages.
3249 "arc_srvid"
3251 SRV ID for Authentication-Results used in ARC seal
3253 Default:
3255 None.
3256 Overrides:
3258 Virtual domain
3259 Typically the domain of the mail server
3261 "arc_signer_domain"
3263 The "d=" tag as defined in ARC
3265 Default:
3267 None.
3268 Overrides:
3270 Virtual domain
3271 List ("arc_parameters.arc_signer_domain")
3273 The ARC "d=" tag is the domain of the signing entity. The DKIM d=
3275 domain name is used as its default value
3276 "arc_selector"
3278 Selector for DNS lookup of ARC public key
3280 Default:
3282 None.
3283 Overrides:
3285 Virtual domain
3286 List ("arc_parameters.arc_selector")
3288 The selector is used in order to build the DNS query for public key. It
3290 is up to you to choose the value you want but verify that you can query
3291 the public DKIM key for "<selector>._domainkey.your_domain". Default is
3292 the same selector as for DKIM signatures
3293 "arc_private_key_path"
3295 File path for ARC private key
3297 Default:
3299 None.
3300 Overrides:
3302 Virtual domain
3303 List ("arc_parameters.arc_private_key_path")
3305 The file must contain a PEM encoded private key. Defaults to same file
3307 as DKIM private key
3308 DMARC protection
3310 Processes originator addresses to avoid some domains' excessive DMARC
3311 protection. This feature requires an external module: Net-DNS.
3312 "dmarc_protection_mode"
3314 Test mode(s) for DMARC Protection
3316 Default:
3318 None.
3319 Overrides:
3321 Virtual domain
3322 List ("dmarc_protection.mode")
3324 Do not set unless you want to use DMARC protection.
3326 This is a comma separated list of test modes; if multiple are selected
3328 then protection is activated if ANY match. Do not use dmarc_* modes
3329 unless you have a local DNS cache as they do a DNS lookup for each
3330 received message.
3331 Example:
3333 dmarc_protection_mode dmarc_reject,dkim_signature
3335 "dmarc_protection_domain_regex"
3337 Regular expression for domain name match
3339 Default:
3341 None.
3342 Overrides:
3344 Virtual domain
3345 List ("dmarc_protection.domain_regex")
3347 This is used for the "domain_regex" protection mode.
3349 "dmarc_protection_phrase"
3351 New From name format
3353 Default:
3355 "name_via_list"
3356 Overrides:
3358 Virtual domain
3359 List ("dmarc_protection.phrase")
3361 This is the format to be used for the sender name part of the new From
3363 header field.
3364 "dmarc_protection_other_email"
3366 New From address
3368 Default:
3370 None.
3371 Overrides:
3373 Virtual domain
3374 List ("dmarc_protection.other_email")
3376 List address verification
3378 Checks if an alias with the same name as the list to be created already
3379 exists on the SMTP server. This feature requires an external module:
3380 Net-SMTP.
3381 "list_check_helo"
3383 SMTP HELO (EHLO) parameter used for address verification
3385 Default:
3387 None.
3388 Overrides:
3390 Virtual domain
3391 Default value is the host part of "list_check_smtp" parameter.
3393 "list_check_smtp"
3395 SMTP server to verify existence of the same addresses as the list to be
3397 created
3398 Default:
3400 None.
3401 Overrides:
3403 Virtual domain
3404 This is needed if you are running Sympa on a host but you handle all
3406 your mail on a separate mail relay.
3407 Default value is real FQDN of the host. Port number may be specified as
3409 "mail.example.org:25" or "203.0.113.1:25". If port is not specified,
3410 standard port (25) will be used.
3411 "list_check_suffixes"
3413 Address suffixes to verify
3415 Default:
3417 "request,owner,editor,unsubscribe,subscribe"
3418 Overrides:
3420 Virtual domain
3421 List of suffixes you are using for list addresses, i.e. "mylist-
3423 request", "mylist-owner" and so on.
3424 This parameter is used with the "list_check_smtp" parameter. It is also
3426 used to check list names at list creation time.
3427 Antivirus plug-in
3429 "antivirus_path"
3430 Path to the antivirus scanner engine
3432 Default:
3434 None.
3435 Overrides:
3437 Virtual domain
3438 Supported antivirus: Clam AntiVirus/clamscan & clamdscan,
3440 McAfee/uvscan, Fsecure/fsav, Sophos, AVP and Trend Micro/VirusWall
3441 Example:
3443 antivirus_path /usr/local/bin/clamscan
3445 "antivirus_args"
3447 Antivirus plugin command line arguments
3449 Default:
3451 None.
3452 Overrides:
3454 Virtual domain
3455 Example:
3457 antivirus_args --no-summary --database /usr/local/share/clamav
3459 "antivirus_notify"
3461 Notify sender if virus checker detects malicious content
3463 Default:
3465 "sender"
3466 Overrides:
3468 Virtual domain
3469 "sender" to notify originator of the message, "delivery_status" to send
3471 delivery status, or "none"
3472 Password validation
3474 Checks if the password the user submitted has sufficient strength. This
3475 feature requires an external module: Data-Password.
3476 "password_validation"
3478 Password validation
3480 Default:
3482 None.
3483 Overrides:
3485 None.
3486 The password validation techniques to be used against user passwords
3488 that are added to mailing lists. Options come from Data::Password
3489 (http://search.cpan.org/~razinf/Data-Password-1.07/Password.pm#VARIABLES)
3490 Example:
3492 password_validation MINLEN=8,GROUPS=3,DICTIONARY=4,DICTIONARIES=/pentest/dictionaries
3494 Authentication with LDAP
3496 Authenticates users based on the directory on LDAP server. This feature
3497 requires an external module: Net-LDAP. And also, if secure connection
3498 (LDAPS) is required: IO-Socket-SSL.
3499 "ldap_force_canonical_email"
3501 Use canonical email address for LDAP authentication
3503 Default:
3505 1
3506 Overrides:
3508 Virtual domain
3509 When using LDAP authentication, if the identifier provided by the user
3511 was a valid email, if this parameter is set to false, then the provided
3512 email will be used to authenticate the user. Otherwise, use of the
3513 first email returned by the LDAP server will be used.
3514 SOAP HTTP interface
3516 Provides some functions of Sympa through the SOAP HTTP interface. This
3517 feature requires an external module: SOAP-Lite.
3518 "soap_url"
3520 URL of SympaSOAP
3522 Default:
3524 None.
3525 Overrides:
3527 Virtual domain
3528 WSDL document of SympaSOAP refers to this URL in its service section.
3530 Example:
3532 soap_url http://web.example.org/sympasoap
3534 "soap_url_local"
3536 URL of SympaSOAP behind proxy
3538 Default:
3540 None.
3541 Overrides:
3543 Virtual domain
3544 Obsoleted parameters
3546 "host"
3547 Default:
3549 None.
3550 Overrides:
3552 Virtual domain
3553 "log_condition"
3555 Default:
3557 None.
3558 Overrides:
3560 Virtual domain
3561 "log_module"
3563 Default:
3565 None.
3566 Overrides:
3568 Virtual domain
3569 "filesystem_encoding"
3571 Default:
3573 "utf-8"
3574 Overrides:
3576 None.
3577 "automatic_list_prefix"
3579 Defines the prefix allowing to recognize that a list is an automatic
3581 list.
3582 Default:
3584 None.
3585 Overrides:
3587 None.
3588 "default_distribution_ttl"
3590 Default timeout between two action-triggered synchronizations of list
3592 members with data sources.
3593 Default:
3595 300
3596 Overrides:
3598 None.
3599 "edit_list"
3601 Default:
3603 "owner"
3604 Overrides:
3606 None.
3607 "use_fast_cgi"
3609 Enable FastCGI
3611 Default:
3613 1
3614 Overrides:
3616 None.
3617 Is FastCGI module for HTTP server installed? This module provides a
3619 much faster web interface.
3620 "htmlarea_url"
3622 Default:
3624 None.
3625 Overrides:
3627 None.
3628 "show_report_abuse"
3630 Add a "Report abuse" link in the side menu of the lists (0|1)
3632 Default:
3634 0
3635 Overrides:
3637 None.
3638 The link is a mailto link, you can change that by overriding
3640 web_tt2/report_abuse.tt2
3641 "allow_account_deletion"
3643 EXPERIMENTAL! Allow users to delete their account. If enabled, shows a
3645 "delete my account" form in user's preferences page.
3646 Default:
3648 0
3649 Overrides:
3651 None.
3652 Account deletion unsubscribes the users from his/her lists and removes
3654 him/her from lists ownership. It is only available to users using
3655 internal authentication (i.e. no LDAP, no SSO...). See
3656 https://github.com/sympa-community/sympa/issues/300 for details
3657
3659 /etc/sympa/sympa.conf
3660 Sympa main configuration file.
3661 $SYSCONFDIR/<robot name>/robot.conf
3663 Configuration specific to each virtual domain.
3664 $EXPLDIR/<list name>/config or $EXPLDIR/<robot name>/<list name>/config
3666 Configuration specific to each list.
3667
3669 Sympa Administration Manual.
3670 <https://sympa-community.github.io/manual/>.
36716.2.48 2019-11-29 SYMPA.CONF(5)
