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 cookie
7.1.15 create_list
7.1.16 global_remind
7.2 Directories
7.2.1 home
7.2.2 etc
7.3 System related
7.3.1 syslog
7.3.2 log_level
7.3.3 log_socket_type
7.3.4 pidfile
7.3.5 umask
7.4 Sending related
7.4.1 distribution_mode
7.4.2 maxsmtp
7.4.3 log_smtp
7.4.4 max_size
7.4.5 misaddressed_commands
7.4.6 misaddressed_commands_regexp
7.4.7 nrcpt
7.4.8 avg
7.4.9 sendmail
7.4.10 sendmail_args
7.4.11 sendmail_aliases
7.4.12 rfc2369_header_fields
7.4.13 remove_headers
7.4.14 anonymous_headers_fields
7.4.15 list_check_smtp
7.4.16 list_check_suffixes
7.4.17 urlize_min_size
7.5 Quotas
7.5.1 default_shared_quota
7.5.2 default_archive_quota
7.6 Spool related
7.6.1 spool
7.6.2 queue
7.6.3 queuedistribute
7.6.4 queuemod
7.6.5 queuedigest
7.6.6 queueauth
7.6.7 queueoutgoing
7.6.8 queuetopic
7.6.9 queuebounce
7.6.10 queuetask
7.6.11 tmpdir
7.6.12 sleep
7.6.13 clean_delay_queue
7.6.14 clean_delay_queuemod
7.6.15 clean_delay_queueauth
7.6.16 clean_delay_queuesubscribe
7.6.17 clean_delay_queuetopic
7.7 Internationalization related
7.7.1 localedir
7.7.2 supported_lang
7.7.3 lang
7.7.4 web_recode_to
7.8 Bounce related
7.8.1 verp_rate
7.8.2 welcome_return_path
7.8.3 remind_return_path
7.8.4 return_path_suffix
7.8.5 expire_bounce_task
7.8.6 purge_orphan_bounces_task
7.8.7 eval_bouncers_task
7.8.8 process_bouncers_task
7.8.9 minimum_bouncing_count
7.8.10 minimum_bouncing_period
7.8.11 bounce_delay
7.8.12 default_bounce_level1_rate
7.8.13 default_bounce_level2_rate
7.8.14 bounce_email_prefix
7.8.15 bounce_warn_rate
7.8.16 bounce_halt_rate
7.8.17 default_remind_task
7.9 Priority related
7.9.1 sympa_priority
7.9.2 request_priority
7.9.3 owner_priority
7.9.4 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 RSS channel
10.1 latest_lists
10.2 active_lists
10.3 latest_arc
10.4 latest_d_read
11. Sympa SOAP server
11.1 Introduction
11.2 Web server setup
11.3 Sympa setup
11.4 The WSDL service description
11.5 Client-side programming
11.5.1 Writting a Java client with Axis
12. Authentication
12.1 S/MIME and HTTPS authentication
12.2 Authentication with email address, uid or alternate email address
12.3 Generic SSO authentication
12.4 CAS-based authentication
12.5 auth.conf
12.5.1 user_table paragraph
12.5.2 ldap paragraph
12.5.3 generic_sso paragraph
12.5.4 cas paragraph
12.6 Sharing WWSympa authentication with other applications
12.7 Provide a Sympa login form in another application
13. Authorization scenarios
13.1 rules specifications
13.2 LDAP Named Filters
13.2.1 Definition
13.2.2 Search Condition
13.3 scenario inclusion
13.4 Hidding scenario files
14. virtual host
14.1 How to create a virtual host
14.2 robot.conf
14.2.1 Robot customization
14.3 Managing multiple virtual hosts
15. Interaction between Sympa and other applications
15.1 Soap
15.2 RSS channel
15.3 Sharing WWSympa authentication with other applications
15.4 Sharing data with other applications
15.5 Subscriber count
16. Customizing Sympa/WWSympa
16.1 Template file format
16.2 Site template files
16.2.1 helpfile.tt2
16.2.2 lists.tt2
16.2.3 global_remind.tt2
16.2.4 your_infected_msg.tt2
16.3 Web template files
16.4 Internationalization
16.4.1 Sympa internationalization
16.4.2 List internationalization
16.4.3 User internationalization
16.5 Topics
16.6 Authorization scenarios
16.7 Loop detection
16.8 Tasks
16.8.1 List task creation
16.8.2 Global task creation
16.8.3 Model file format
16.8.4 Model file examples
17. Mailing list definition
17.1 Mail aliases
17.2 List configuration file
17.3 Examples of configuration files
17.4 Subscribers file
17.5 Info file
17.6 Homepage file
17.7 Data inclusion file
17.8 List template files
17.8.1 welcome.tt2
17.8.2 bye.tt2
17.8.3 removed.tt2
17.8.4 reject.tt2
17.8.5 invite.tt2
17.8.6 remind.tt2
17.8.7 summary.tt2
17.8.8 list_aliases.tt2
17.9 Stats file
17.10 List model files
17.10.1 remind.annual.task
17.10.2 expire.annual.task
17.11 Message header and footer
17.11.1 Archive directory
18. List creation, edition and removal
18.1 List creation
18.1.1 Data for list creation
18.1.2 XML file format
18.2 List families
18.3 List creation on command line with sympa.pl
18.4 Creating and editing mailing using the web
18.4.1 List creation on the Web interface
18.4.2 Who can create lists on the Web interface
18.4.3 typical list profile and Web interface
18.4.4 List edition
18.5 Removing a list
19. Lists Families
19.1 Family concept
19.2 Using family
19.2.1 Definition
19.2.2 Instantiation
19.2.3 Modification
19.2.4 Closure
19.2.5 Adding one list
19.2.6 Removing one list
19.2.7 Modifying one list
19.2.8 List parameters edition in a family context
20. List configuration parameters
20.1 List description
20.1.1 editor
20.1.2 editor_include
20.1.3 host
20.1.4 lang
20.1.5 owner
20.1.6 owner_include
20.1.7 subject
20.1.8 topics
20.1.9 visibility
20.2 Data source related
20.2.1 user_data_source
20.2.2 ttl
20.2.3 include_list
20.2.4 include_remote_sympa_list
20.2.5 include_sql_query
20.2.6 include_ldap_query
20.2.7 include_ldap_2level_query
20.2.8 include_file
20.2.9 include_remote_file
20.3 Command related
20.3.1 subscribe
20.3.2 unsubscribe
20.3.3 add
20.3.4 del
20.3.5 remind
20.3.6 remind_task
20.3.7 expire_task
20.3.8 send
20.3.9 review
20.3.10 shared_doc
20.4 List tuning
20.4.1 reply_to_header
20.4.2 max_size
20.4.3 anonymous_sender
20.4.4 custom_header
20.4.5 rfc2369_header_fields
20.4.6 loop_prevention_regex
20.4.7 custom_subject
20.4.8 footer_type
20.4.9 digest
20.4.10 digest_max_size
20.4.11 available_user_options
20.4.12 default_user_options
20.4.13 msg_topic
20.4.14 msg_topic_keywords_apply_on
20.4.15 msg_topic_tagging
20.4.16 cookie
20.4.17 priority
20.5 Bounce related
20.5.1 bounce
20.5.2 bouncers_level1
20.5.3 bouncers_level2
20.5.4 welcome_return_path
20.5.5 remind_return_path
20.6 Archive related
20.6.1 archive
20.6.2 web_archive
20.6.3 archive_crypted_msg
20.7 Spam protection
20.7.1 spam_protection
20.7.2 web_archive_spam_protection
20.8 Intern parameters
20.8.1 family_name
20.8.2 latest_instantiation
21. Reception mode
21.1 Message topics
21.1.1 Message topic definition in a list
21.1.2 Subscribing to message topic for list subscribers
21.1.3 Message tagging
22. Shared documents
22.1 The three kind of operations on a document
22.2 The description file
22.2.1 Structure of description files
22.3 The predefined authorization scenarios
22.3.1 The public scenario
22.3.2 The private scenario
22.3.3 The scenario owner
22.3.4 The scenario editor
22.4 Access control
22.4.1 Listmaster and privileged owners
22.4.2 Special case of the shared directory
22.4.3 General case
22.5 Shared document actions
22.6 Template files
22.6.1 d_read.tt2
22.6.2 d_editfile.tt2
22.6.3 d_control.tt2
22.6.4 d_upload.tt2
22.6.5 d_properties.tt2
23. Bounce management
23.1 VERP
24. Antivirus
25. Using Sympa with LDAP
26. Sympa with S/MIME and HTTPS
26.1 Signed message distribution
26.2 Use of S/MIME signature by Sympa itself
26.3 Use of S/MIME encryption
26.4 S/Sympa configuration
26.4.1 Installation
26.4.2 configuration in sympa.conf
26.4.3 configuration to recognize S/MIME signatures
26.4.4 distributing encrypted messages
26.5 Managing certificates with tasks
26.5.1 chk_cert_expiration.daily.task model
26.5.2 crl_update.daily.task model
27. Using Sympa commands
27.1 User commands
27.2 Owner commands
27.3 Moderator commands
28. Internals
28.1 mail.pm
28.1.1 public functions
28.1.2 private functions
28.2 List.pm
28.2.1 Functions for message distribution
28.2.2 Functions for template sending
28.2.3 Functions for service messages
28.2.4 Functions for message notification
28.2.5 Functions for topic messages
28.2.6 Scenario evaluation
28.2.7 Structure and access to list configuration parameters
28.3 sympa.pl
28.4 Commands.pm
28.4.1 Commands processing
28.4.2 tools for command processing
28.5 wwsympa.fcgi
28.6 report.pm
28.6.1 Message diffusion
28.6.2 Mail commands
28.6.3 Web commands
28.7 tools.pl
28.8 Message.pm
Index
root 2006-04-12