1SYMPA.CONF(5) sympa 6.2.48 SYMPA.CONF(5)
2
3
4
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
14 Format of sympa.conf and robot.conf is as following:
15
16 · Lines beginning with "#" and containing only spaces are ignored.
17
18 · 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
27 Service description
28 "domain"
29
30 Primary mail domain name
31
32 Default:
33 None, mandatory.
34
35 Overrides:
36 Virtual domain
37
38 Example:
39
40 domain mail.example.org
41
42 "listmaster"
43
44 Email addresses of listmasters
45
46 Default:
47 None, mandatory.
48
49 Overrides:
50 Virtual domain
51
52 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
58 Example:
59
60 listmaster your_email_address@domain.tld
61
62 "lang"
63
64 Default language
65
66 Default:
67 "en-US"
68
69 Overrides:
70 Virtual domain
71
72 List
73
74 This is the default language used by Sympa. One of supported languages
75 should be chosen.
76
77 "supported_lang"
78
79 Supported languages
80
81 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
84 Overrides:
85 Virtual domain
86
87 All supported languages for the user interface. Languages proper locale
88 information not installed are ignored.
89
90 "title"
91
92 Title of service
93
94 Default:
95 "Mailing lists service"
96
97 Overrides:
98 Virtual domain
99
100 The name of your mailing list service. It will appear in the header of
101 web interface and subjects of several service messages.
102
103 "gecos"
104
105 Display name of Sympa
106
107 Default:
108 "SYMPA"
109
110 Overrides:
111 Virtual domain
112
113 This parameter is used for display name in the "From:" header field for
114 the messages sent by Sympa itself.
115
116 "legacy_character_support_feature"
117
118 Support of legacy character set
119
120 Default:
121 "off"
122
123 Overrides:
124 None.
125
126 If set to "on", enables support of legacy character set according to
127 charset.conf(5) configuration file.
128
129 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
133 Database related
134 "update_db_field_types"
135
136 Update database structure
137
138 Default:
139 "auto"
140
141 Overrides:
142 None.
143
144 auto: Updates database table structures automatically.
145
146 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
149 "db_type"
150
151 Type of the database
152
153 Default:
154 "mysql"
155
156 Overrides:
157 None.
158
159 Possible types are "MySQL", "PostgreSQL", "Oracle" and "SQLite".
160
161 "db_host"
162
163 Hostname of the database server
164
165 Default:
166 None.
167
168 Overrides:
169 None.
170
171 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
174 Example:
175
176 db_host localhost
177
178 "db_port"
179
180 Port of the database server
181
182 Default:
183 None.
184
185 Overrides:
186 None.
187
188 "db_name"
189
190 Name of the database
191
192 Default:
193 "sympa"
194
195 Overrides:
196 None.
197
198 With SQLite, this must be the full path to database file.
199
200 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
205 "db_user"
206
207 User for the database connection
208
209 Default:
210 "user_name"
211
212 Overrides:
213 None.
214
215 Example:
216
217 db_user sympa
218
219 "db_passwd"
220
221 Password for the database connection
222
223 Default:
224 "user_password"
225
226 Overrides:
227 None.
228
229 What ever you use a password or not, you must protect the SQL server
230 (is it not a public internet service ?)
231
232 Example:
233
234 db_passwd your_passwd
235
236 "db_options"
237
238 Database options
239
240 Default:
241 None.
242
243 Overrides:
244 None.
245
246 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
250 Example:
251
252 db_options mysql_read_default_file=/home/joe/my.cnf;mysql_socket=tmp/mysql.sock-test
253
254 "db_env"
255
256 Environment variables setting for database
257
258 Default:
259 None.
260
261 Overrides:
262 None.
263
264 With Oracle Database, this is useful for defining ORACLE_HOME and
265 NLS_LANG.
266
267 Example:
268
269 db_env NLS_LANG=American_America.AL32UTF8;ORACLE_HOME=/u01/app/oracle/product/11.2.0/server
270
271 "db_timeout"
272
273 Database processing timeout
274
275 Default:
276 None.
277
278 Overrides:
279 None.
280
281 Currently, this parameter may be used for SQLite only.
282
283 "db_additional_subscriber_fields"
284
285 Database private extension to subscriber table
286
287 Default:
288 None.
289
290 Overrides:
291 None.
292
293 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
297 * for scenarios: [subscriber->field]
298
299 * for templates: [% subscriber.field %]
300
301 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
305 You need to extend the database format with these fields
306
307 Example:
308
309 db_additional_subscriber_fields billing_delay,subscription_expiration
310
311 "db_additional_user_fields"
312
313 Database private extension to user table
314
315 Default:
316 None.
317
318 Overrides:
319 None.
320
321 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
325 This parameter is a comma-separated list.
326
327 You need to extend the database format with these fields
328
329 Example:
330
331 db_additional_user_fields age,address
332
333 System log
334 "syslog"
335
336 System log facility for Sympa
337
338 Default:
339 "LOCAL1"
340
341 Overrides:
342 None.
343
344 Do not forget to configure syslog server.
345
346 "log_socket_type"
347
348 Communication mode with syslog server
349
350 Default:
351 "unix"
352
353 Overrides:
354 None.
355
356 "log_level"
357
358 Log verbosity
359
360 Default:
361 0
362
363 Overrides:
364 Virtual domain
365
366 Sets the verbosity of logs.
367
368 0: Only main operations are logged
369
370 3: Almost everything is logged.
371
372 Example:
373
374 log_level 2
375
376 Alias management
377 "aliases_program"
378
379 Program used to update alias database
380
381 Default:
382 "newaliases"
383
384 Overrides:
385 Virtual domain
386
387 This may be "makemap", "newaliases", "postalias", "postmap" or full
388 path to custom program.
389
390 "aliases_db_type"
391
392 Type of alias database
393
394 Default:
395 "hash"
396
397 Overrides:
398 Virtual domain
399
400 "btree", "dbm", "hash" and so on. Available when aliases_program is
401 "makemap", "postalias" or "postmap"
402
403 "sendmail_aliases"
404
405 Path of the file that contains all list related aliases
406
407 Default:
408 $SENDMAIL_ALIASES
409
410 Overrides:
411 Virtual domain
412
413 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
416 Set this parameter to "none" if you want to disable alias management in
417 Sympa.
418
419 "alias_manager"
420
421 Path to alias manager
422
423 Default:
424 "$SBINDIR/alias_manager.pl"
425
426 Overrides:
427 None.
428
429 The absolute path to the script that will add/remove mail aliases
430
431 Example:
432
433 alias_manager /usr/local/libexec/ldap_alias_manager.pl
434
435 Receiving
436 "default_max_list_members"
437
438 Default maximum number of list members
439
440 Default:
441 0
442
443 Overrides:
444 Virtual domain
445
446 List ("max_list_members")
447
448 Default limit for the number of subscribers per list (0 means no
449 limit).
450
451 "max_size"
452
453 Maximum size of messages
454
455 Default:
456 5242880 (bytes)
457
458 Overrides:
459 Virtual domain
460
461 List
462
463 Incoming messages smaller than this size is allowed distribution by
464 Sympa.
465
466 Example:
467
468 max_size 2097152
469
470 "reject_mail_from_automates_feature"
471
472 Reject mail sent from automated services to list
473
474 Default:
475 "on"
476
477 Overrides:
478 List
479
480 Rejects messages that seem to be from automated services, based on a
481 few header fields ("Content-Identifier:", "Auto-Submitted:").
482
483 Sympa also can be configured to reject messages based on the "From:"
484 header field value (see "loop_prevention_regex").
485
486 Example:
487
488 reject_mail_from_automates_feature off
489
490 "sender_headers"
491
492 Header field name(s) used to determine sender of the messages
493
494 Default:
495 "From"
496
497 Overrides:
498 None.
499
500 "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
509 Example:
510
511 sender_headers Resent-From,From,Return-Path
512
513 "misaddressed_commands"
514
515 Reject misaddressed commands
516
517 Default:
518 "reject"
519
520 Overrides:
521 None.
522
523 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
527 "misaddressed_commands_regexp"
528
529 Regular expression matching with misaddressed commands
530
531 Default:
532 "((subscribe\s+(\S+)|unsubscribe\s+(\S+)|signoff\s+(\S+)|set\s+(\S+)\s+(mail|nomail|digest))\s*)"
533
534 Overrides:
535 None.
536
537 Perl regular expression applied on messages subject and body to detect
538 misaddressed commands.
539
540 "sympa_priority"
541
542 Priority for command messages
543
544 Default:
545 1
546
547 Overrides:
548 Virtual domain
549
550 Priority applied to messages sent to Sympa command address.
551
552 "request_priority"
553
554 Priority for messages bound for list owners
555
556 Default:
557 0
558
559 Overrides:
560 Virtual domain
561
562 Priority for processing of messages bound for "LIST-request" address,
563 i.e. owners of the list
564
565 "owner_priority"
566
567 Priority for non-VERP bounces
568
569 Default:
570 9
571
572 Overrides:
573 Virtual domain
574
575 Priority for processing of messages bound for "LIST-owner" address,
576 i.e. non-delivery reports (bounces).
577
578 "default_list_priority"
579
580 Default priority for list messages
581
582 Default:
583 5
584
585 Overrides:
586 Virtual domain
587
588 List ("priority")
589
590 Priority for processing of messages posted to list addresses.
591
592 "incoming_max_count"
593
594 Max number of sympa.pl workers
595
596 Default:
597 1
598
599 Overrides:
600 None.
601
602 Max number of workers of sympa.pl daemon processing incoming spool.
603
604 "sleep"
605
606 Interval between scanning incoming message spool
607
608 Default:
609 5 (seconds)
610
611 Overrides:
612 None.
613
614 Must not be 0.
615
616 Sending related
617 "anonymous_header_fields"
618
619 Header fields removed when a mailing list is setup in anonymous mode
620
621 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
624 Overrides:
625 None.
626
627 See "anonymous_sender" list parameter.
628
629 Default value prior to Sympa 6.1.19 is:
630
631 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
633 "merge_feature"
634
635 Allow message personalization by default
636
637 Default:
638 "off"
639
640 Overrides:
641 List
642
643 This parameter defines the default "merge_feature" list parameter.
644
645 "remove_headers"
646
647 Header fields to be removed from incoming messages
648
649 Default:
650 "X-Sympa-To,X-Family-To,Return-Receipt-To,Precedence,X-Sequence,Disposition-Notification-To,Sender"
651
652 Overrides:
653 List
654
655 Use it, for example, to ensure some privacy for your users in case that
656 "anonymous_sender" mode is inappropriate.
657
658 The removal of these header fields is applied before Sympa adds its own
659 header fields ("rfc2369_header_fields" and "custom_header").
660
661 Example:
662
663 remove_headers Resent-Date,Resent-From,Resent-To,Resent-Message-Id,Sender,Delivered-To
664
665 "remove_outgoing_headers"
666
667 Header fields to be removed before message distribution
668
669 Default:
670 "none"
671
672 Overrides:
673 List
674
675 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
679 Example:
680
681 remove_outgoing_headers X-no-archive
682
683 "rfc2369_header_fields"
684
685 RFC 2369 header fields
686
687 Default:
688 "help,subscribe,unsubscribe,post,owner,archive"
689
690 Overrides:
691 List
692
693 Specify which RFC 2369 mailing list header fields to be added.
694
695 "List-Id:" header field defined in RFC 2919 is always added. Sympa also
696 adds "Archived-At:" header field defined in RFC 5064.
697
698 "urlize_min_size"
699
700 Minimum size to be urlized
701
702 Default:
703 10240 (bytes)
704
705 Overrides:
706 Virtual domain
707
708 When a subscriber chose "urlize" reception mode, attachments not
709 smaller than this size will be urlized.
710
711 "allowed_external_origin"
712
713 Allowed external links in sanitized HTML
714
715 Default:
716 None.
717
718 Overrides:
719 Virtual domain
720
721 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
726 Example:
727
728 allowed_external_origin *.example.org,www.example.com
729
730 "sympa_packet_priority"
731
732 Default priority for a packet
733
734 Default:
735 5
736
737 Overrides:
738 Virtual domain
739
740 The default priority set to a packet to be sent by the bulk.
741
742 "bulk_fork_threshold"
743
744 Fork threshold of bulk daemon
745
746 Default:
747 1
748
749 Overrides:
750 None.
751
752 The minimum number of packets before bulk daemon forks a new worker to
753 increase sending rate.
754
755 "bulk_max_count"
756
757 Maximum number of bulk workers
758
759 Default:
760 3
761
762 Overrides:
763 None.
764
765 "bulk_lazytime"
766
767 Idle timeout of bulk workers
768
769 Default:
770 600 (seconds)
771
772 Overrides:
773 None.
774
775 The number of seconds a bulk worker will remain running without
776 processing a message before it spontaneously exits.
777
778 "bulk_sleep"
779
780 Sleep time of bulk workers
781
782 Default:
783 1 (seconds)
784
785 Overrides:
786 None.
787
788 The number of seconds a bulk worker sleeps between starting a new loop
789 if it didn't find a message to send.
790
791 Keep it small if you want your server to be reactive.
792
793 "bulk_wait_to_fork"
794
795 Interval between checks of packet numbers
796
797 Default:
798 10 (seconds)
799
800 Overrides:
801 None.
802
803 Number of seconds a master bulk daemon waits between two packets number
804 checks.
805
806 Keep it small if you expect brutal increases in the message sending
807 load.
808
809 "sendmail"
810
811 Path to sendmail
812
813 Default:
814 "/usr/sbin/sendmail"
815
816 Overrides:
817 None.
818
819 Absolute path to sendmail command line utility (e.g.: a binary named
820 "sendmail" is distributed with Postfix).
821
822 Sympa expects this binary to be sendmail compatible (exim, Postfix,
823 qmail and so on provide it).
824
825 "sendmail_args"
826
827 Command line parameters passed to sendmail
828
829 Default:
830 "-oi -odi -oem"
831
832 Overrides:
833 None.
834
835 Note that "-f", "-N" and "-V" options and recipient addresses should
836 not be included, because they will be included by Sympa.
837
838 "log_smtp"
839
840 Log invocation of sendmail
841
842 Default:
843 "off"
844
845 Overrides:
846 Virtual domain
847
848 This can be overwritten by "-m" option for sympa.pl.
849
850 "maxsmtp"
851
852 Maximum number of sendmail processes
853
854 Default:
855 40
856
857 Overrides:
858 None.
859
860 Maximum number of simultaneous child processes spawned by Sympa. This
861 is the main load control parameter.
862
863 Proposed value is quite low, but you can rise it up to 100, 200 or even
864 300 with powerful systems.
865
866 Example:
867
868 maxsmtp 500
869
870 "nrcpt"
871
872 Maximum number of recipients per call to sendmail
873
874 Default:
875 25
876
877 Overrides:
878 None.
879
880 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
885 "avg"
886
887 Maximum number of different mail domains per call to sendmail
888
889 Default:
890 10
891
892 Overrides:
893 None.
894
895 Privileges
896 "create_list"
897
898 Who is able to create lists
899
900 Default:
901 "public_listmaster"
902
903 Overrides:
904 Virtual domain
905
906 Value of this parameter is name of "create_list" scenario.
907
908 Defines who can create lists (or request list creation) by creating new
909 lists or by renaming or copying existing lists.
910
911 Example:
912
913 create_list intranet
914
915 "allow_subscribe_if_pending"
916
917 Allow adding subscribers to a list not open
918
919 Default:
920 "on"
921
922 Overrides:
923 Virtual domain
924
925 If set to "off", adding subscribers to, or removing subscribers from a
926 list with status other than "open" is forbidden.
927
928 "global_remind"
929
930 Who is able to send remind messages over all lists
931
932 Default:
933 "listmaster"
934
935 Overrides:
936 None.
937
938 Value of this parameter is name of "global_remind" scenario.
939
940 "move_user"
941
942 Who is able to change user's email
943
944 Default:
945 "auth"
946
947 Overrides:
948 Virtual domain
949
950 Value of this parameter is name of "move_user" scenario.
951
952 "use_blacklist"
953
954 Use blacklist
955
956 Default:
957 "send,create_list"
958
959 Overrides:
960 Virtual domain
961
962 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
966 "owner_domain"
967
968 List of required domains for list owner addresses
969
970 Default:
971 None.
972
973 Overrides:
974 Virtual domain
975
976 List
977
978 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
983 Example:
984
985 owner_domain domain1.tld domain2.tld
986
987 "owner_domain_min"
988
989 Minimum number of owners for each list that must match owner_domain
990 restriction
991
992 Default:
993 0
994
995 Overrides:
996 Virtual domain
997
998 List
999
1000 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
1007 Example:
1008
1009 owner_domain_min 1
1010
1011 Default privileges for the lists
1012 "visibility"
1013
1014 Visibility of the list
1015
1016 Default:
1017 "conceal"
1018
1019 Overrides:
1020 Virtual domain
1021
1022 List
1023
1024 Value of this parameter is name of "visibility" scenario.
1025
1026 "send"
1027
1028 Who can send messages
1029
1030 Default:
1031 "private"
1032
1033 Overrides:
1034 Virtual domain
1035
1036 List
1037
1038 Value of this parameter is name of "send" scenario.
1039
1040 "info"
1041
1042 Who can view list information
1043
1044 Default:
1045 "open"
1046
1047 Overrides:
1048 Virtual domain
1049
1050 List
1051
1052 Value of this parameter is name of "info" scenario.
1053
1054 "subscribe"
1055
1056 Who can subscribe to the list
1057
1058 Default:
1059 "open"
1060
1061 Overrides:
1062 Virtual domain
1063
1064 List
1065
1066 Value of this parameter is name of "subscribe" scenario.
1067
1068 "add"
1069
1070 Who can add subscribers
1071
1072 Default:
1073 "owner"
1074
1075 Overrides:
1076 Virtual domain
1077
1078 List
1079
1080 Value of this parameter is name of "add" scenario.
1081
1082 "unsubscribe"
1083
1084 Who can unsubscribe
1085
1086 Default:
1087 "open"
1088
1089 Overrides:
1090 Virtual domain
1091
1092 List
1093
1094 Value of this parameter is name of "unsubscribe" scenario.
1095
1096 "del"
1097
1098 Who can delete subscribers
1099
1100 Default:
1101 "owner"
1102
1103 Overrides:
1104 Virtual domain
1105
1106 List
1107
1108 Value of this parameter is name of "del" scenario.
1109
1110 "invite"
1111
1112 Who can invite people
1113
1114 Default:
1115 "private"
1116
1117 Overrides:
1118 Virtual domain
1119
1120 List
1121
1122 Value of this parameter is name of "invite" scenario.
1123
1124 "remind"
1125
1126 Who can start a remind process
1127
1128 Default:
1129 "owner"
1130
1131 Overrides:
1132 Virtual domain
1133
1134 List
1135
1136 Value of this parameter is name of "remind" scenario.
1137
1138 "review"
1139
1140 Who can review subscribers
1141
1142 Default:
1143 "owner"
1144
1145 Overrides:
1146 Virtual domain
1147
1148 List
1149
1150 Value of this parameter is name of "review" scenario.
1151
1152 "d_read"
1153
1154 Who can view
1155
1156 Default:
1157 "private"
1158
1159 Overrides:
1160 Virtual domain
1161
1162 List ("shared_doc.d_read")
1163
1164 Value of this parameter is name of "d_read" scenario.
1165
1166 "d_edit"
1167
1168 Who can edit
1169
1170 Default:
1171 "owner"
1172
1173 Overrides:
1174 Virtual domain
1175
1176 List ("shared_doc.d_edit")
1177
1178 Value of this parameter is name of "d_edit" scenario.
1179
1180 "archive_web_access"
1181
1182 access right
1183
1184 Default:
1185 "closed"
1186
1187 Overrides:
1188 Virtual domain
1189
1190 List ("archive.web_access")
1191
1192 Value of this parameter is name of "archive_web_access" scenario.
1193
1194 "archive_mail_access"
1195
1196 access right by mail commands
1197
1198 Default:
1199 "closed"
1200
1201 Overrides:
1202 Virtual domain
1203
1204 List ("archive.mail_access")
1205
1206 Value of this parameter is name of "archive_mail_access" scenario.
1207
1208 "tracking"
1209
1210 who can view message tracking
1211
1212 Default:
1213 "owner"
1214
1215 Overrides:
1216 Virtual domain
1217
1218 List ("tracking.tracking")
1219
1220 Value of this parameter is name of "tracking" scenario.
1221
1222 Archives
1223 "process_archive"
1224
1225 Store distributed messages into archive
1226
1227 Default:
1228 "off"
1229
1230 Overrides:
1231 Virtual domain
1232
1233 List
1234
1235 If enabled, distributed messages via lists will be archived. Otherwise
1236 archiving is disabled.
1237
1238 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
1242 "default_archive_quota"
1243
1244 Default disk quota for lists' archives
1245
1246 Default:
1247 None (Kbytes).
1248
1249 Overrides:
1250 List ("archive.quota")
1251
1252 "ignore_x_no_archive_header_feature"
1253
1254 Ignore "X-no-archive:" header field
1255
1256 Default:
1257 "off"
1258
1259 Overrides:
1260 None.
1261
1262 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
1266 Example:
1267
1268 ignore_x_no_archive_header_feature on
1269
1270 "custom_archiver"
1271
1272 Custom archiver
1273
1274 Default:
1275 None.
1276
1277 Overrides:
1278 None.
1279
1280 Activates a custom archiver to use instead of MHonArc. The value of
1281 this parameter is the absolute path to the executable file.
1282
1283 Sympa invokes this file with these two arguments:
1284
1285 --list
1286
1287 The address of the list including domain part.
1288
1289 --file
1290
1291 Absolute path to the message to be archived.
1292
1293 "mhonarc"
1294
1295 Path to MHonArc mail-to-HTML converter
1296
1297 Default:
1298 "/usr/bin/mhonarc"
1299
1300 Overrides:
1301 Virtual domain
1302
1303 This is required for HTML mail archiving.
1304
1305 Bounce management and tracking
1306 "bounce_warn_rate"
1307
1308 Default bounce warn rate
1309
1310 Default:
1311 30
1312
1313 Overrides:
1314 List ("bounce.warn_rate")
1315
1316 The list owner receives a warning whenever a message is distributed and
1317 the number (percentage) of bounces exceeds this value.
1318
1319 "bounce_halt_rate"
1320
1321 Default bounce halt rate
1322
1323 Default:
1324 50
1325
1326 Overrides:
1327 None.
1328
1329 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
1332 "default_bounce_level1_rate"
1333
1334 Default bounce management threshold, 1st level
1335
1336 Default:
1337 45
1338
1339 Overrides:
1340 Virtual domain
1341
1342 List ("bouncers_level1.rate")
1343
1344 "default_bounce_level2_rate"
1345
1346 Default bounce management threshold, 2nd level
1347
1348 Default:
1349 75
1350
1351 Overrides:
1352 Virtual domain
1353
1354 List ("bouncers_level2.rate")
1355
1356 "verp_rate"
1357
1358 Percentage of list members in VERP mode
1359
1360 Default:
1361 "0%"
1362
1363 Overrides:
1364 Virtual domain
1365
1366 List
1367
1368 Uses variable envelope return path (VERP) to detect bouncing subscriber
1369 addresses.
1370
1371 0%: VERP is never used.
1372
1373 100%: VERP is always in use.
1374
1375 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
1379 "tracking_delivery_status_notification"
1380
1381 Tracking message by delivery status notification (DSN)
1382
1383 Default:
1384 "off"
1385
1386 Overrides:
1387 List ("tracking.delivery_status_notification")
1388
1389 "tracking_message_disposition_notification"
1390
1391 Tracking message by message disposition notification (MDN)
1392
1393 Default:
1394 "off"
1395
1396 Overrides:
1397 List ("tracking.message_disposition_notification")
1398
1399 "tracking_default_retention_period"
1400
1401 Max age of tracking information
1402
1403 Default:
1404 90 (days)
1405
1406 Overrides:
1407 List ("tracking.retention_period")
1408
1409 Tracking information is removed after this number of days
1410
1411 "welcome_return_path"
1412
1413 Remove bouncing new subscribers
1414
1415 Default:
1416 "owner"
1417
1418 Overrides:
1419 List
1420
1421 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
1425 "remind_return_path"
1426
1427 Remove subscribers bouncing remind message
1428
1429 Default:
1430 "owner"
1431
1432 Overrides:
1433 List
1434
1435 Same as welcome_return_path, but applied to remind messages.
1436
1437 "default_remind_task"
1438
1439 Periodical subscription reminder task
1440
1441 Default:
1442 None.
1443
1444 Overrides:
1445 List ("remind_task")
1446
1447 This task regularly sends subscribers a message which reminds them of
1448 their list subscriptions.
1449
1450 "expire_bounce_task"
1451
1452 Task for expiration of old bounces
1453
1454 Default:
1455 "daily"
1456
1457 Overrides:
1458 None.
1459
1460 This task resets bouncing information for addresses not bouncing in the
1461 last 10 days after the latest message distribution.
1462
1463 "purge_orphan_bounces_task"
1464
1465 Task for cleaning invalidated bounces
1466
1467 Default:
1468 "monthly"
1469
1470 Overrides:
1471 None.
1472
1473 This task deletes bounce information for unsubscribed users.
1474
1475 "eval_bouncers_task"
1476
1477 Task for updating bounce scores
1478
1479 Default:
1480 "daily"
1481
1482 Overrides:
1483 None.
1484
1485 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
1489 "process_bouncers_task"
1490
1491 Task for management of bouncers
1492
1493 Default:
1494 "weekly"
1495
1496 Overrides:
1497 None.
1498
1499 This task executes actions on bouncing users configured by each list,
1500 according to their scores.
1501
1502 "purge_tables_task"
1503
1504 Task for cleaning tables
1505
1506 Default:
1507 "daily"
1508
1509 Overrides:
1510 None.
1511
1512 This task cleans old tracking information from "notification_table"
1513 table.
1514
1515 "minimum_bouncing_count"
1516
1517 Minimum number of bounces
1518
1519 Default:
1520 10
1521
1522 Overrides:
1523 None.
1524
1525 The minimum number of bounces received to update bounce score of a
1526 user.
1527
1528 "minimum_bouncing_period"
1529
1530 Minimum bouncing period
1531
1532 Default:
1533 10 (days)
1534
1535 Overrides:
1536 None.
1537
1538 The minimum period for which bouncing lasted to update bounce score of
1539 a user.
1540
1541 "bounce_delay"
1542
1543 Delay of bounces
1544
1545 Default:
1546 0 (days)
1547
1548 Overrides:
1549 None.
1550
1551 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
1555 "bounce_email_prefix"
1556
1557 Default:
1558 "bounce"
1559
1560 Overrides:
1561 None.
1562
1563 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
1567 If you change the default value, you must modify the mail aliases too.
1568
1569 "return_path_suffix"
1570
1571 Suffix of list return address
1572
1573 Default:
1574 "-owner"
1575
1576 Overrides:
1577 None.
1578
1579 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
1583 Loop prevention
1584 "loop_command_max"
1585
1586 Maximum number of responses to command message
1587
1588 Default:
1589 200
1590
1591 Overrides:
1592 None.
1593
1594 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
1598 "loop_command_sampling_delay"
1599
1600 Delay before counting responses to command message
1601
1602 Default:
1603 3600 (seconds)
1604
1605 Overrides:
1606 None.
1607
1608 This parameter defines the delay in seconds before decrementing the
1609 counter of reports sent to an email address.
1610
1611 "loop_command_decrease_factor"
1612
1613 Decrementing factor of responses to command message
1614
1615 Default:
1616 0.5
1617
1618 Overrides:
1619 None.
1620
1621 The decrementation factor (from 0 to 1), used to determine the new
1622 report counter after expiration of the delay.
1623
1624 "loop_prevention_regex"
1625
1626 Regular expression to prevent loop
1627
1628 Default:
1629 "mailer-daemon|sympa|listserv|majordomo|smartlist|mailman"
1630
1631 Overrides:
1632 Virtual domain
1633
1634 List
1635
1636 If the sender address matches the regular expression, then the message
1637 is rejected.
1638
1639 "msgid_table_cleanup_ttl"
1640
1641 Expiration period of message ID table
1642
1643 Default:
1644 86400 (seconds)
1645
1646 Overrides:
1647 None.
1648
1649 Expiration period of entries in the table maintained by sympa_msg.pl
1650 daemon to prevent delivery of duplicate messages caused by loop.
1651
1652 "msgid_table_cleanup_frequency"
1653
1654 Cleanup interval of message ID table
1655
1656 Default:
1657 3600 (seconds)
1658
1659 Overrides:
1660 None.
1661
1662 Interval between cleanups of the table maintained by sympa_msg.pl
1663 daemon to prevent delivery of duplicate messages caused by loop.
1664
1665 Automatic lists
1666 "automatic_list_removal"
1667
1668 Remove empty automatic list
1669
1670 Default:
1671 "none"
1672
1673 Overrides:
1674 Virtual domain
1675
1676 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
1680 Example:
1681
1682 automatic_list_removal if_empty
1683
1684 "automatic_list_feature"
1685
1686 Automatic list
1687
1688 Default:
1689 "off"
1690
1691 Overrides:
1692 Virtual domain
1693
1694 "automatic_list_creation"
1695
1696 Who is able to create automatic list
1697
1698 Default:
1699 "public"
1700
1701 Overrides:
1702 Virtual domain
1703
1704 Value of this parameter is name of "automatic_list_creation" scenario.
1705
1706 "automatic_list_families"
1707
1708 Definition of automatic list families
1709
1710 Default:
1711 None.
1712
1713 Overrides:
1714 Virtual domain
1715
1716 Defines the families the automatic lists are based on. It is a
1717 character string structured as follows:
1718
1719 * each family is separated from the other by a semicolon (;)
1720
1721 * inside a family definition, each field is separated from the other by
1722 a colon (:)
1723
1724 * each field has the structure: "<field name>=<field value>"
1725
1726 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
1730 * for scenarios: [family->name]
1731
1732 * for templates: [% family.name %]
1733
1734 Example:
1735
1736 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
1738 "parsed_family_files"
1739
1740 Parsed files for families
1741
1742 Default:
1743 "message_header,message_header.mime,message_footer,message_footer.mime,info"
1744
1745 Overrides:
1746 Virtual domain
1747
1748 comma-separated list of files that will be parsed by Sympa when
1749 instantiating a family (no space allowed in file names)
1750
1751 Tag based spam filtering
1752 "antispam_feature"
1753
1754 Tag based spam filtering
1755
1756 Default:
1757 "off"
1758
1759 Overrides:
1760 Virtual domain
1761
1762 "antispam_tag_header_name"
1763
1764 Header field to tag spams
1765
1766 Default:
1767 "X-Spam-Status"
1768
1769 Overrides:
1770 Virtual domain
1771
1772 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
1775 "antispam_tag_header_spam_regexp"
1776
1777 Regular expression to check header field to tag spams
1778
1779 Default:
1780 "^\s*Yes"
1781
1782 Overrides:
1783 Virtual domain
1784
1785 Regular expression applied on this header to verify message is a spam
1786 (example Yes)
1787
1788 "antispam_tag_header_ham_regexp"
1789
1790 Regular expression to determine spam or ham.
1791
1792 Default:
1793 "^\s*No"
1794
1795 Overrides:
1796 Virtual domain
1797
1798 Regular expression applied on this header field to verify message is
1799 NOT a spam (example No)
1800
1801 "spam_status"
1802
1803 Name of header field to inform
1804
1805 Default:
1806 "x-spam-status"
1807
1808 Overrides:
1809 Virtual domain
1810
1811 Value of this parameter is name of "spam_status" scenario.
1812
1813 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
1819 Directories
1820 "home"
1821
1822 List home
1823
1824 Default:
1825 $EXPLDIR
1826
1827 Overrides:
1828 None.
1829
1830 Base directory of list configurations.
1831
1832 "etc"
1833
1834 Directory for configuration files
1835
1836 Default:
1837 $SYSCONFDIR
1838
1839 Overrides:
1840 None.
1841
1842 Base directory of global configuration (except "sympa.conf").
1843
1844 "spool"
1845
1846 Base directory of spools
1847
1848 Default:
1849 $SPOOLDIR
1850
1851 Overrides:
1852 None.
1853
1854 Base directory of all spools which are created at runtime. This
1855 directory must be writable by Sympa user.
1856
1857 "queue"
1858
1859 Directory for message incoming spool
1860
1861 Default:
1862 "$SPOOLDIR/msg"
1863
1864 Overrides:
1865 None.
1866
1867 This spool is used both by "queue" program and "sympa_msg.pl" daemon.
1868
1869 "queuemod"
1870
1871 Directory for moderation spool
1872
1873 Default:
1874 "$SPOOLDIR/moderation"
1875
1876 Overrides:
1877 None.
1878
1879 "queuedigest"
1880
1881 Directory for digest spool
1882
1883 Default:
1884 "$SPOOLDIR/digest"
1885
1886 Overrides:
1887 None.
1888
1889 "queueauth"
1890
1891 Directory for held message spool
1892
1893 Default:
1894 "$SPOOLDIR/auth"
1895
1896 Overrides:
1897 None.
1898
1899 This parameter is named such by historical reason.
1900
1901 "queueoutgoing"
1902
1903 Directory for archive spool
1904
1905 Default:
1906 "$SPOOLDIR/outgoing"
1907
1908 Overrides:
1909 None.
1910
1911 This parameter is named such by historical reason.
1912
1913 "queuesubscribe"
1914
1915 Directory for held request spool
1916
1917 Default:
1918 "$SPOOLDIR/subscribe"
1919
1920 Overrides:
1921 None.
1922
1923 This parameter is named such by historical reason.
1924
1925 "queuetopic"
1926
1927 Directory for topic spool
1928
1929 Default:
1930 "$SPOOLDIR/topic"
1931
1932 Overrides:
1933 None.
1934
1935 "queuebounce"
1936
1937 Directory for bounce incoming spool
1938
1939 Default:
1940 "$SPOOLDIR/bounce"
1941
1942 Overrides:
1943 None.
1944
1945 This spool is used both by "bouncequeue" program and "bounced.pl"
1946 daemon.
1947
1948 "queuetask"
1949
1950 Directory for task spool
1951
1952 Default:
1953 "$SPOOLDIR/task"
1954
1955 Overrides:
1956 None.
1957
1958 "queueautomatic"
1959
1960 Directory for automatic list creation spool
1961
1962 Default:
1963 "$SPOOLDIR/automatic"
1964
1965 Overrides:
1966 None.
1967
1968 This spool is used both by "familyqueue" program and
1969 "sympa_automatic.pl" daemon.
1970
1971 "queuebulk"
1972
1973 Directory for message outgoing spool
1974
1975 Default:
1976 "$SPOOLDIR/bulk"
1977
1978 Overrides:
1979 None.
1980
1981 This parameter is named such by historical reason.
1982
1983 "tmpdir"
1984
1985 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
1989 Default:
1990 "$SPOOLDIR/tmp"
1991
1992 Overrides:
1993 None.
1994
1995 "viewmail_dir"
1996
1997 Directory to cache formatted messages
1998
1999 Default:
2000 "$SPOOLDIR/viewmail"
2001
2002 Overrides:
2003 None.
2004
2005 Base directory path of directories where HTML view of messages are
2006 cached.
2007
2008 "bounce_path"
2009
2010 Directory for storing bounces
2011
2012 Default:
2013 $BOUNCEDIR
2014
2015 Overrides:
2016 None.
2017
2018 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
2024 Users can access to these messages using web interface in the bounce
2025 management page.
2026
2027 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
2031 "arc_path"
2032
2033 Directory for storing archives
2034
2035 Default:
2036 $ARCDIR
2037
2038 Overrides:
2039 Virtual domain
2040
2041 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
2046 "purge_spools_task"
2047
2048 Task for cleaning spools
2049
2050 Default:
2051 "daily"
2052
2053 Overrides:
2054 None.
2055
2056 This task cleans old content in spools.
2057
2058 "clean_delay_queue"
2059
2060 Max age of incoming bad messages
2061
2062 Default:
2063 7 (days)
2064
2065 Overrides:
2066 None.
2067
2068 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
2072 "clean_delay_queueoutgoing"
2073
2074 Max age of bad messages for archives
2075
2076 Default:
2077 7 (days)
2078
2079 Overrides:
2080 None.
2081
2082 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
2087 "clean_delay_queuebounce"
2088
2089 Max age of bad bounce messages
2090
2091 Default:
2092 7 (days)
2093
2094 Overrides:
2095 None.
2096
2097 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
2101 "clean_delay_queuemod"
2102
2103 Max age of moderated messages
2104
2105 Default:
2106 30 (days)
2107
2108 Overrides:
2109 List
2110
2111 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
2115 "clean_delay_queueauth"
2116
2117 Max age of held messages
2118
2119 Default:
2120 30 (days)
2121
2122 Overrides:
2123 None.
2124
2125 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
2129 "clean_delay_queuesubscribe"
2130
2131 Max age of held requests
2132
2133 Default:
2134 30 (days)
2135
2136 Overrides:
2137 None.
2138
2139 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
2143 "clean_delay_queuetopic"
2144
2145 Max age of tagged topics
2146
2147 Default:
2148 30 (days)
2149
2150 Overrides:
2151 None.
2152
2153 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
2157 "clean_delay_queueautomatic"
2158
2159 Max age of incoming bad messages in automatic list creation spool
2160
2161 Default:
2162 10 (days)
2163
2164 Overrides:
2165 None.
2166
2167 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
2171 "clean_delay_queuebulk"
2172
2173 Max age of outgoing bad messages
2174
2175 Default:
2176 7 (days)
2177
2178 Overrides:
2179 None.
2180
2181 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
2186 "clean_delay_queuedigest"
2187
2188 Max age of bad messages in digest spool
2189
2190 Default:
2191 14 (days)
2192
2193 Overrides:
2194 None.
2195
2196 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
2200 "clean_delay_tmpdir"
2201
2202 Max age of temporary files
2203
2204 Default:
2205 7 (days)
2206
2207 Overrides:
2208 None.
2209
2210 Number of days files in temporary directory (as specified by "tmpdir"
2211 parameter), including standard error logs, are kept.
2212
2213 Miscellaneous
2214 "email"
2215
2216 Local part of Sympa email address
2217
2218 Default:
2219 "sympa"
2220
2221 Overrides:
2222 Virtual domain
2223
2224 Local part (the part preceding the "@" sign) of the address by which
2225 mail interface of Sympa accepts mail commands.
2226
2227 If you change the default value, you must modify the mail aliases too.
2228
2229 "listmaster_email"
2230
2231 Local part of listmaster email address
2232
2233 Default:
2234 "listmaster"
2235
2236 Overrides:
2237 Virtual domain
2238
2239 Local part (the part preceding the "@" sign) of the address by which
2240 listmasters receive messages.
2241
2242 If you change the default value, you must modify the mail aliases too.
2243
2244 "custom_robot_parameter"
2245
2246 Custom robot parameter
2247
2248 Default:
2249 None.
2250
2251 Overrides:
2252 Virtual domain
2253
2254 Used to define a custom parameter for your server. Do not forget the
2255 semicolon between the parameter name and the parameter value.
2256
2257 You will be able to access the custom parameter value in web templates
2258 by variable "conf.custom_robot_parameter.<param_name>"
2259
2260 Example:
2261
2262 custom_robot_parameter param_name ; param_value
2263
2264 "cache_list_config"
2265
2266 Use of binary cache of list configuration
2267
2268 Default:
2269 "none"
2270
2271 Overrides:
2272 None.
2273
2274 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
2279 You can recreate cache by running "sympa.pl --reload_list_config".
2280
2281 "db_list_cache"
2282
2283 Use database cache to search lists
2284
2285 Default:
2286 "off"
2287
2288 Overrides:
2289 None.
2290
2291 Note that "list_table" database table should be filled at the first
2292 time by running:
2293
2294 # sympa.pl --sync_list_db
2295
2296 "purge_user_table_task"
2297
2298 Task for expiring inactive users
2299
2300 Default:
2301 "monthly"
2302
2303 Overrides:
2304 None.
2305
2306 This task removes rows in the "user_table" table which have not
2307 corresponding entries in the "subscriber_table" table.
2308
2309 "purge_logs_table_task"
2310
2311 Task for cleaning tables
2312
2313 Default:
2314 "daily"
2315
2316 Overrides:
2317 None.
2318
2319 This task cleans old logs from "logs_table" table.
2320
2321 "logs_expiration_period"
2322
2323 Max age of logs in database
2324
2325 Default:
2326 3 (months)
2327
2328 Overrides:
2329 None.
2330
2331 Number of months that elapse before a log is expired
2332
2333 "stats_expiration_period"
2334
2335 Max age of statistics information in database
2336
2337 Default:
2338 3 (months)
2339
2340 Overrides:
2341 None.
2342
2343 Number of months that elapse before statistics information are expired
2344
2345 "umask"
2346
2347 Umask
2348
2349 Default:
2350 027
2351
2352 Overrides:
2353 None.
2354
2355 Default mask for file creation (see umask(2)). Note that it will be
2356 interpreted as an octal value.
2357
2358 "cookie"
2359
2360 Secret string for generating unique keys
2361
2362 Default:
2363 None.
2364
2365 Overrides:
2366 List
2367
2368 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
2373 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
2378 Example:
2379
2380 cookie 123456789
2381
2382 Web interface parameters
2383 "wwsympa_url"
2384
2385 URL prefix of web interface
2386
2387 Default:
2388 None.
2389
2390 Overrides:
2391 Virtual domain
2392
2393 This is used to construct URLs of web interface.
2394
2395 Example:
2396
2397 wwsympa_url https://web.example.org/sympa
2398
2399 "http_host"
2400
2401 URL prefix of WWSympa behind proxy
2402
2403 Default:
2404 None.
2405
2406 Overrides:
2407 Virtual domain
2408
2409 "static_content_url"
2410
2411 URL for static contents
2412
2413 Default:
2414 "/static-sympa"
2415
2416 Overrides:
2417 Virtual domain
2418
2419 HTTP server have to map it with "static_content_path" directory.
2420
2421 "static_content_path"
2422
2423 Directory for static contents
2424
2425 Default:
2426 $STATICDIR
2427
2428 Overrides:
2429 Virtual domain
2430
2431 "log_facility"
2432
2433 System log facility for web interface
2434
2435 Default:
2436 "LOCAL1"
2437
2438 Overrides:
2439 None.
2440
2441 System log facility for WWSympa, archived.pl and bounced.pl. Default is
2442 to use value of "syslog" parameter.
2443
2444 Web interface parameters: Appearances
2445 "logo_html_definition"
2446
2447 Custom logo
2448
2449 Default:
2450 None.
2451
2452 Overrides:
2453 Virtual domain
2454
2455 HTML fragment to insert a logo in the page of web interface.
2456
2457 Example:
2458
2459 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
2461 "favicon_url"
2462
2463 Custom favicon
2464
2465 Default:
2466 None.
2467
2468 Overrides:
2469 Virtual domain
2470
2471 URL of favicon image
2472
2473 "css_path"
2474
2475 Directory for static style sheets (CSS)
2476
2477 Default:
2478 $CSSDIR
2479
2480 Overrides:
2481 None.
2482
2483 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
2487 "css_url"
2488
2489 URL for style sheets (CSS)
2490
2491 Default:
2492 "/static-sympa/css"
2493
2494 Overrides:
2495 None.
2496
2497 To use auto-generated static CSS, HTTP server have to map it with
2498 "css_path".
2499
2500 "pictures_path"
2501
2502 Directory for subscribers pictures
2503
2504 Default:
2505 $PICTURESDIR
2506
2507 Overrides:
2508 None.
2509
2510 "pictures_url"
2511
2512 URL for subscribers pictures
2513
2514 Default:
2515 "/static-sympa/pictures"
2516
2517 Overrides:
2518 None.
2519
2520 HTTP server have to map it with "pictures_path" directory.
2521
2522 "color_0", ..., "color_15"
2523
2524 Colors for web interface
2525
2526 Default:
2527 See description on web interface.
2528
2529 Overrides:
2530 Virtual domain
2531
2532 Colors are used in style sheet (CSS). They may be changed using web
2533 interface by listmasters.
2534
2535 "dark_color", "light_color", "text_color", "bg_color", "error_color",
2536 "selected_color", "shaded_color"
2537
2538 Colors for web interface, obsoleted
2539
2540 Default:
2541 See description on web interface.
2542
2543 Overrides:
2544 Virtual domain
2545
2546 "default_home"
2547
2548 Type of main web page
2549
2550 Default:
2551 "home"
2552
2553 Overrides:
2554 Virtual domain
2555
2556 "lists" for the page of list of lists. "home" for home page.
2557
2558 "archive_default_index"
2559
2560 Default index organization of web archive
2561
2562 Default:
2563 "thrd"
2564
2565 Overrides:
2566 None.
2567
2568 thrd: Threaded index.
2569
2570 mail: Chronological index.
2571
2572 "review_page_size"
2573
2574 Size of review page
2575
2576 Default:
2577 25
2578
2579 Overrides:
2580 Virtual domain
2581
2582 Default number of lines of the array displaying users in the review
2583 page
2584
2585 "viewlogs_page_size"
2586
2587 Size of viewlogs page
2588
2589 Default:
2590 25
2591
2592 Overrides:
2593 Virtual domain
2594
2595 Default number of lines of the array displaying the log entries in the
2596 logs page.
2597
2598 "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
2603 Custom menus
2604
2605 Default:
2606 None.
2607
2608 Overrides:
2609 Virtual domain
2610
2611 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
2616 Example:
2617
2618 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
2622 Web interface parameters: Miscellaneous
2623 "cookie_domain"
2624
2625 HTTP cookies validity domain
2626
2627 Default:
2628 "localhost"
2629
2630 Overrides:
2631 Virtual domain
2632
2633 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
2639 Example:
2640
2641 cookie_domain .renater.fr
2642
2643 "cookie_expire"
2644
2645 HTTP cookies lifetime
2646
2647 Default:
2648 0
2649
2650 Overrides:
2651 None.
2652
2653 This is the default value when not set explicitly by users. "0" means
2654 the cookie may be retained during browser sessions.
2655
2656 "cookie_refresh"
2657
2658 Average interval to refresh HTTP session ID.
2659
2660 Default:
2661 60
2662
2663 Overrides:
2664 None.
2665
2666 "purge_session_table_task"
2667
2668 Task for cleaning old sessions
2669
2670 Default:
2671 "daily"
2672
2673 Overrides:
2674 None.
2675
2676 This task removes old entries in the "session_table" table.
2677
2678 "session_table_ttl"
2679
2680 Max age of sessions
2681
2682 Default:
2683 "2d"
2684
2685 Overrides:
2686 None.
2687
2688 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
2693 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
2697 "anonymous_session_table_ttl"
2698
2699 Default:
2700 "1h"
2701
2702 Overrides:
2703 None.
2704
2705 "shared_feature"
2706
2707 Enable shared repository
2708
2709 Default:
2710 "off"
2711
2712 Overrides:
2713 Virtual domain
2714
2715 If set to "on", list owners can open shared repository.
2716
2717 "default_shared_quota"
2718
2719 Default disk quota for shared repository
2720
2721 Default:
2722 None (Kbytes).
2723
2724 Overrides:
2725 Virtual domain
2726
2727 List ("shared_doc.quota")
2728
2729 "use_html_editor"
2730
2731 Use HTML editor
2732
2733 Default:
2734 0
2735
2736 Overrides:
2737 Virtual domain
2738
2739 If set to "on", users will be able to post messages in HTML using a
2740 javascript WYSIWYG editor.
2741
2742 Example:
2743
2744 use_html_editor on
2745
2746 "html_editor_url"
2747
2748 URL of HTML editor
2749
2750 Default:
2751 None.
2752
2753 Overrides:
2754 Virtual domain
2755
2756 URL path to the javascript file making the WYSIWYG HTML editor
2757 available. Relative path under <static_content_url> or absolute path.
2758
2759 Example is for TinyMCE 4 installed under
2760 <static_content_path>/js/tinymce/.
2761
2762 Example:
2763
2764 html_editor_url js/tinymce/tinymce.min.js
2765
2766 "html_editor_init"
2767
2768 HTML editor initialization
2769
2770 Default:
2771 None.
2772
2773 Overrides:
2774 Virtual domain
2775
2776 Javascript excerpt that enables and configures the WYSIWYG HTML editor.
2777
2778 Example:
2779
2780 html_editor_init tinymce.init({selector:"#body",language:lang.split(/[^a-zA-Z]+/).join("_")});
2781
2782 "max_wrong_password"
2783
2784 Count limit of wrong password submission
2785
2786 Default:
2787 19
2788
2789 Overrides:
2790 Virtual domain
2791
2792 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
2798 "password_case"
2799
2800 Password case
2801
2802 Default:
2803 "insensitive"
2804
2805 Overrides:
2806 None.
2807
2808 "insensitive" or "sensitive".
2809
2810 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
2814 Should not be changed! May invalid all user password.
2815
2816 "password_hash"
2817
2818 Password hashing algorithm
2819
2820 Default:
2821 "md5"
2822
2823 Overrides:
2824 None.
2825
2826 "md5" or "bcrypt".
2827
2828 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
2832 Should not be changed! May invalid all user passwords.
2833
2834 "password_hash_update"
2835
2836 Update password hashing algorithm when users log in
2837
2838 Default:
2839 1
2840
2841 Overrides:
2842 None.
2843
2844 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
2850 "bcrypt_cost"
2851
2852 Bcrypt hash cost
2853
2854 Default:
2855 12
2856
2857 Overrides:
2858 None.
2859
2860 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
2866 Can be changed but any new cost setting will only apply to new
2867 passwords.
2868
2869 "one_time_ticket_lifetime"
2870
2871 Age of one time ticket
2872
2873 Default:
2874 "2d"
2875
2876 Overrides:
2877 None.
2878
2879 Duration before the one time tickets are expired
2880
2881 "one_time_ticket_lockout"
2882
2883 Restrict access to one time ticket
2884
2885 Default:
2886 "one_time"
2887
2888 Overrides:
2889 Virtual domain
2890
2891 Is access to the one time ticket restricted, if any users previously
2892 accessed? (one_time | remote_addr | open)
2893
2894 "purge_one_time_ticket_table_task"
2895
2896 Default:
2897 "daily"
2898
2899 Overrides:
2900 None.
2901
2902 "one_time_ticket_table_ttl"
2903
2904 Default:
2905 "10d"
2906
2907 Overrides:
2908 None.
2909
2910 "pictures_feature"
2911
2912 Pictures
2913
2914 Default:
2915 "on"
2916
2917 Overrides:
2918 Virtual domain
2919
2920 List
2921
2922 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
2926 Pictures are stored in a directory specified by the
2927 "static_content_path" parameter.
2928
2929 "pictures_max_size"
2930
2931 The maximum size of uploaded picture
2932
2933 Default:
2934 102400 (bytes)
2935
2936 Overrides:
2937 Virtual domain
2938
2939 "spam_protection"
2940
2941 Protect web interface against spam harvesters
2942
2943 Default:
2944 "javascript"
2945
2946 Overrides:
2947 Virtual domain
2948
2949 These values are supported:
2950
2951 javascript: the address is hidden using a javascript. Users who enable
2952 Javascript can see nice mailto addresses where others have nothing.
2953
2954 at: the "@" character is replaced by the string "AT".
2955
2956 none: no protection against spam harvesters.
2957
2958 "web_archive_spam_protection"
2959
2960 Protect web archive against spam harvesters
2961
2962 Default:
2963 "cookie"
2964
2965 Overrides:
2966 Virtual domain
2967
2968 List
2969
2970 The same as "spam_protection", but restricted to the web archive.
2971
2972 In addition to it:
2973
2974 cookie: users must submit a small form in order to receive a cookie
2975 before browsing the web archive.
2976
2977 gecos:
2978
2979 only gecos is displayed.
2980
2981 "reporting_spam_script_path"
2982
2983 Script to report spam
2984
2985 Default:
2986 None.
2987
2988 Overrides:
2989 Virtual domain
2990
2991 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
2995 "domains_blacklist"
2996
2997 Prevent people to subscribe to a list with adresses using these domains
2998
2999 Default:
3000 None.
3001
3002 Overrides:
3003 None.
3004
3005 This parameter is a comma-separated list.
3006
3007 Example:
3008
3009 domains_blacklist example.org,spammer.com
3010
3011 "quiet_subscription"
3012
3013 Quiet subscriptions policy
3014
3015 Default:
3016 "optional"
3017
3018 Overrides:
3019 None.
3020
3021 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
3025 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
3029 TLS client authentication. It requires an external module: IO-Socket-
3030 SSL.
3031
3032 "cafile"
3033
3034 File containing trusted CA certificates
3035
3036 Default:
3037 None.
3038
3039 Overrides:
3040 None.
3041
3042 This can be used alternatively and/or additionally to "capath".
3043
3044 Example:
3045
3046 cafile /etc/pki/tls/certs/ca-bundle.crt
3047
3048 "capath"
3049
3050 Directory containing trusted CA certificates
3051
3052 Default:
3053 None.
3054
3055 Overrides:
3056 None.
3057
3058 CA certificates in this directory are used for client authentication.
3059
3060 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
3064 Example:
3065
3066 capath /etc/pki/tls/certs
3067
3068 "key_passwd"
3069
3070 Password used to crypt lists private keys
3071
3072 Default:
3073 None.
3074
3075 Overrides:
3076 None.
3077
3078 If not defined, Sympa assumes that list private keys are not encrypted.
3079
3080 Example:
3081
3082 key_passwd your_password
3083
3084 "ssl_cert_dir"
3085
3086 Directory containing user certificates
3087
3088 Default:
3089 "$EXPLDIR/X509-user-certs"
3090
3091 Overrides:
3092 None.
3093
3094 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
3101 "default_sql_fetch_timeout"
3102
3103 Default of SQL fetch timeout
3104
3105 Default:
3106 300
3107
3108 Overrides:
3109 List ("sql_fetch_timeout")
3110
3111 Default timeout while performing a fetch with include_sql_query.
3112
3113 "default_ttl"
3114
3115 Default of inclusion timeout
3116
3117 Default:
3118 3600
3119
3120 Overrides:
3121 List ("ttl")
3122
3123 Default timeout between two scheduled synchronizations of list members
3124 with data sources.
3125
3126 DKIM and ARC
3127 DKIM signature verification and re-signing. It requires an external
3128 module: Mail-DKIM.
3129
3130 ARC seals on forwarded messages. It requires an external module: Mail-
3131 DKIM.
3132
3133 "dkim_feature"
3134
3135 Enable DKIM
3136
3137 Default:
3138 "off"
3139
3140 Overrides:
3141 Virtual domain
3142
3143 List
3144
3145 If set to "on", Sympa may verify DKIM signatures of incoming messages
3146 and/or insert DKIM signature to outgoing messages.
3147
3148 "dkim_add_signature_to"
3149
3150 Which service messages to be signed
3151
3152 Default:
3153 "robot,list"
3154
3155 Overrides:
3156 Virtual domain
3157
3158 Inserts a DKIM signature to service messages in context of robot, list
3159 or both
3160
3161 "dkim_private_key_path"
3162
3163 File path for DKIM private key
3164
3165 Default:
3166 None.
3167
3168 Overrides:
3169 Virtual domain
3170
3171 List ("dkim_parameters.private_key_path")
3172
3173 The file must contain a PEM encoded private key
3174
3175 "dkim_signature_apply_on"
3176
3177 Which messages delivered via lists to be signed
3178
3179 Default:
3180 "md5_authenticated_messages,smime_authenticated_messages,dkim_authenticated_messages,editor_validated_messages"
3181
3182 Overrides:
3183 Virtual domain
3184
3185 List
3186
3187 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
3193 "dkim_signer_domain"
3194
3195 The "d=" tag as defined in rfc 4871
3196
3197 Default:
3198 None.
3199
3200 Overrides:
3201 Virtual domain
3202
3203 List ("dkim_parameters.signer_domain")
3204
3205 The DKIM "d=" tag is the domain of the signing entity. The virtual host
3206 domain name is used as its default value
3207
3208 "dkim_signer_identity"
3209
3210 The "i=" tag as defined in rfc 4871
3211
3212 Default:
3213 None.
3214
3215 Overrides:
3216 Virtual domain
3217
3218 Default is null.
3219
3220 "dkim_selector"
3221
3222 Selector for DNS lookup of DKIM public key
3223
3224 Default:
3225 None.
3226
3227 Overrides:
3228 Virtual domain
3229
3230 List ("dkim_parameters.selector")
3231
3232 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
3236 "arc_feature"
3237
3238 Enable ARC
3239
3240 Default:
3241 "off"
3242
3243 Overrides:
3244 Virtual domain
3245
3246 List
3247
3248 If set to "on", Sympa may add ARC seals to outgoing messages.
3249
3250 "arc_srvid"
3251
3252 SRV ID for Authentication-Results used in ARC seal
3253
3254 Default:
3255 None.
3256
3257 Overrides:
3258 Virtual domain
3259
3260 Typically the domain of the mail server
3261
3262 "arc_signer_domain"
3263
3264 The "d=" tag as defined in ARC
3265
3266 Default:
3267 None.
3268
3269 Overrides:
3270 Virtual domain
3271
3272 List ("arc_parameters.arc_signer_domain")
3273
3274 The ARC "d=" tag is the domain of the signing entity. The DKIM d=
3275 domain name is used as its default value
3276
3277 "arc_selector"
3278
3279 Selector for DNS lookup of ARC public key
3280
3281 Default:
3282 None.
3283
3284 Overrides:
3285 Virtual domain
3286
3287 List ("arc_parameters.arc_selector")
3288
3289 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
3294 "arc_private_key_path"
3295
3296 File path for ARC private key
3297
3298 Default:
3299 None.
3300
3301 Overrides:
3302 Virtual domain
3303
3304 List ("arc_parameters.arc_private_key_path")
3305
3306 The file must contain a PEM encoded private key. Defaults to same file
3307 as DKIM private key
3308
3309 DMARC protection
3310 Processes originator addresses to avoid some domains' excessive DMARC
3311 protection. This feature requires an external module: Net-DNS.
3312
3313 "dmarc_protection_mode"
3314
3315 Test mode(s) for DMARC Protection
3316
3317 Default:
3318 None.
3319
3320 Overrides:
3321 Virtual domain
3322
3323 List ("dmarc_protection.mode")
3324
3325 Do not set unless you want to use DMARC protection.
3326
3327 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
3332 Example:
3333
3334 dmarc_protection_mode dmarc_reject,dkim_signature
3335
3336 "dmarc_protection_domain_regex"
3337
3338 Regular expression for domain name match
3339
3340 Default:
3341 None.
3342
3343 Overrides:
3344 Virtual domain
3345
3346 List ("dmarc_protection.domain_regex")
3347
3348 This is used for the "domain_regex" protection mode.
3349
3350 "dmarc_protection_phrase"
3351
3352 New From name format
3353
3354 Default:
3355 "name_via_list"
3356
3357 Overrides:
3358 Virtual domain
3359
3360 List ("dmarc_protection.phrase")
3361
3362 This is the format to be used for the sender name part of the new From
3363 header field.
3364
3365 "dmarc_protection_other_email"
3366
3367 New From address
3368
3369 Default:
3370 None.
3371
3372 Overrides:
3373 Virtual domain
3374
3375 List ("dmarc_protection.other_email")
3376
3377 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
3382 "list_check_helo"
3383
3384 SMTP HELO (EHLO) parameter used for address verification
3385
3386 Default:
3387 None.
3388
3389 Overrides:
3390 Virtual domain
3391
3392 Default value is the host part of "list_check_smtp" parameter.
3393
3394 "list_check_smtp"
3395
3396 SMTP server to verify existence of the same addresses as the list to be
3397 created
3398
3399 Default:
3400 None.
3401
3402 Overrides:
3403 Virtual domain
3404
3405 This is needed if you are running Sympa on a host but you handle all
3406 your mail on a separate mail relay.
3407
3408 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
3412 "list_check_suffixes"
3413
3414 Address suffixes to verify
3415
3416 Default:
3417 "request,owner,editor,unsubscribe,subscribe"
3418
3419 Overrides:
3420 Virtual domain
3421
3422 List of suffixes you are using for list addresses, i.e. "mylist-
3423 request", "mylist-owner" and so on.
3424
3425 This parameter is used with the "list_check_smtp" parameter. It is also
3426 used to check list names at list creation time.
3427
3428 Antivirus plug-in
3429 "antivirus_path"
3430
3431 Path to the antivirus scanner engine
3432
3433 Default:
3434 None.
3435
3436 Overrides:
3437 Virtual domain
3438
3439 Supported antivirus: Clam AntiVirus/clamscan & clamdscan,
3440 McAfee/uvscan, Fsecure/fsav, Sophos, AVP and Trend Micro/VirusWall
3441
3442 Example:
3443
3444 antivirus_path /usr/local/bin/clamscan
3445
3446 "antivirus_args"
3447
3448 Antivirus plugin command line arguments
3449
3450 Default:
3451 None.
3452
3453 Overrides:
3454 Virtual domain
3455
3456 Example:
3457
3458 antivirus_args --no-summary --database /usr/local/share/clamav
3459
3460 "antivirus_notify"
3461
3462 Notify sender if virus checker detects malicious content
3463
3464 Default:
3465 "sender"
3466
3467 Overrides:
3468 Virtual domain
3469
3470 "sender" to notify originator of the message, "delivery_status" to send
3471 delivery status, or "none"
3472
3473 Password validation
3474 Checks if the password the user submitted has sufficient strength. This
3475 feature requires an external module: Data-Password.
3476
3477 "password_validation"
3478
3479 Password validation
3480
3481 Default:
3482 None.
3483
3484 Overrides:
3485 None.
3486
3487 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
3491 Example:
3492
3493 password_validation MINLEN=8,GROUPS=3,DICTIONARY=4,DICTIONARIES=/pentest/dictionaries
3494
3495 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
3500 "ldap_force_canonical_email"
3501
3502 Use canonical email address for LDAP authentication
3503
3504 Default:
3505 1
3506
3507 Overrides:
3508 Virtual domain
3509
3510 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
3515 SOAP HTTP interface
3516 Provides some functions of Sympa through the SOAP HTTP interface. This
3517 feature requires an external module: SOAP-Lite.
3518
3519 "soap_url"
3520
3521 URL of SympaSOAP
3522
3523 Default:
3524 None.
3525
3526 Overrides:
3527 Virtual domain
3528
3529 WSDL document of SympaSOAP refers to this URL in its service section.
3530
3531 Example:
3532
3533 soap_url http://web.example.org/sympasoap
3534
3535 "soap_url_local"
3536
3537 URL of SympaSOAP behind proxy
3538
3539 Default:
3540 None.
3541
3542 Overrides:
3543 Virtual domain
3544
3545 Obsoleted parameters
3546 "host"
3547
3548 Default:
3549 None.
3550
3551 Overrides:
3552 Virtual domain
3553
3554 "log_condition"
3555
3556 Default:
3557 None.
3558
3559 Overrides:
3560 Virtual domain
3561
3562 "log_module"
3563
3564 Default:
3565 None.
3566
3567 Overrides:
3568 Virtual domain
3569
3570 "filesystem_encoding"
3571
3572 Default:
3573 "utf-8"
3574
3575 Overrides:
3576 None.
3577
3578 "automatic_list_prefix"
3579
3580 Defines the prefix allowing to recognize that a list is an automatic
3581 list.
3582
3583 Default:
3584 None.
3585
3586 Overrides:
3587 None.
3588
3589 "default_distribution_ttl"
3590
3591 Default timeout between two action-triggered synchronizations of list
3592 members with data sources.
3593
3594 Default:
3595 300
3596
3597 Overrides:
3598 None.
3599
3600 "edit_list"
3601
3602 Default:
3603 "owner"
3604
3605 Overrides:
3606 None.
3607
3608 "use_fast_cgi"
3609
3610 Enable FastCGI
3611
3612 Default:
3613 1
3614
3615 Overrides:
3616 None.
3617
3618 Is FastCGI module for HTTP server installed? This module provides a
3619 much faster web interface.
3620
3621 "htmlarea_url"
3622
3623 Default:
3624 None.
3625
3626 Overrides:
3627 None.
3628
3629 "show_report_abuse"
3630
3631 Add a "Report abuse" link in the side menu of the lists (0|1)
3632
3633 Default:
3634 0
3635
3636 Overrides:
3637 None.
3638
3639 The link is a mailto link, you can change that by overriding
3640 web_tt2/report_abuse.tt2
3641
3642 "allow_account_deletion"
3643
3644 EXPERIMENTAL! Allow users to delete their account. If enabled, shows a
3645 "delete my account" form in user's preferences page.
3646
3647 Default:
3648 0
3649
3650 Overrides:
3651 None.
3652
3653 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
3662 $SYSCONFDIR/<robot name>/robot.conf
3663 Configuration specific to each virtual domain.
3664
3665 $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/>.
3671
3672
3673
36746.2.48 2019-11-29 SYMPA.CONF(5)