Commit 61663435 authored by IKEDA Soji's avatar IKEDA Soji
Browse files

Adding documentation.

parent e02c8307
......@@ -33,7 +33,6 @@ nobase_default_DATA = \
create_list.conf \
edit_list.conf \
ldap_alias_entry.tt2 \
ldap_alias_manager.conf \
mhonarc-ressources.tt2 \
mime.types \
nrcpt_by_domain.conf \
......
## This configuration file is used by the ldap_alias_manager.pl ; it allows to manage mail aliases in an LDAP directory
## To make sympa use the ldap_alias_manager.pl script, you should edit the 'ldap_manager' sympa.conf parameter
## To use this file, you should copy it to the /home/sympa/etc/ directory
#LDAP server host
ldap_host ldap.example.com
#LDAP bind DN
ldap_bind_dn cn=sympa,ou=services,dc=example,dc=com
#LDAP bind password
ldap_bind_pwd secret
#LDAP Base DN
ldap_base_dn ou=mail,dc=example,dc=com
#LDAP Mail attribute
ldap_mail_attribute mail
#LDAP SSL
ldap_ssl 0
#LDAP SSL protocol
#ldap_ssl_version tlsv1
#LDAP CA Chain file
#ldap_cachain /etc/ldap/cert/cachain.pem
#Postfix transport parameter for queue
queue_transport sympa
#Postfix transport parameter for bouncequeue
bouncequeue_transport sympabounce
......@@ -38,35 +38,45 @@ nobase_doc_DATA = \
man1_MANS = \
sympa_toc.1
man5_MANS = \
auth.conf.5 \
automatic_lists_description.conf.5 \
charset.conf.5 \
crawlers_detection.conf.5 \
edit_list.conf.5 \
ldap_alias_manager.conf.5 \
list_config.5 \
nrcpt_by_domain.conf.5 \
sympa.conf.5 \
sympa_database.5
sympa_database.5 \
sympa.wsdl.5 \
topics.conf.5 \
trusted_applications.conf.5
EXTRA_DIST = $(nobase_doc_DATA) \
charset.conf.podin \
auth.conf.pod \
automatic_lists_description.conf.pod \
charset.conf.pod \
crawlers_detection.conf.pod \
edit_list.conf.pod \
ldap_alias_manager.conf.pod \
list_config.podpl \
nrcpt_by_domain.conf.pod \
sympa.conf.podpl \
sympa_database.podpl \
sympa_toc.pod
sympa_toc.pod \
sympa.wsdl.pod \
topics.conf.pod \
trusted_applications.conf.pod
CLEANFILES = $(man1_MANS) $(man5_MANS)
.pod.1:
$(AM_V_GEN)$(POD2MAN) --section=1 --center="sympa $(VERSION)" \
--lax --release="$(VERSION)" $*.pod $@
.podin.5:
$(AM_V_GEN)rm -f $*.pod
@$(SED) \
-e 's|--defaultdir--|$(defaultdir)|' \
-e 's|--sysconfdir--|$(sysconfdir)|' \
-e 's|--CONFIG--|$(CONFIG)|' \
< $(srcdir)/$< > $*.pod
@rm -f $@
@$(POD2MAN) --section=5 --center="sympa $(VERSION)" \
.pod.5:
$(AM_V_GEN)$(POD2MAN) --section=5 --center="sympa $(VERSION)" \
--lax --release="$(VERSION)" $*.pod $@
@rm -f $*.pod
.podpl.5:
$(AM_V_GEN)rm -f $*.pod
@PERL5LIB=$(top_srcdir)/src/lib; export PERL5LIB; \
......
=encoding utf-8
=head1 NAME
auth.conf -
Configuration of authentication mechanisms for web interface of Sympa
=head1 DESCRIPTION
F<auth.conf> defines authentication mechanisms for web interface of Sympa.
TBD.
=head1 FILES
=over
=item F<$DEFAULTDIR/auth.conf>
Distribution default. This file should not be edited.
=item F<$SYSCONFDIR/auth.conf>
=item F<$SYSCONFDIR/E<lt>robot nameE<gt>/auth.conf>
Configuration files for site-wide default and each robot.
=back
=head1 SEE ALSO
L<wwsympa(8)>,
L<sympa_soap_server(8)>.
=head1 HISTORY
This document was initially written by IKEDA Soji <ikeda@conversion.co.jp>.
=cut
=encoding utf-8
=head1 NAME
automatic_lists_description.conf -
Description of automatic list creation with web interface
=head1 DESCRIPTION
F<automatic_lists_description.conf> defines criteria to create automatic
lists with web interface.
TBD.
=head1 FILES
=over
=item F<$SYSCONFDIR/families/E<lt>family nameE<gt>/automatic_lists_description.conf>
=item F<$SYSCONFDIR/E<lt>robot nameE<gt>/families/E<lt>family nameE<gt>/automatic_lists_description.conf>
Files describing a family for site-wide default and each robot.
=back
=head1 SEE ALSO
L<wwsympa(8)>,
L<Sympa::Family>.
=head1 HISTORY
This document was initially written by IKEDA Soji <ikeda@conversion.co.jp>.
=cut
......@@ -18,7 +18,7 @@ directory:
# cp $DEFAULTDIR/charset.conf $SYSCONFDIR/charset.conf
And set the C<legacy_character_support_feature> parameter value in
F<--CONFIG--> to C<on>.
L<F<sympa.conf>|sympa.conf(5)> to C<on>.
=head2 Note
......@@ -26,6 +26,20 @@ If you are planning to upgrade Sympa earlier than 5.3a.8,
original F<charset.conf> is required to convert shared documents
during upgrade process.
=head1 FILES
=over
=item F<$DEFAULTDIR/charset.conf>
Distribution default. This file should not be edited.
=item F<$SYSCONFDIR/charset.conf>
Configuration file.
=back
=head1 SEE ALSO
L<sympa.conf(5)>.
......
=encoding utf-8
=head1 NAME
crawlers_detection.conf - User agents to be excluded from session management
=head1 DESCRIPTION
F<crawlers_detection.conf> defines user agents to be excluded from session
management by Sympa web interface.
TBD.
=head1 FILES
=over
=item F<$DEFAULTDIR/crawlers_detection.conf>
Distribution default. This file should not be edited.
=item F<$SYSCONFDIR/E<lt>robot nameE<gt>/crawlers_detection.conf>
Configuration file for each robot.
=back
=head1 SEE ALSO
L<wwsympa(8)>.
=head1 HISTORY
This document was initially written by IKEDA Soji <ikeda@conversion.co.jp>.
=cut
=encoding utf-8
=head1 NAME
edit_list.conf - Configuration of privileges to edit list configuration
=head1 DESCRIPTION
F<edit_list.conf> defines privileges to edit list configuration.
F<$SYSCONFDIR/edit_list.conf> is main configuration.
Several parameters defined in this file may be overridden by
F<$SYSCONFDIR/E<lt>mail domain nameE<gt>/edit_list.conf>
file for each mail domain, or by
F<E<lt>list config directoryE<gt>/edit_list.conf> file for each mailing list.
Format of F<edit_list.conf> is as following:
=over
=item *
Lines beginning with C<#> and containing only spaces are ignored.
=item *
Each line has the form "I<parameter name> I<role> I<privilege>".
=back
I<parameter name> is a list parameter name (e.g. C<max_size>),
paragraph name (C<owner>) or subparameter (C<owner.email)>).
It may be a name of template (e.g. C<welcome.tt2>) or list configuration file
(C<message.header>) except main configuration file (C<config>).
I<role> is any of C<listmaster>, C<privileged_owner>, C<owner> or C<editor>.
Multiple roles have to be separated by comma ("C<,>").
I<privilege> is C<write>, C<read> or C<hidden>.
Lines are checked in order, then matched line at the first time wins.
Default privilege may be specified with special parameter name C<default>.
=head1 FILES
=over
=item F<$DEFAULTDIR/edit_list.conf>
Distribution default. This file should not be edited.
=item F<$SYSCONFDIR/edit_list.conf>
=item F<$SYSCONFDIR/E<lt>mail domain nameE<gt>/edit_list.conf>
=item F<$EXPLDIR/E<lt>list nameE<gt>/edit_list.conf> or
F<$EXPLDIR/E<lt>mail domain nameE<gt>/E<lt>list nameE<gt>/edit_list.conf>
Configuration files for site-wide default, by each domain or each list.
=back
=head1 SEE ALSO
L<wwsympa(8)>.
=head1 HISTORY
This document was initially written by IKEDA Soji <ikeda@conversion.co.jp>.
=cut
=encoding utf-8
=head1 NAME
ldap_alias_manager.conf - Configuration of LDAP alias management
=head1 DESCRIPTION
F<ldap_alias_manager.conf> is used by the L<ldap_alias_manager(8)>;
it allows to manage mail aliases in an LDAP directory.
To make sympa use the ldap_alias_manager.pl script, you should edit the
'alias_manager' L<sympa.conf(5)> parameter.
Format of F<ldap_alias_manager.conf> is as following:
=over
=item *
Lines beginning with C<#> and containing only spaces are ignored.
=item *
Each line has the form "I<parameter> I<value>".
I<value> may contain spaces but may not contain newlines.
=back
=head2 Parameters
=over
=item ldap_host <host>
I<Mandatory>. LDAP server host.
Example:
ldap_host ldap.example.com
=item ldap_bind_dn <distinguished name>
I<Mandatory>. LDAP bind DN.
Example:
ldap_bind_dn cn=sympa,ou=services,dc=example,dc=com
=item ldap_bind_pwd <secret>
I<Mandatory>. LDAP bind password.
Example:
ldap_bind_pwd secret
=item ldap_base_dn <distinguished name>
I<Mandatory>. LDAP base DN.
Example:
ldap_base_dn ou=mail,dc=example,dc=com
=item ldap_mail_attribute <attribute name>
I<Mandatory>. LDAP mail attribute.
Example:
ldap_mail_attribute mail
=item ldap_ssl <0/1>
I<Mandatory>. Use TLS (SSL) for connection to LDAP server.
Example:
ldap_ssl 0
=item ldap_ssl_version <sslv2 /sslv3 / tlsv1 / tlsv1_1 / tlsv1_2>
I<Mandatory> if C<ldap_ssl> is C<1>. Protocol version of TLS.
Example:
ldap_ssl_version tlsv1
=item ldap_cachain <file path>
LDAP CA chain file
Example:
ldap_cachain /etc/ldap/cert/cachain.pem
=item queue_transport <name>
I<Mandatory>. Postfix transport parameter for queue
Example:
queue_transport sympa
=item bouncequeue_transport <name>
I<Mandatory>. Postfix transport parameter for bouncequeue
Example:
bouncequeue_transport sympabounce
=back
=head1 FILES
=over
=item F<$SYSCONFDIR/ldap_alias_manager.conf>
Configuration file.
=back
=head1 SEE ALSO
L<ldap_alias_manager(8)>.
=cut
=encoding utf-8
=head1 NAME
nrcpt_by_domain.conf - Grouping factor for SMTP sessions by recipient domains
=head1 DESCRIPTION
F<nrcpt_by_domain.conf> defines limit of the number of recipients for a
particular domain in each session.
TBD.
=head1 FILES
=over
=item F<$DEFAULTDIR/nrcpt_by_domain.conf>
Distribution default. This files should not be edited.
=item F<$SYSCONFDIR/nrcpt_by_domain.conf>
Configuration file.
=back
=head1 SEE ALSO
L<bulk(8)>,
L<sympa.conf(5)>.
=head1 HISTORY
This document was initially written by IKEDA Soji <ikeda@conversion.co.jp>.
=cut
=encoding utf-8
=head1 NAME
sympa.wsdl - Service description of SOAP HTTP interface for Sympa
=head1 DESCRIPTION
F<sympa.wsdl> defines services proveded by SOAP HTTP interface for Sympa.
TBD.
=head1 FILES
=over
=item F<$DEFAULTDIR/sympa.wsdl>
Distribution default. This file should not be edited.
=item F<$SYSCONFDIR/sympa.wsdl>
=item F<$SYSCONFDIR/E<lt>robot nameE<gt>/sympa.wsdl>
Configuration files for site-wide default and each robot.
=back
=head1 SEE ALSO
L<sympa_soap_server(8)>.
=head1 HISTORY
This document was initially written by IKEDA Soji <ikeda@conversion.co.jp>.
=cut
......@@ -182,18 +182,42 @@ SMTP / LMTP client
=over
=item L<auth.conf(5)>
Configuration of authentication mechanisms for web interface of Sympa
=item L<charset.conf(5)>
Configiration file for legacy character set support by Sympa
=item L<crawlers_detection.conf(5)>
User agents to be excluded from session management
=item L<edit_list.conf(5)>
Configuration of privileges to edit list configuration
=item L<ldap_alias_manager.conf(5)>
Configuration of LDAP alias management
=item L<list_config(5)>
Configuration file for mailing list
=item L<sympa.conf(5)>, L<robot.conf(5)>
=item L<nrcpt_by_domain.conf(5)>
Grouping factor for SMTP sessions by recipient domains
=item L<sympa.conf(5)>, robot.conf(5)
Configuration file for default site and robot
=item L<topics.conf(5)>
Configuration of list topics
=back
=head2 Internals
......
=encoding utf-8
=head1 NAME
topics.conf - Configuration of list topics
=head1 DESCRIPTION
F<topics.conf> defines topics (categories) of the mailing lists.
TBD
=head1 FILES
=over
=item F<$DEFAULTDIR/topics.conf>
Distribution default. This file should not be edited.
=item F<$SYSCONFDIR/topics.conf>
=item F<$SYSCONFDIR/E<lt>robot nameE<gt>/topics.conf>
Configuration files for site-wide default and each robot.
=back
=head1 SEE ALSO
L<wwsympa(8)>.
=head1 HISTORY
This document was initially written by IKEDA Soji <ikeda@conversion.co.jp>.
=cut
=encoding utf-8
=head1 NAME
trusted_applications.conf -
Defining applications of SOAP HTTP interface for Sympa
=head1 DESCRIPTION
F<trusted_applications.conf> defines applications of SOAP HTTP interface for
Sympa.
TBD.
=head1 FILES
=over
=item F<$SYSCONFDIR/E<lt>robot nameE<gt>/trusted_applications.conf>
Configuration files for each robot.
=back
=head1 SEE ALSO
L<wwsympa(8)>,
L<sympa_soap_server(8)>.
=head1 HISTORY
This document was initially written by IKEDA Soji <ikeda@conversion.co.jp>.
=cut