Next:
1. Presentation
Up:
Sympa Mailing Lists Management Software version
Previous:
Sympa Mailing Lists Management Software version
Index
Contents
1. Presentation
1.1 License
1.2 Features
1.3 Project directions
1.4 History
1.5 Authors and credits
1.6 Mailing lists and support
2. what does Sympa consist of ?
2.1 Organization
2.2 Binaries
2.3 Configuration files
2.4 Spools
2.5 Roles and privileges
2.5.1 (Super) listmasters
2.5.2 (Robot) listmasters
2.5.3 Privileged list owners
2.5.4 (Basic) list owners
2.5.5 Moderators (also called Editors)
2.5.6 Subscribers (or list members)
3. Installing Sympa
3.1 Obtaining Sympa, related links
3.2 Prerequisites
3.2.1 System requirements
3.2.2 Install Berkeley DB (NEWDB)
3.2.3 Install PERL and CPAN modules
3.2.4 Required CPAN modules
3.2.5 Create a UNIX user
3.3 Compilation and installation
3.3.1 Choosing directory locations
3.4 Robot aliases
3.5 Logs
4. Running Sympa
4.1 sympa.pl
4.2 INIT script
4.3 Stopping Sympa and signals
5. Upgrading Sympa
5.1 Incompatible changes
5.2 CPAN modules update
5.3 Database structure update
5.4 Preserving your customizations
5.5 Running 2 Sympa versions on a single server
5.6 Moving to another server
6. Mail aliases
6.1 Robot aliases
6.2 List aliases
6.3 Alias manager
6.4 Virtual domains
7. sympa.conf parameters
7.1 Site customization
7.1.1 domain
7.1.2 email
7.1.3 listmaster
7.1.4 listmaster_email
7.1.5 wwsympa_url
7.1.6 soap_url
7.1.7 spam_protection
7.1.8 web_archive_spam_protection
7.1.9 color_0, color_1 .. color_15
7.1.10 dark_color, light_color, text_color, bg_color, error_color, selected_color, shaded_color
7.1.11 logo_html_definition
7.1.12 css_path
7.1.13 css_url
7.1.14 static_content_path
7.1.15 static_content_url
7.1.16 pictures_feature
7.1.17 pictures_max_size
7.1.18 cookie
7.1.19 create_list
7.1.20 automatic_list_feature
7.1.21 automatic_list_creation
7.1.22 automatic_list_removal
7.1.23 global_remind
7.2 Directories
7.2.1 home
7.2.2 etc
7.3 System related
7.3.1 syslog
7.3.2 log_level
7.3.3 log_socket_type
7.3.4 pidfile
7.3.5 pidfile_creation
7.3.6 umask
7.4 Sending related
7.4.1 distribution_mode
7.4.2 maxsmtp
7.4.3 log_smtp
7.4.4 use_blacklist
7.4.5 max_size
7.4.6 misaddressed_commands
7.4.7 misaddressed_commands_regexp
7.4.8 nrcpt
7.4.9 avg
7.4.10 sendmail
7.4.11 sendmail_args
7.4.12 sendmail_aliases
7.4.13 rfc2369_header_fields
7.4.14 remove_headers
7.4.15 anonymous_headers_fields
7.4.16 list_check_smtp
7.4.17 list_check_suffixes
7.4.18 urlize_min_size
7.5 Quotas
7.5.1 default_shared_quota
7.5.2 default_archive_quota
7.6 Spool related
7.6.1 spool
7.6.2 queue
7.6.3 queuedistribute
7.6.4 queuemod
7.6.5 queuedigest
7.6.6 queueauth
7.6.7 queueoutgoing
7.6.8 queuetopic
7.6.9 queuebounce
7.6.10 queuetask
7.6.11 queueautomatic
7.6.12 tmpdir
7.6.13 sleep
7.6.14 clean_delay_queue
7.6.15 clean_delay_queuemod
7.6.16 clean_delay_queueauth
7.6.17 clean_delay_queuesubscribe
7.6.18 clean_delay_queuetopic
7.6.19 clean_delay_queueautomatic
7.7 Internationalization related
7.7.1 localedir
7.7.2 supported_lang
7.7.3 lang
7.7.4 web_recode_to
7.7.5 filesystem_encoding
7.8 Bounce related
7.8.1 verp_rate
7.8.2 welcome_return_path
7.8.3 remind_return_path
7.8.4 return_path_suffix
7.8.5 expire_bounce_task
7.8.6 purge_orphan_bounces_task
7.8.7 eval_bouncers_task
7.8.8 process_bouncers_task
7.8.9 minimum_bouncing_count
7.8.10 minimum_bouncing_period
7.8.11 bounce_delay
7.8.12 default_bounce_level1_rate
7.8.13 default_bounce_level2_rate
7.8.14 bounce_email_prefix
7.8.15 bounce_warn_rate
7.8.16 bounce_halt_rate
7.8.17 default_remind_task
7.9 Tuning
7.9.1 cache_list_config
7.9.2 sympa_priority
7.9.3 request_priority
7.9.4 owner_priority
7.9.5 default_list_priority
7.10 Database related
7.10.1 update_db_field_types
7.10.2 db_type
7.10.3 db_name
7.10.4 db_host
7.10.5 db_port
7.10.6 db_user
7.10.7 db_passwd
7.10.8 db_timeout
7.10.9 db_options
7.10.10 db_env
7.10.11 db_additional_subscriber_fields
7.10.12 db_additional_user_fields
7.10.13 purge_user_table_task
7.11 Loop prevention
7.11.1 loop_command_max
7.11.2 loop_command_sampling_delay
7.11.3 loop_command_decrease_factor
7.11.4 loop_prevention_regex
7.12 S/MIME configuration
7.12.1 openssl
7.12.2 capath
7.12.3 cafile
7.12.4 key_passwd
7.12.5 chk_cert_expiration_task
7.12.6 crl_update_task
7.13 Antivirus plug-in
7.13.1 antivirus_path
7.13.2 antivirus_args
7.13.3 antivirus_notify
8. Sympa and its database
8.1 Prerequisites
8.2 Installing PERL modules
8.3 Creating a sympa DataBase
8.3.1 Database structure
8.3.2 Database creation
8.4 Setting database privileges
8.5 Importing subscribers data
8.5.1 Importing data from a text file
8.5.2 Importing data from subscribers files
8.6 Management of the include cache
8.7 Extending database table format
8.8 Sympa configuration
9. WWSympa, Sympa's web interface
9.1 Organization
9.2 Web server setup
9.2.1 wwsympa.fcgi access permissions
9.2.2 Installing wwsympa.fcgi in your Apache server
9.2.3 Using FastCGI
9.3 wwsympa.conf parameters
9.3.1 arc_path
9.3.2 archive_default_index thrd | mail
9.3.3 archived_pidfile
9.3.4 bounce_path
9.3.5 bounced_pidfile
9.3.6 cookie_expire
9.3.7 cookie_domain
9.3.8 default_home
9.3.9 icons_url
9.3.10 log_facility
9.3.11 mhonarc
9.3.12 htmlarea_url
9.3.13 password_case sensitive | insensitive
9.3.14 title
9.3.15 use_fast_cgi 0 | 1
9.4 MhOnArc
9.5 Archiving daemon
9.6 Database configuration
9.7 Logging in as listmaster
10. Sympa Internationalization
10.1 Catalogs and templates
10.2 Translating Sympa GUI in your language
10.3 Defining language-specific templates
10.4 Translating topics titles
10.5 Handling of encodings
11. Sympa RSS channel
11.1 latest_lists
11.2 active_lists
11.3 latest_arc
11.4 latest_d_read
12. Sympa SOAP server
12.1 Introduction
12.2 Web server setup
12.3 Sympa setup
12.4 trust remote application
12.5 The WSDL service description
12.6 Client-side programming
12.6.1 Writing a Java client with Axis
13. Authentication
13.1 S/MIME and HTTPS authentication
13.2 Authentication with email address, uid or alternate email address
13.3 Generic SSO authentication
13.4 CAS-based authentication
13.5 auth.conf
13.5.1 user_table paragraph
13.5.2 ldap paragraph
13.5.3 generic_sso paragraph
13.5.4 cas paragraph
13.6 Sharing WWSympa authentication with other applications
13.7 Provide a Sympa login form in another application
14. Authorization scenarios
14.1 rules specifications
14.2 Named Filters
14.2.1 LDAP Named Filters Definition
14.2.2 SQL Named Filters Definition
14.2.3 Search Condition
14.3 scenario inclusion
14.4 blacklist implicit rule
14.5 Custom perl package conditions
14.6 Hidding scenario files
15. virtual host
15.1 How to create a virtual host
15.2 robot.conf
15.2.1 Robot customization
15.3 Managing multiple virtual hosts
16. Interaction between Sympa and other applications
16.1 Soap
16.2 RSS channel
16.3 Sharing WWSympa authentication with other applications
16.4 Sharing data with other applications
16.5 Subscriber count
17. Customizing Sympa/WWSympa
17.1 Template file format
17.2 Site template files
17.2.1 helpfile.tt2
17.2.2 lists.tt2
17.2.3 global_remind.tt2
17.2.4 your_infected_msg.tt2
17.3 Web template files
17.4 Internationalization
17.4.1 Sympa internationalization
17.4.2 List internationalization
17.4.3 User internationalization
17.5 Topics
17.6 Authorization scenarios
17.7 Loop detection
17.8 Tasks
17.8.1 List task creation
17.8.2 Global task creation
17.8.3 Model file format
17.8.4 Model file examples
18. Mailing list definition
18.1 Mail aliases
18.2 List configuration file
18.3 Examples of configuration files
18.4 Subscribers file
18.5 Info file
18.6 Homepage file
18.7 Data inclusion file
18.8 List template files
18.8.1 welcome.tt2
18.8.2 bye.tt2
18.8.3 removed.tt2
18.8.4 reject.tt2
18.8.5 invite.tt2
18.8.6 remind.tt2
18.8.7 summary.tt2
18.8.8 list_aliases.tt2
18.9 Stats file
18.10 List model files
18.10.1 remind.annual.task
18.10.2 expire.annual.task
18.11 Message header and footer
18.11.1 Archive directory
19. List creation, edition and removal
19.1 List creation
19.1.1 Data for list creation
19.1.2 XML file format
19.2 List families
19.3 List creation on command line with sympa.pl
19.4 Creating and editing mailing using the web
19.4.1 List creation on the Web interface
19.4.2 Who can create lists on the Web interface
19.4.3 typical list profile and Web interface
19.4.4 List edition
19.5 Removing a list
20. Lists Families
20.1 Family concept
20.2 Using family
20.2.1 Definition
20.2.2 Instantiation
20.2.3 Modification
20.2.4 Closure
20.2.5 Adding one list
20.2.6 Removing one list
20.2.7 Modifying one list
20.2.8 List parameters edition in a family context
20.3 Automatic list creation
20.3.1 Configuring your MTA
20.3.2 Defining the list family
20.3.3 Configuring Sympa
21. List configuration parameters
21.1 List description
21.1.1 editor
21.1.2 editor_include
21.1.3 host
21.1.4 lang
21.1.5 owner
21.1.6 owner_include
21.1.7 subject
21.1.8 topics
21.1.9 visibility
21.2 Data source related
21.2.1 user_data_source
21.2.2 ttl
21.2.3 include_list
21.2.4 include_remote_sympa_list
21.2.5 include_sql_query
21.2.6 include_ldap_query
21.2.7 include_ldap_2level_query
21.2.8 include_file
21.2.9 include_remote_file
21.3 Command related
21.3.1 subscribe
21.3.2 unsubscribe
21.3.3 add
21.3.4 del
21.3.5 remind
21.3.6 remind_task
21.3.7 expire_task
21.3.8 send
21.3.9 review
21.3.10 shared_doc
21.4 List tuning
21.4.1 reply_to_header
21.4.2 max_size
21.4.3 anonymous_sender
21.4.4 custom_header
21.4.5 rfc2369_header_fields
21.4.6 loop_prevention_regex
21.4.7 custom_subject
21.4.8 footer_type
21.4.9 digest
21.4.10 digest_max_size
21.4.11 available_user_options
21.4.12 default_user_options
21.4.13 msg_topic
21.4.14 msg_topic_keywords_apply_on
21.4.15 msg_topic_tagging
21.4.16 pictures_feature
21.4.17 cookie
21.4.18 priority
21.5 Bounce related
21.5.1 bounce
21.5.2 bouncers_level1
21.5.3 bouncers_level2
21.5.4 welcome_return_path
21.5.5 remind_return_path
21.5.6 verp_rate
21.6 Archive related
21.6.1 archive
21.6.2 web_archive
21.6.3 archive_crypted_msg
21.7 Spam protection
21.7.1 spam_protection
21.7.2 web_archive_spam_protection
21.8 Intern parameters
21.8.1 family_name
21.8.2 latest_instantiation
22. Reception mode
22.1 Message topics
22.1.1 Message topic definition in a list
22.1.2 Subscribing to message topic for list subscribers
22.1.3 Message tagging
23. Shared documents
23.1 The three kind of operations on a document
23.2 The description file
23.2.1 Structure of description files
23.3 The predefined authorization scenarios
23.3.1 The public scenario
23.3.2 The private scenario
23.3.3 The scenario owner
23.3.4 The scenario editor
23.4 Access control
23.4.1 Listmaster and privileged owners
23.4.2 Special case of the shared directory
23.4.3 General case
23.5 Shared document actions
23.6 Template files
23.6.1 d_read.tt2
23.6.2 d_editfile.tt2
23.6.3 d_control.tt2
23.6.4 d_upload.tt2
23.6.5 d_properties.tt2
24. Bounce management
24.1 VERP
24.2 ARF
25. Antivirus
26. Using Sympa with LDAP
27. Sympa with S/MIME and HTTPS
27.1 Signed message distribution
27.2 Use of S/MIME signature by Sympa itself
27.3 Use of S/MIME encryption
27.4 S/Sympa configuration
27.4.1 Installation
27.4.2 managing user certificates
27.4.3 configuration in sympa.conf
27.4.4 configuration to recognize S/MIME signatures
27.4.5 distributing encrypted messages
27.5 Managing certificates with tasks
27.5.1 chk_cert_expiration.daily.task model
27.5.2 crl_update.daily.task model
28. Using Sympa commands
28.1 User commands
28.2 Owner commands
28.3 Moderator commands
29. Internals
29.1 mail.pm
29.1.1 public functions
29.1.2 private functions
29.2 List.pm
29.2.1 Functions for message distribution
29.2.2 Functions for template sending
29.2.3 Functions for service messages
29.2.4 Functions for message notification
29.2.5 Functions for topic messages
29.2.6 Scenario evaluation
29.2.7 Structure and access to list configuration parameters
29.3 sympa.pl
29.4 Commands.pm
29.4.1 Commands processing
29.4.2 tools for command processing
29.5 wwsympa.fcgi
29.6 report.pm
29.6.1 Message diffusion
29.6.2 Mail commands
29.6.3 Web commands
29.7 tools.pl
29.8 Message.pm
Index
root 2006-11-21