source: mailjam/README

Last change on this file was 30:0cdc4f160073, checked in by Borja Lopez <borja@…>, 12 years ago

Fixed the link to the scheme in the README file so the image appears on bitbucket's overview page. Acvitated the setup.py code that copies the config files to proper places when installing from sources

File size: 1.4 KB
RevLine 
[16]1Mailjam - Mailing lists manager
[3]2===============================
3
4.. contents::
5
6
7Introduction
8------------
9
[16]10Mailjam is a mailing list manager. With it you will be able to create mailing
[3]11lists and manage them.
12
[16]13Mailjam requires a functional MTA [1]_ (Mailjam has been successfully tested
[3]14with sendmail [2]_ and postfix [3]_ but it should work with other MTA software)
15
[27]16Overview
17--------
18
[30]19.. image:: mailjam/raw/b1d527287347/docs/src/mailjam_architecture.png
[27]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
[3]28
29Install
30-------
31
32For installation instructions, please check the INSTALL file, or the
33documentation inside the docs/ subdirectory.
34
[27]35You can read the installation instructions here:
36http://readthedocs.org/docs/mailjam/en/latest/install.html
[3]37
[27]38Documentation
39-------------
[19]40
[27]41The official documentation is available in the docs/ subdirectory, and
42you can read the docs online too (thnx to readthedocs.org [4]_):
[19]43
44http://mailjam.readthedocs.org
[3]45
46
47.. [1] http://en.wikipedia.org/wiki/Message_transfer_agent
48.. [2] http://sendmail.org
49.. [3] http://www.postfix.org
[19]50.. [4] http://readthedocs.org
Note: See TracBrowser for help on using the repository browser.