source: mailjam/README@ 27:b1d527287347

Last change on this file since 27:b1d527287347 was 27:b1d527287347, checked in by Borja Lopez <borja@…>, 13 years ago

Added more information to the README file

Updated the architecture scheme so it fits the renaming of the project
to mailjam

Fixed the search path for configuration files. Now it searches on /etc
first, /usr/local/etc then.

Added more docs regarding the installation, configuration and running
of each component

File size: 1.4 KB
Line 
1Mailjam - Mailing lists manager
2===============================
3
4.. contents::
5
6
7Introduction
8------------
9
10Mailjam is a mailing list manager. With it you will be able to create mailing
11lists and manage them.
12
13Mailjam requires a functional MTA [1]_ (Mailjam has been successfully tested
14with sendmail [2]_ and postfix [3]_ but it should work with other MTA software)
15
16Overview
17--------
18
19.. image:: docs/src/mailjam_architecture.png
20 :alt: Scheme of the architecture behind Mailjam
21
22Mailjam has been designed following a **multi-component structure**. There is
23**a daemon** that manage the mailing lists and members information in a storage
24backend and there are **different kinds of clients** (currently, three of them)
25that **interact with the daemon using a XMLRPC link**.
26
27More information here: http://readthedocs.org/docs/mailjam/en/latest/overview.html
28
29Install
30-------
31
32For installation instructions, please check the INSTALL file, or the
33documentation inside the docs/ subdirectory.
34
35You can read the installation instructions here:
36http://readthedocs.org/docs/mailjam/en/latest/install.html
37
38Documentation
39-------------
40
41The official documentation is available in the docs/ subdirectory, and
42you can read the docs online too (thnx to readthedocs.org [4]_):
43
44http://mailjam.readthedocs.org
45
46
47.. [1] http://en.wikipedia.org/wiki/Message_transfer_agent
48.. [2] http://sendmail.org
49.. [3] http://www.postfix.org
50.. [4] http://readthedocs.org
Note: See TracBrowser for help on using the repository browser.