Changeset 16:cd4170142d87 in mailjam for docs/src/_build/html/_sources
- Timestamp:
- May 22, 2012, 9:31:15 AM (12 years ago)
- Branch:
- default
- Phase:
- public
- Location:
- docs/src/_build/html/_sources
- Files:
-
- 5 edited
Legend:
- Unmodified
- Added
- Removed
-
docs/src/_build/html/_sources/configuration.txt
r13 r16 6 6 .. _configuration_daemon: 7 7 8 Postmandaemon configuration file8 Mailjam daemon configuration file 9 9 --------------------------------- 10 10 11 All the configurations that can be applied to the Postmandaemon are registered12 in the ** postman.conf** file. That file contains ini-style [1]_ configuration11 All the configurations that can be applied to the Mailjam daemon are registered 12 in the **mailjam.conf** file. That file contains ini-style [1]_ configuration 13 13 parameters, separated in different *categories*. 14 14 15 15 .. note:: 16 16 17 The postman.conf file will be installed in different locations depending on17 The mailjam.conf file will be installed in different locations depending on 18 18 your setup. The usual locations are: 19 19 20 - */etc/ postman.conf* - In most Linux systems (like archlinux, gentoo,20 - */etc/mailjam.conf* - In most Linux systems (like archlinux, gentoo, 21 21 fedora, debian, ubuntu, etc) 22 22 23 - */usr/local/etc/ postman.conf* - In most BSD systems (like FreeBSD, OpenBSD,23 - */usr/local/etc/mailjam.conf* - In most BSD systems (like FreeBSD, OpenBSD, 24 24 NetBSD, etc) 25 25 … … 73 73 ******* 74 74 75 Default: ``/usr/local/etc/ postman/ssl/postman.key``75 Default: ``/usr/local/etc/mailjam/ssl/mailjam.key`` 76 76 77 77 Path to the ssl key used for encrypted SSL sessions. … … 86 86 ******* 87 87 88 Default: ``/usr/local/etc/ postman/ssl/postman.crt``88 Default: ``/usr/local/etc/mailjam/ssl/mailjam.crt`` 89 89 90 90 Path to the ssl certificate used for encrypted SSL sessions. … … 99 99 ******* 100 100 101 Default: ``/var/log/ postman/xmlrpc_server.log``101 Default: ``/var/log/mailjam/xmlrpc_server.log`` 102 102 103 103 Path to the file where log messages will be saved … … 128 128 **** 129 129 130 Default: ``/usr/local/ postman/storage``130 Default: ``/usr/local/mailjam/storage`` 131 131 132 132 Path to the directory where the backend will save data. … … 137 137 ******** 138 138 139 Default: ``/usr/local/ postman/storage/mailings.json``139 Default: ``/usr/local/mailjam/storage/mailings.json`` 140 140 141 141 Path to the file where the identifiers of existing mailing lists will be saved. … … 165 165 ********** 166 166 167 Default: ``/usr/local/ postman/storage/members.json``167 Default: ``/usr/local/mailjam/storage/members.json`` 168 168 169 169 Path to the file where the identifiers of existing members will be saved. … … 191 191 Default: ``true`` 192 192 193 Enables/disables the *archives* feature. When enabled, Postmansaves copies of193 Enables/disables the *archives* feature. When enabled, Mailjam saves copies of 194 194 email address into an *archive*, so they can be read later, through a web 195 195 interface. … … 220 220 **** 221 221 222 Default: ``/usr/local/ postman/archives``222 Default: ``/usr/local/mailjam/archives`` 223 223 224 224 Path to the directory where the archives will be saved. … … 238 238 .. warning:: 239 239 240 This parameters are not currently used in postman, we are still working240 This parameters are not currently used in mailjam, we are still working 241 241 on per-mailing-list configuration parameters. 242 242 … … 265 265 .. warning:: 266 266 267 This parameters are not currently used in postman, we are still working267 This parameters are not currently used in mailjam, we are still working 268 268 on per-member configuration parameters. 269 269 -
docs/src/_build/html/_sources/index.txt
r13 r16 1 Postmanofficial documentation1 Mailjam official documentation 2 2 ============================== 3 3 4 This is the official documentation for Postman_, a mailing list management4 This is the official documentation for Mailjam_, a mailing list management 5 5 software written in Python_. 6 6 … … 25 25 * :ref:`search` 26 26 27 .. _ Postman: https://bitbucket.org/codigo23/postman27 .. _Mailjam: https://bitbucket.org/codigo23/mailjam 28 28 .. _Python: http://python.org -
docs/src/_build/html/_sources/install.txt
r13 r16 9 9 --------------------------- 10 10 11 So far, the only dependency you will need in order to run postmanis Python_11 So far, the only dependency you will need in order to run mailjam is Python_ 12 12 13 Postmanhas been tested with python *2.7.x*, but it should work with versions13 Mailjam has been tested with python *2.7.x*, but it should work with versions 14 14 *2.6.x* too. 15 15 … … 17 17 more about how to install python. 18 18 19 .. _install_ postman:19 .. _install_mailjam: 20 20 21 Second, install Postman21 Second, install Mailjam 22 22 ----------------------- 23 23 … … 27 27 ++++++++++++++++++++ 28 28 29 You can install Postmanusing pip_::29 You can install Mailjam using pip_:: 30 30 31 pip install -e https://bitbucket.org/codigo23/ postman#egg=postman31 pip install -e https://bitbucket.org/codigo23/mailjam#egg=mailjam 32 32 33 33 .. note:: 34 34 35 Postmanhas not been recorded/uploaded to pypi_ yet, so, in order to install36 it using pip you will have to provide the URL for the public Postmanrepo.35 Mailjam has not been recorded/uploaded to pypi_ yet, so, in order to install 36 it using pip you will have to provide the URL for the public Mailjam repo. 37 37 38 38 .. _install_with_easy_install: … … 41 41 +++++++++++++++++++++++++++++ 42 42 43 You can not install Postmanusing easy_install_ yet (until we do record/upload43 You can not install Mailjam using easy_install_ yet (until we do record/upload 44 44 it to pypi) 45 45 … … 49 49 ++++++++++++++++++++++++++++++ 50 50 51 You can install Postmaninside a virtualenv_. Just create a virtualenv::51 You can install Mailjam inside a virtualenv_. Just create a virtualenv:: 52 52 53 53 virtualenv /path/to/your/env … … 64 64 source /path/to/your/env/bin/activate.csh 65 65 66 And, once the environment has been activated, use pip to install Postman::66 And, once the environment has been activated, use pip to install Mailjam:: 67 67 68 env$ pip install -e https://bitbucket.org/codigo23/ postman#egg=postman68 env$ pip install -e https://bitbucket.org/codigo23/mailjam#egg=mailjam 69 69 70 70 .. _install_from_sources: … … 89 89 *************** 90 90 91 The source code of Postmanis hosted in bitbucket_ [1]_. In order to grab91 The source code of Mailjam is hosted in bitbucket_ [1]_. In order to grab 92 92 the latest sources you need Mercurial_. 93 93 94 94 To get a copy of the sources, just *clone* the repository:: 95 95 96 hg clone https://bitbucket.org/codigo23/ postman postman-repo96 hg clone https://bitbucket.org/codigo23/mailjam mailjam-repo 97 97 98 Then, go inside the * postman-repo* directory and run::98 Then, go inside the *mailjam-repo* directory and run:: 99 99 100 100 python setup.py install … … 110 110 This process will work inside a virtualenv_ too. 111 111 112 .. _install_setting_up_ postman:112 .. _install_setting_up_mailjam: 113 113 114 Setting up Postman114 Setting up Mailjam 115 115 ------------------ 116 116 117 117 TBW 118 118 119 .. _install_running_ postman:119 .. _install_running_mailjam: 120 120 121 Running Postman121 Running Mailjam 122 122 --------------- 123 123 … … 140 140 .. _sudo: http://sudo.ws 141 141 142 .. [1] https://bitbucket.org/codigo23/ postman142 .. [1] https://bitbucket.org/codigo23/mailjam -
docs/src/_build/html/_sources/overview.txt
r13 r16 1 Overview of postman's architecture1 Overview of mailjam's architecture 2 2 ================================== 3 3 … … 7 7 ------------ 8 8 9 Postmanhas been designed following a **multi-component structure**. There is9 Mailjam has been designed following a **multi-component structure**. There is 10 10 **a daemon** that manage the mailing lists and members information in a storage 11 11 backend and there are **different kinds of clients** (currently, three of them) … … 14 14 This is the scheme of the architecture: 15 15 16 .. image:: / postman_architecture.png17 :alt: Scheme of the architecture behind Postman16 .. image:: /mailjam_architecture.png 17 :alt: Scheme of the architecture behind Mailjam 18 18 :class: open_fancybox 19 19 20 20 21 .. _overview_ postman_daemon:21 .. _overview_mailjam_daemon: 22 22 23 Postmandaemon23 Mailjam daemon 24 24 -------------- 25 25 … … 32 32 to add/update/delete data from the backend. 33 33 34 .. _overview_ postman_mta_client:34 .. _overview_mailjam_mta_client: 35 35 36 36 MTA client … … 41 41 backend to tell the MTA what it has to do with the incoming emails. 42 42 43 .. _overview_ postman_cli_client:43 .. _overview_mailjam_cli_client: 44 44 45 45 CLI client … … 47 47 48 48 This is a shell-like interface that can be used to add mailing lists to a given 49 Postmanserver, edit such mailing lists information, add members, etc.49 Mailjam server, edit such mailing lists information, add members, etc. 50 50 51 .. _overview_ postman_web_client:51 .. _overview_mailjam_web_client: 52 52 53 53 Web client … … 56 56 This is a small *webapp* that can be used to perform the same management 57 57 operations you can achieve using the 58 :ref:`CLI client<overview_ postman_cli_client>`.58 :ref:`CLI client<overview_mailjam_cli_client>`. -
docs/src/_build/html/_sources/running.txt
r13 r16 1 Running Postman1 Running Mailjam 2 2 =============== 3 3
Note:
See TracChangeset
for help on using the changeset viewer.