Next: 3. Installing Sympa
Up: Sympa Mailing Lists Management Software
Previous: 1. Presentation
  Contents
  Index
Subsections
2.1 Organization
Here is a snapshot of what Sympa looks like once it has settled down
on your system. This also illustrates the Sympa philosophy, I guess.
Almost all configuration files can be defined for a particular list, for
a virtual robot or for the whole site.
- ~sympa/
The root directory of Sympa. You will find almost everything
related to Sympa under this directory, except logs and main
configuration files.
- ~sympa/bin/
This directory contains the binaries, including CGI. It
also contains the default scenarios, templates and configuration
files as in the distribution. ~sympa/bin/ may be completly
overwritten by the make install So you must not customize
templates and scenarii under ~sympa/bin/.
- ~sympa/bin/etc/
Here Sympa stores the default versions of what it will otherwise find
in ~sympa/etc/ (task models, scenarios, templates and configuration
files, recognized S/Mime certificates).
- ~sympa/etc/
This is your site's configuration directory. Consult
~sympa/bin/etc/ when drawing up your own.
- ~sympa/etc/create_list_templates/
List templates (suggested at list creation time).
- ~sympa/etc/scenari/
This directory will contain your scenarii (or scenarios, if you prefer).
If you don't know what the hell a scenario is, refer to 9.89.8,
page
. Thoses scenarii are default scenarii but you may
~sympa/etc/mydomainorg/scenari/ for default scenarii of mydomainorg
virtual robot and ~sympa/expl/mylist/scenari for scenarii
specific to a particular list
- ~sympa/etc/list_task_models/
This directory will store your own list task models (see 9.10, page
).
- ~sympa/etc/global_task_models/
Contains global task models of yours (see 9.10, page
).
- ~sympa/etc/wws_templates/
The web interface (WWSympa) is composed of template HTML
files parsed by the CGI program. Templates can also
be defined for a particular list in ~sympa/expl/mylist/wws_templates/
or in ~sympa/etc/mydomainorg/wws_templates/
- ~sympa/etc/templates/
Some of the mail robot's replies are defined by templates
(welcome.tpl for SUBSCRIBE). You can overload
these template files in the individual list directories or
for each virtual robot, but these are the defaults.
- ~sympa/etc/mydomainorg
The directory to define the virtual robot mydomainorgdedicated to
managment of all lists of this domain (list describtion of mydomainorgare stored
in ~sympa/expl/mydomainorg).
Thoses directories for virtual robots has the same structure as ~sympa/etc which is
configuration dir of the default robot.
- ~sympa/expl/
Sympa's working directory.
- ~sympa/expl/mylist
The list directory (refer to 10.2,
page
). Lists stored in this directory are
belong the default robot as defined in sympa.conf file, but a list
can be stored in ~sympa/expl/mydomainorg/mylist directory and it
is managed by mydomainorgvirtual robot.
- ~sympa/expl/X509-user-certs
The directory where Sympa store all user's certificat
- ~sympa/nls/
Internationalization directory. It contains XPG4-compatible
message catalogues. Sympa has currently been translated
into 8 different languages.
- ~sympa/spool/
Sympa uses 7 different spools (see 2.4, page
).
- ~sympa/src/
Sympa sources.
2.2 Binaries
- sympa.pl
The main daemon ; it processes commands and delivers
messages. Continuously scans the msg/ spool.
- wwsympa.fcgi
The CGI program offering a complete web interface
to mailing lists. It can work in both classical CGI and
FastCGI modes, although we recommend FastCGI mode, being
up to 10 times faster.
- bounced.pl
This daemon processes bounces (non-delivered messages),
looking for the bad addresses. List owners will later
access bounce information via WWSympa. Continuously scans
the bounce/ spool.
- archived.pl
This daemon feeds the web archives, converting messages
to HTML format and linking them. It uses the amazing
MhOnArc. Continuously scans the outgoing/
spool.
- task_manager.pl
The daemon which manages the tasks : creation, checking, execution.
It regurlaly scans the task/ spool.
- queue
This small program gets the incoming messages from the aliases
and stores them in msg/ spool.
- bouncequeue
Same as queue for bounces. Stores bounces in
bounce/ spool.
- sympa.conf
The main configuration file.
See 4, page
.
- wwsympa.conf
WWSympa configuration file.
See 1.2, page
.
- edit_list.conf
Defines which parameters/files are editable by
owners. See 12.2, page
.
- topics.conf
Contains the declarations your site's topics (classification in
WWSympa), along with their titles. A sample is provided in the
sample/ directory of the sympa distribution.
See 9.7, page
.
2.4 Spools
See 4.5, page
for spool definition
in sympa.conf.
- ~sympa/spool/auth/
For storing messages until they have been confirmed.
- ~sympa/spool/bounce/
For storing incoming bouncing messages.
- ~sympa/spool/digest/
For storing lists' digests before they are sent.
- ~sympa/spool/expire/
Used by the expire process.
- ~sympa/spool/mod/
For storing unmoderated messages.
- ~sympa/spool/msg/
For storing incoming messages (including commands).
- ~sympa/spool/task/
For storing all created tasks.
- ~sympa/spool/outgoing/
sympa.pl dumps messages in this spool to await archiving
by archived.pl.
Next: 3. Installing Sympa
Up: Sympa Mailing Lists Management Software
Previous: 1. Presentation
  Contents
  Index
root
2001-11-16