1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<!--Converted with jLaTeX2HTML 2002 (1.62) JA patch-1.4
patched version by: Kenshi Muto, Debian Project.
LaTeX2HTML 2002 (1.62),
original version by: Nikos Drakos, CBLU, University of Leeds
* revised and updated by: Marcus Hennecke, Ross Moore, Herb Swan
* with significant contributions from:
Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
<HTML>
<HEAD>
<TITLE>2. what does Sympa consist of ?</TITLE>
<META NAME="description" CONTENT="2. what does Sympa consist of ?">
<META NAME="keywords" CONTENT="sympa">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1">
<META NAME="Generator" CONTENT="jLaTeX2HTML v2002 JA patch-1.4">
<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
<LINK REL="STYLESHEET" HREF="sympa.css">
<LINK REL="next" HREF="node4.html">
<LINK REL="previous" HREF="node2.html">
<LINK REL="up" HREF="sympa.html">
<LINK REL="next" HREF="node4.html">
</HEAD>
<BODY TEXT="#000000" BGCOLOR="#ffffff">
<!--Navigation Panel-->
<A NAME="tex2html640"
HREF="node4.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
<A NAME="tex2html634"
HREF="sympa.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
<A NAME="tex2html628"
HREF="node2.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
<A NAME="tex2html636"
HREF="node1.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
<A NAME="tex2html638"
HREF="node23.html">
<IMG WIDTH="43" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="index" SRC="index.png"></A>
<BR>
<B> Next:</B> <A NAME="tex2html641"
HREF="node4.html">3. Installing Sympa</A>
<B> Up:</B> <A NAME="tex2html635"
HREF="sympa.html">Sympa Mailing Lists Management Software version</A>
<B> Previous:</B> <A NAME="tex2html629"
HREF="node2.html">1. Presentation</A>
  <B> <A NAME="tex2html637"
HREF="node1.html">Contents</A></B>
  <B> <A NAME="tex2html639"
HREF="node23.html">Index</A></B>
<BR>
<BR>
<!--End of Navigation Panel-->
<!--Table of Child-Links-->
<A NAME="CHILD_LINKS"><STRONG>Subsections</STRONG></A>
<UL>
<LI><A NAME="tex2html642"
HREF="node3.html#SECTION00310000000000000000">2.1 Organization</A>
<LI><A NAME="tex2html643"
HREF="node3.html#SECTION00320000000000000000">2.2 Binaries</A>
<LI><A NAME="tex2html644"
HREF="node3.html#SECTION00330000000000000000">2.3 Configuration files</A>
<LI><A NAME="tex2html645"
HREF="node3.html#SECTION00340000000000000000">2.4 Spools</A>
</UL>
<!--End of Table of Child-Links-->
<HR>
<H1><A NAME="SECTION00300000000000000000">
2. what does <I>Sympa</I> consist of ?</A>
</H1>
<P>
<H1><A NAME="SECTION00310000000000000000"></A>
<A NAME="organization"></A>
<BR>
2.1 Organization
</H1>
<P>
Here is a snapshot of what <I>Sympa</I> looks like once it has settled down
on your system. This also illustrates the <I>Sympa</I> philosophy, I guess.
Almost all configuration files can be defined for a particular list, for
a virtual robot or for the whole site.
<P>
<UL>
<LI><A NAME="4279"></A><TT>/home/sympa</TT>
<BR>
The root directory of <I>Sympa</I>. You will find almost everything
related to <I>Sympa</I> under this directory, except logs and main
configuration files.
<P>
</LI>
<LI><A NAME="4284"></A><TT>/home/sympa/bin</TT>
<BR>
This directory contains the binaries, including the CGI. It
also contains the default authorization scenarios, templates and configuration
files as in the distribution. <A NAME="4287"></A><TT>/home/sympa/bin</TT> may be completely
overwritten by the <A NAME="4290"></A><TT>make install</TT> so you must not customize
templates and authorization scenarios under <A NAME="4293"></A><TT>/home/sympa/bin</TT>.
<P>
</LI>
<LI><A NAME="4296"></A><TT>/home/sympa/bin/etc</TT>
<BR>
Here <I>Sympa</I> stores the default versions of what it will otherwise find
in <A NAME="4300"></A><TT>/home/sympa/etc</TT> (task models, authorization scenarios, templates and configuration
files, recognized S/Mime certificates).
<P>
</LI>
<LI><A NAME="4303"></A><TT>/home/sympa/etc</TT>
<BR>
This is your site's configuration directory. Consult
<A NAME="4306"></A><TT>/home/sympa/bin/etc</TT> when drawing up your own.
<P>
</LI>
<LI><A NAME="4309"></A><TT>/home/sympa/etc/create_list_templates/</TT>
<BR>
List templates (suggested at list creation time).
<P>
</LI>
<LI><A NAME="4312"></A><TT>/home/sympa/etc/scenari/</TT>
<BR>
This directory will contain your authorization scenarios.
If you don't know what the hell an authorization scenario is, refer to <A HREF="node11.html#scenarios">10</A><A HREF="node11.html#scenarios">10</A>,
page <A HREF="node11.html#scenarios"><IMG ALIGN="BOTTOM" BORDER="1" ALT="[*]" SRC="crossref.png"></A>. Those authorization scenarios are default scenarios but you may look at
<A NAME="4315"></A><TT>/home/sympa/etc/my.domain.org/scenari/</TT> for default scenarios of my.domain.org
virtual robot and <A NAME="4318"></A><TT>/home/sympa/expl/mylist/scenari</TT> for scenarios
specific to a particular list
<P>
</LI>
<LI><A NAME="4321"></A><TT>/home/sympa/etc/list_task_models/</TT>
<BR>
This directory will store your own list task models (see <A HREF="node13.html#tasks">12.10</A>, page <A HREF="node13.html#tasks"><IMG ALIGN="BOTTOM" BORDER="1" ALT="[*]" SRC="crossref.png"></A>).
<P>
</LI>
<LI><A NAME="4324"></A><TT>/home/sympa/etc/global_task_models/</TT>
<BR>
Contains global task models of yours (see <A HREF="node13.html#tasks">12.10</A>, page <A HREF="node13.html#tasks"><IMG ALIGN="BOTTOM" BORDER="1" ALT="[*]" SRC="crossref.png"></A>).
<P>
</LI>
<LI><A NAME="4327"></A><TT>/home/sympa/etc/wws_templates/</TT>
<BR>
The web interface (<A NAME="4330"></A><I>WWSympa</I>) is composed of template HTML
files parsed by the CGI program. Templates can also
be defined for a particular list in <A NAME="4333"></A><TT>/home/sympa/expl/mylist/wws_templates/</TT>
or in <A NAME="4336"></A><TT>/home/sympa/etc/my.domain.org/wws_templates/</TT>
<P>
</LI>
<LI><A NAME="4339"></A><TT>/home/sympa/etc/templates/</TT>
<BR>
Some of the mail robot's replies are defined by templates
(<A NAME="4342"></A><TT>welcome.tpl</TT> for SUBSCRIBE). You can overload
these template files in the individual list directories or
for each virtual robot, but these are the defaults.
<P>
</LI>
<LI><A NAME="4345"></A><TT>/home/sympa/etc/my.domain.org</TT>
<BR>
The directory to define the virtual robot my.domain.orgdedicated to
managment of all lists of this domain (list description of my.domain.orgare stored
in <A NAME="4348"></A><TT>/home/sympa/expl/my.domain.org</TT>).
Those directories for virtual robots have the same structure as <A NAME="4351"></A><TT>/home/sympa/etc</TT> which is
the configuration dir of the default robot.
<P>
</LI>
<LI><A NAME="4354"></A><TT>/home/sympa/expl</TT>
<BR> <I>Sympa</I>'s working directory.
<P>
</LI>
<LI><A NAME="4358"></A><TT>/home/sympa/expl/mylist</TT>
<BR>
The list directory (refer to <A HREF="#list-directory"><IMG ALIGN="BOTTOM" BORDER="1" ALT="[*]" SRC="crossref.png"></A>,
page <A HREF="#list-directory"><IMG ALIGN="BOTTOM" BORDER="1" ALT="[*]" SRC="crossref.png"></A>). Lists stored in this directory
belong to the default robot as defined in sympa.conf file, but a list
can be stored in <A NAME="4361"></A><TT>/home/sympa/expl/my.domain.org/mylist</TT> directory and it
is managed by my.domain.orgvirtual robot.
<P>
</LI>
<LI><A NAME="4364"></A><TT>/home/sympa/expl/X509-user-certs</TT>
<BR>
The directory where Sympa stores all user's certificates
<P>
</LI>
<LI><A NAME="4367"></A><TT>/home/sympa/nls</TT>
<BR>
Internationalization directory. It contains XPG4-compatible
message catalogues. <I>Sympa</I> has currently been translated
into 14 different languages.
<P>
</LI>
<LI><A NAME="4371"></A><TT>/home/sympa/spool</TT>
<BR> <I>Sympa</I> uses 7 different spools (see <A HREF="node3.html#spools">2.4</A>, page <A HREF="node3.html#spools"><IMG ALIGN="BOTTOM" BORDER="1" ALT="[*]" SRC="crossref.png"></A>).
<P>
</LI>
<LI><A NAME="4375"></A><TT>/home/sympa/src/</TT>
<BR> <I>Sympa</I> sources.
<P>
</LI>
</UL>
<P>
<H1><A NAME="SECTION00320000000000000000"></A>
<A NAME="binaries"></A>
<BR>
2.2 Binaries
</H1>
<P>
<UL>
<LI><A NAME="4379"></A><TT>sympa.pl</TT>
<BR>
The main daemon ; it processes commands and delivers
messages. Continuously scans the <A NAME="4382"></A><TT>msg/</TT> spool.
<P>
</LI>
<LI><A NAME="4385"></A><TT>sympa_wizard.pl</TT>
<BR>
A wizard to edit <A NAME="4388"></A><TT>sympa.conf</TT> and <A NAME="4391"></A><TT>wwsympa.conf</TT>.
Maybe it is a good idea to run it at the beginning, but thoses
file can also be edited with your favorite text editor.
<P>
</LI>
<LI><A NAME="4394"></A><TT>wwsympa.fcgi</TT>
<BR>
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.
<P>
</LI>
<LI><A NAME="4397"></A><TT>bounced.pl</TT>
<BR>
This daemon processes bounces (non-delivered messages),
looking for bad addresses. List owners will later
access bounce information via <A NAME="4400"></A><I>WWSympa</I>. Continuously scans
the <A NAME="4403"></A><TT>bounce/</TT> spool.
<P>
</LI>
<LI><A NAME="4406"></A><TT>archived.pl</TT>
<BR>
This daemon feeds the web archives, converting messages
to HTML format and linking them. It uses the amazing
<A NAME="4409"></A><TT>MhOnArc</TT>. Continuously scans the <A NAME="4412"></A><TT>outgoing/</TT>
spool.
<P>
</LI>
<LI><A NAME="4415"></A><TT>task_manager.pl</TT>
<BR>
The daemon which manages the tasks : creation, checking, execution.
It regularly scans the <A NAME="4418"></A><TT>task/</TT> spool.
<P>
</LI>
<LI><A NAME="4421"></A><TT>sympa_soap_server.fcgi</TT>
<BR>
The server will process SOAP (web services) request. This server requires FastCGI ;
it should be referenced from within your HTTPS config.
<P>
</LI>
<LI><A NAME="4424"></A><TT>queue</TT>
<BR>
This small program gets the incoming messages from the aliases
and stores them in <A NAME="4427"></A><TT>msg/</TT> spool.
<P>
</LI>
<LI><A NAME="4430"></A><TT>bouncequeue</TT>
<BR>
Same as <A NAME="4433"></A><TT>queue</TT> for bounces. Stores bounces in
<A NAME="4436"></A><TT>bounce/</TT> spool.
<P>
</LI>
</UL>
<P>
<H1><A NAME="SECTION00330000000000000000">
2.3 Configuration files</A>
</H1>
<P>
<UL>
<LI><A NAME="4439"></A><TT>/etc/sympa.conf</TT>
<BR>
The main configuration file.
See <A HREF="node6.html#exp-admin">5</A>, page <A HREF="node6.html#exp-admin"><IMG ALIGN="BOTTOM" BORDER="1" ALT="[*]" SRC="crossref.png"></A>.
<P>
</LI>
<LI><A NAME="4442"></A><TT>/etc/wwsympa.conf</TT>
<BR> <A NAME="4445"></A><I>WWSympa</I> configuration file.
See <A HREF="node2.html#wwsympa">1.2</A>, page <A HREF="node2.html#wwsympa"><IMG ALIGN="BOTTOM" BORDER="1" ALT="[*]" SRC="crossref.png"></A>.
<P>
</LI>
<LI><A NAME="4448"></A><TT>edit_list.conf</TT>
<BR>
Defines which parameters/files are editable by
owners. See <A HREF="node15.html#list-edition">14.2</A>, page <A HREF="node15.html#list-edition"><IMG ALIGN="BOTTOM" BORDER="1" ALT="[*]" SRC="crossref.png"></A>.
<P>
</LI>
<LI><A NAME="4451"></A><TT>topics.conf</TT>
<BR>
Contains the declarations of your site's topics (classification in
<A NAME="4454"></A><I>WWSympa</I>), along with their titles. A sample is provided in the
<A NAME="4457"></A><TT>sample/</TT> directory of the sympa distribution.
See <A HREF="node13.html#topics">12.7</A>, page <A HREF="node13.html#topics"><IMG ALIGN="BOTTOM" BORDER="1" ALT="[*]" SRC="crossref.png"></A>.
<P>
</LI>
<LI><A NAME="4460"></A><TT>auth.conf</TT>
<BR>
Defines authentication backend organisation ( <A NAME="4463"></A>LDAP-based authentication, <A NAME="4464"></A>CAS-based authentication and sympa internal )
<P>
</LI>
<LI><A NAME="4465"></A><TT>robot.conf</TT>
<BR>
It is a subset of <A NAME="4468"></A><TT>sympa.conf</TT> defining a Virtual robot
(one per Virtual robot).
<P>
</LI>
</UL>
<P>
<H1><A NAME="SECTION00340000000000000000"></A>
<A NAME="spools"></A>
<BR>
2.4 Spools
</H1>
<P>
See <A HREF="node6.html#spool-related">5.6</A>, page <A HREF="node6.html#spool-related"><IMG ALIGN="BOTTOM" BORDER="1" ALT="[*]" SRC="crossref.png"></A> for spool definition
in <A NAME="4471"></A><TT>sympa.conf</TT>.
<P>
<UL>
<LI><A NAME="4474"></A><TT>/home/sympa/spool/auth/</TT>
<BR>
For storing messages until they have been confirmed.
<P>
</LI>
<LI><A NAME="4477"></A><TT>/home/sympa/spool/bounce/</TT>
<BR>
For storing incoming bouncing messages.
<P>
</LI>
<LI><A NAME="4480"></A><TT>/home/sympa/spool/digest/</TT>
<BR>
For storing lists' digests before they are sent.
<P>
</LI>
<LI><A NAME="4483"></A><TT>/home/sympa/spool/expire/</TT>
<BR>
Used by the expire process.
<P>
</LI>
<LI><A NAME="4486"></A><TT>/home/sympa/spool/mod/</TT>
<BR>
For storing unmoderated messages.
<P>
</LI>
<LI><A NAME="4489"></A><TT>/home/sympa/spool/msg/</TT>
<BR>
For storing incoming messages (including commands).
<P>
</LI>
<LI><A NAME="4492"></A><TT>/home/sympa/spool/msg/bad/</TT>
<BR> <I>Sympa</I> stores rejected messages in this directory
<P>
</LI>
<LI><A NAME="4496"></A><TT>/home/sympa/spool/task/</TT>
<BR>
For storing all created tasks.
<P>
</LI>
<LI><A NAME="4499"></A><TT>/home/sympa/spool/outgoing/</TT>
<BR> <A NAME="4502"></A><TT>sympa.pl</TT> dumps messages in this spool to await archiving
by <A NAME="4505"></A><TT>archived.pl</TT>.
<P>
</LI>
</UL>
<P>
<HR>
<!--Navigation Panel-->
<A NAME="tex2html640"
HREF="node4.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
<A NAME="tex2html634"
HREF="sympa.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
<A NAME="tex2html628"
HREF="node2.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
<A NAME="tex2html636"
HREF="node1.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
<A NAME="tex2html638"
HREF="node23.html">
<IMG WIDTH="43" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="index" SRC="index.png"></A>
<BR>
<B> Next:</B> <A NAME="tex2html641"
HREF="node4.html">3. Installing Sympa</A>
<B> Up:</B> <A NAME="tex2html635"
HREF="sympa.html">Sympa Mailing Lists Management Software version</A>
<B> Previous:</B> <A NAME="tex2html629"
HREF="node2.html">1. Presentation</A>
  <B> <A NAME="tex2html637"
HREF="node1.html">Contents</A></B>
  <B> <A NAME="tex2html639"
HREF="node23.html">Index</A></B>
<!--End of Navigation Panel-->
<ADDRESS>
root
2004-09-10
</ADDRESS>
</BODY>
</HTML>
|
