Skip to content
GitLab
Menu
Projects
Groups
Snippets
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Sign in
Toggle navigation
Menu
Open sidebar
Projets publics
Sympa
Commits
a526c481
Commit
a526c481
authored
Mar 28, 2018
by
IKEDA Soji
Browse files
Documentation site was moved:
http://www.sympa.org/manual/
to
https://sympa-community.github.io/manual/
parent
b4a5c4f1
Changes
16
Hide whitespace changes
Inline
Side-by-side
INSTALL.md
View file @
a526c481
Reference manual
================
This document is only a quick start.
For detailed installation / setup information, refer to the reference manual :
To install Sympa, see Sympa Administration Manual:
*
https://www.sympa.org/manual/
Requirements
============
Sympa requires other applications to run :
*
Perl and GCC C compiler. You may have to use Gnu make
*
MTA (Sendmail, Postfix, exim and qmail supported)
*
relational database (MySQL / MariaDB, PostgreSQL, Oracle Database and
SQLite supported)
*
web server (Apache HTTP Server, nginx or another web server)
*
FastCGI (e.g. mod_fcgid for Apache)
*
many Perl modules : they may be installed by
``sympa_wizard.pl --check``
described below
Installing Sympa from sources
=============================
(If you get sources from git repository, first run:
``autoreconf -i``
)
Create a dedicated user
``sympa``
:
``sympa``
(and it's home directory) and run
```
./configure (options); make; make install
```
Then check dependent modules
```
sympa_wizard.pl --check
```
This wizard will propose that you upgrade some CPAN modules.
In this case you'll need to be root.
Some Perl modules require additionnal libraries, for example :
-
XML::LibXML requires libxml2 library and headers
-
Net::SSLeay requires openssl libraries and headers
Setup
=====
1.
Sympa setup
You can edit
``sympa.conf``
manually or run
``sympa_wizard.pl``
that will
help you create your configuration files.
2.
Syslog setup (syslogd)
Default for Sympa is to log in 'local1' (you can configure this in
``sympa.conf``
).
You should add the following line to your
``syslog.conf``
file :
```
local1.* /var/log/sympa
```
On Solaris (7 & 8) and True64, the '.
*
' level is not recognized in
``syslog.conf```.
You need to enumerate levels :
```
local1.info,local1.notice,local1.debug /var/log/sympa
```
3. Database setup (MySQL)
Your MySQL version MUST be at least 4.1.1 in order to run correctly with
Sympa.
db_xxx parameters in ``sympa.conf`` refer to your local database.
You'll have to create dedicated database user ``sympa``,
creata an empty database and provide access to this user.
Then create table structure:
```
sympa.pl --health_check
```
4. Mail aliases setup (Sendmail)
Sympa will use a dedicated alias file for its own mail aliases, default is
``/etc/mail/sympa_aliases``.
You have to configure your MTA (Sendmail, Postfix, ...) to use this file.
You should also create the main Sympa aliases ; they will look like this :
```
sympa: "| /home/sympa/bin/queue sympa@my.domain.org"
listmaster: "| /home/sympa/bin/queue listmaster@my.domain.org"
bounce+*: "| /home/sympa/bin/bouncequeue sympa@my.domain.org"
sympa-request: postmaster
sympa-owner: postmaster
```
(Later mailing lists aliases will be installed automatically by Sympa)
5. Web setup (Apache)
You should add these lines to your ``httpd.conf`` file :
```
Alias /static-sympa /home/sympa/static_content
ScriptAlias /sympa /home/sympa/bin/wwsympa-wrapper.fcgi
<IfModule mod_fcgid.c>
AddHandler fcgid-script .fcgi
</IfModule>
```
To login with listmaster privileges, you should login on the web
interface with the email address you declared in ``sympa.conf`
`
. To get an
initial password just hit the "First login" button.
*
https://sympa-community.github.io/manual/install.html
Makefile.am
View file @
a526c481
...
...
@@ -169,7 +169,7 @@ installconfig: installdir sympa_wizard.pl.inst
nextstep
:
@
echo
""
@
echo
"** You can find documentation at:"
@
echo
"** http://
www.
sympa
.org
/manual/"
@
echo
"** http
s
://sympa
-community.github.io
/manual/"
@
echo
""
@
echo
"#########################################################"
@
echo
"# CHECK YOU HAVE ALL THE NEEDED MODULES:"
...
...
README.md
View file @
a526c481
...
...
@@ -10,7 +10,7 @@ lists. For a list with 20 000 subscribers, it takes 5 minutes to send a
message to 90% of subscribers, of course considering that the network is
available.
Documentation: https://
www.
sympa
.org/manual
/
Documentation: https://sympa
-community.github.io
/
------------------------------------------------------------------------------
...
...
@@ -23,7 +23,7 @@ adapté aux grandes listes. Avec une liste de 20 000 abonnés, il faut 5
minutes pour envoyer un message à 90% des abonnés, lorsque le réseau est
disponible bien évidemment.
La documentation : https://
www.
sympa
.org/manual
/
La documentation : https://sympa
-community.github.io
/
------------------------------------------------------------------------------
...
...
doc/list_config.podpl
View file @
a526c481
...
...
@@ -358,7 +358,7 @@ List main configuration file.
L<sympa.conf(5)>.
I<Sympa
, Mailing List Management Software - Reference
Manual>.
L<http://
www.
sympa
.org
/manual/>.
I<Sympa
Administration
Manual>.
L<http
s
://sympa
-community.github.io
/manual/>.
=cut
doc/samples/sampleClient.php
View file @
a526c481
<?php
// Just a simple example of a PHP SOAP client for Sympa.
// You can check the Sympa SOAP API definition to design more complex code : http://www.sympa.org/manual/soap
// You can check the Sympa SOAP API definition to design more complex code:
// https://sympa-community.github.io/manual/customize/soap-api.html
//
// You need to install the php-soap module.
// If you are on a Fedora Core server, you can run "yum install php-soap"
...
...
@@ -145,7 +146,7 @@ echo "<P ALIGN=\"right\">
<TR><TD ALIGN=
\"
left
\"
>
<I><center>This is a sample PHP interface for Sympa using SOAP (<A HREF=
\"
"
.
$_SERVER
[
'PHP_SELF'
]
.
"?viewSource=1
\"
>View source</A>)</center></I>
</TD><TD ALIGN=
\"
right
\"
>
<A HREF=
\"
http://www.sympa.org
\"
><IMG BORDER=
\"
0
\"
SRC=
\"
http://
www
.sympa.org/
logo
s/logo
-
sympa
-150x49.gif
\"
></A></TD>
<A HREF=
\"
http://www.sympa.org
\"
><IMG BORDER=
\"
0
\"
SRC=
\"
http://
demo
.sympa.org/
static-sympa/icon
s/logo
_
sympa
.png
\"
></A></TD>
</TABLE>
</P>"
;
...
...
doc/sympa.conf.podpl
View file @
a526c481
...
...
@@ -218,7 +218,7 @@ Configuration specific to each list.
=head1 SEE ALSO
I<Sympa
, Mailing List Management Software - Reference
Manual>.
L<http://
www.
sympa
.org
/manual/>.
I<Sympa
Administration
Manual>.
L<http
s
://sympa
-community.github.io
/manual/>.
=cut
doc/sympa_database.podpl
View file @
a526c481
...
...
@@ -65,7 +65,7 @@ MySQL/MariaDB. Corresponding types are used by other platforms
=head1 SEE ALSO
I<Sympa
and its database
>.
L<https://
www.
sympa
.org/manual/database
>.
I<Sympa
Administration Manual
>.
L<https://sympa
-community.github.io/manual/
>.
=cut
doc/sympa_toc.pod
View file @
a526c481
...
...
@@ -23,9 +23,9 @@ Below is the list of documentation of Sympa.
=over
=item I<Sympa
, Mailing List Management Software - Reference m
anual>
=item I<Sympa
Administration M
anual>
L<http://
www.
sympa
.org
/manual/>.
L<http
s
://sympa
-community.github.io
/manual/>.
=back
...
...
@@ -236,15 +236,16 @@ Structure of Sympa core database
=head1 AVAILABILITY
Latest version of B<Sympa> is available from L<http://www.sympa.org/>.
Latest version of B<Sympa> is available from
L<https://github.com/sympa-community/sympa/releases>.
=head1 MORE DOCUMENTATION
The full documentation in HTML format can be found in
L<http://
www.
sympa
.org
/manual/>.
L<http
s
://sympa
-community.github.io
/manual/>.
The mailing lists (with web archives) can be accessed at
L<http://listes.renater.fr/sympa/lists/informatique/sympa>.
L<http
s
://listes.renater.fr/sympa/lists/informatique/sympa>.
=head1 BUGS
...
...
src/cgi/sympa_soap_server.fcgi.in
View file @
a526c481
...
...
@@ -9,8 +9,8 @@
# Copyright (c) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
# 2006, 2007, 2008, 2009, 2010, 2011 Comite Reseau des Universites
# Copyright (c) 2011, 2012, 2013, 2014, 2015, 2016, 2017 GIP RENATER
# Copyright 2017 The Sympa Community. See the AUTHORS.md file at the
top-level
# directory of this distribution and at
# Copyright 2017
, 2018
The Sympa Community. See the AUTHORS.md file at the
#
top-level
directory of this distribution and at
# <https://github.com/sympa-community/sympa.git>.
#
# This program is free software; you can redistribute it and/or modify
...
...
@@ -96,8 +96,8 @@ sympa_soap_server, sympa_soap_server.fcgi - Sympa SOAP server
Sympa SOAP server allows one to access Sympa service though SOAP.
To know details on Sympa SOAP server, see
Reference
Manual:
L<https://
www.
sympa
.org/manual/soap
>.
To know details on Sympa SOAP server, see
Sympa Administration
Manual:
L<https://sympa
-community.github.io/manual/customize/soap-api.html
>.
=head1 HISTORY
...
...
src/cgi/wwsympa.fcgi.in
View file @
a526c481
...
...
@@ -17173,8 +17173,8 @@ wwsympa, wwsympa.fcgi - WWSympa, Sympa's web interface
This FastCGI script completely handles all aspects of the Sympa web interface.
To know details on WWSympa, see
Reference
Manual:
L<https://
www.
sympa
.org/manual/web-interface
>.
To know details on WWSympa, see
Sympa Administration
Manual:
L<https://sympa
-community.github.io/manual/
>.
=head1 HISTORY
...
...
src/lib/Sympa/Internals.podpl
View file @
a526c481
...
...
@@ -65,7 +65,7 @@ See L<Sympa::Internals::Workflow>.
L<sympa_toc(1)>.
I<Sympa
, Mailing List Management Software - Reference
Manual>.
L<https://
www.
sympa
.org
/manual/>.
I<Sympa
Administration
Manual>.
L<https://sympa
-community.github.io
/manual/>.
=cut
src/lib/Sympa/Template.pm
View file @
a526c481
...
...
@@ -8,8 +8,8 @@
# Copyright (c) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
# 2006, 2007, 2008, 2009, 2010, 2011 Comite Reseau des Universites
# Copyright (c) 2011, 2012, 2013, 2014, 2015, 2016, 2017 GIP RENATER
# Copyright 2017 The Sympa Community. See the AUTHORS.md file at the
top-level
# directory of this distribution and at
# Copyright 2017
, 2018
The Sympa Community. See the AUTHORS.md file at the
#
top-level
directory of this distribution and at
# <https://github.com/sympa-community/sympa.git>.
#
# This program is free software; you can redistribute it and/or modify
...
...
@@ -730,8 +730,8 @@ extracted during packaging process and are added to translation catalog.
=head2 Plugins
Plugins may be placed under F<LIBDIR/Sympa/Template/Plugin>.
See <https://
www.
sympa
.org/manual
/template
s_
plugins
> about usage of
plugins.
See <https://sympa
-community.github.io/manual/customize
/template
-
plugins
.html>
about usage of
plugins.
=head1 SEE ALSO
...
...
src/libexec/alias_manager.pl.in
View file @
a526c481
...
...
@@ -13,8 +13,8 @@
# Copyright (c) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
# 2006, 2007, 2008, 2009, 2010, 2011 Comite Reseau des Universites
# Copyright (c) 2011, 2012, 2013, 2014, 2015, 2016, 2017 GIP RENATER
# Copyright 2017 The Sympa Community. See the AUTHORS.md file at the
top-level
# directory of this distribution and at
# Copyright 2017
, 2018
The Sympa Community. See the AUTHORS.md file at the
#
top-level
directory of this distribution and at
# <https://github.com/sympa-community/sympa.git>.
#
# This program is free software; you can redistribute it and/or modify
...
...
@@ -151,10 +151,10 @@ F<$SENDMAIL_ALIASES> sendmail aliases file.
=head1 DOCUMENTATION
The full documentation in HTML formats can be
found in L<http://
www.
sympa
.org
/manual/>.
found in L<http
s
://sympa
-community.github.io
/manual/>.
The mailing lists (with web archives) can be accessed at
http://listes.renater.fr/sympa/lists/informatique/sympa.
http
s
://listes.renater.fr/sympa/lists/informatique/sympa.
=head1 HISTORY
...
...
src/sbin/archived.pl.in
View file @
a526c481
...
...
@@ -9,8 +9,8 @@
# Copyright (c) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
# 2006, 2007, 2008, 2009, 2010, 2011 Comite Reseau des Universites
# Copyright (c) 2011, 2012, 2013, 2014, 2015, 2016, 2017 GIP RENATER
# Copyright 2017 The Sympa Community. See the AUTHORS.md file at the
top-level
# directory of this distribution and at
# Copyright 2017
, 2018
The Sympa Community. See the AUTHORS.md file at the
#
top-level
directory of this distribution and at
# <https://github.com/sympa-community/sympa.git>.
#
# This program is free software; you can redistribute it and/or modify
...
...
@@ -291,11 +291,11 @@ of F<archived.pl>.
=head1 MORE DOCUMENTATION
The full documentation in HTML
and PDF
format
s
can be found in
L<http://
www.
sympa
.org
/manual/>.
The full documentation in HTML format can be found in
L<http
s
://sympa
-community.github.io
/manual/>.
The mailing lists (with web archives) can be accessed at
L<http://listes.renater.fr/sympa/lists/informatique/sympa>.
L<http
s
://listes.renater.fr/sympa/lists/informatique/sympa>.
=head1 HISTORY
...
...
src/sbin/bounced.pl.in
View file @
a526c481
...
...
@@ -9,8 +9,8 @@
# Copyright (c) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
# 2006, 2007, 2008, 2009, 2010, 2011 Comite Reseau des Universites
# Copyright (c) 2011, 2012, 2013, 2014, 2015, 2016, 2017 GIP RENATER
# Copyright 2017 The Sympa Community. See the AUTHORS.md file at the
top-level
# directory of this distribution and at
# Copyright 2017
, 2018
The Sympa Community. See the AUTHORS.md file at the
#
top-level
directory of this distribution and at
# <https://github.com/sympa-community/sympa.git>.
#
# This program is free software; you can redistribute it and/or modify
...
...
@@ -288,10 +288,10 @@ of F<bounced.pl>.
=head1 MORE DOCUMENTATION
The full documentation can be
found in L<http://
www.
sympa
.org
/manual/>.
found in L<http
s
://sympa
-community.github.io
/manual/>.
The mailing lists (with web archives) can be accessed at
L<http://listes.renater.fr/sympa/lists/informatique/sympa>.
L<http
s
://listes.renater.fr/sympa/lists/informatique/sympa>.
=head1 HISTORY
...
...
src/sbin/task_manager.pl.in
View file @
a526c481
...
...
@@ -2193,11 +2193,11 @@ of F<task_manager.pl>.
=head1 MORE DOCUMENTATION
The full documentation in HTML
and PDF
format
s
can be
found in L<http://
www.
sympa
.org
/manual/>.
The full documentation in HTML format can be
found in L<http
s
://sympa
-community.github.io
/manual/>.
The mailing lists (with web archives) can be accessed at
L<http://listes.renater.fr/sympa/lists/informatique/sympa>.
L<http
s
://listes.renater.fr/sympa/lists/informatique/sympa>.
=head1 BUGS
...
...
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment