Ignore:
Timestamp:
May 22, 2012, 9:31:15 AM (12 years ago)
Author:
Borja Lopez <borja@…>
Branch:
default
Phase:
public
Message:

Renamed the project to Mailjam

Location:
docs/src/_build/html/_sources
Files:
5 edited

Legend:

Unmodified
Added
Removed

  • docs/src/_build/html/_sources/configuration.txt

    r13 r16  
    66.. _configuration_daemon:
    77
    8 Postman daemon configuration file
     8Mailjam daemon configuration file
    99---------------------------------
    1010
    11 All the configurations that can be applied to the Postman daemon are registered
    12 in the **postman.conf** file. That file contains ini-style [1]_ configuration
     11All the configurations that can be applied to the Mailjam daemon are registered
     12in the **mailjam.conf** file. That file contains ini-style [1]_ configuration
    1313parameters, separated in different *categories*.
    1414
    1515.. note::
    1616
    17    The postman.conf file will be installed in different locations depending on
     17   The mailjam.conf file will be installed in different locations depending on
    1818   your setup. The usual locations are:
    1919
    20    - */etc/postman.conf* - In most Linux systems (like archlinux, gentoo,
     20   - */etc/mailjam.conf* - In most Linux systems (like archlinux, gentoo,
    2121     fedora, debian, ubuntu, etc)
    2222
    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,
    2424     NetBSD, etc)
    2525
    … …  
    7373*******
    7474
    75 Default: ``/usr/local/etc/postman/ssl/postman.key``
     75Default: ``/usr/local/etc/mailjam/ssl/mailjam.key``
    7676
    7777Path to the ssl key used for encrypted SSL sessions.
    … …  
    8686*******
    8787
    88 Default: ``/usr/local/etc/postman/ssl/postman.crt``
     88Default: ``/usr/local/etc/mailjam/ssl/mailjam.crt``
    8989
    9090Path to the ssl certificate used for encrypted SSL sessions.
    … …  
    9999*******
    100100
    101 Default: ``/var/log/postman/xmlrpc_server.log``
     101Default: ``/var/log/mailjam/xmlrpc_server.log``
    102102
    103103Path to the file where log messages will be saved
    … …  
    128128****
    129129
    130 Default: ``/usr/local/postman/storage``
     130Default: ``/usr/local/mailjam/storage``
    131131
    132132Path to the directory where the backend will save data.
    … …  
    137137********
    138138
    139 Default: ``/usr/local/postman/storage/mailings.json``
     139Default: ``/usr/local/mailjam/storage/mailings.json``
    140140
    141141Path to the file where the identifiers of existing mailing lists will be saved.
    … …  
    165165**********
    166166
    167 Default: ``/usr/local/postman/storage/members.json``
     167Default: ``/usr/local/mailjam/storage/members.json``
    168168
    169169Path to the file where the identifiers of existing members will be saved.
    … …  
    191191Default: ``true``
    192192
    193 Enables/disables the *archives* feature. When enabled, Postman saves copies of
     193Enables/disables the *archives* feature. When enabled, Mailjam saves copies of
    194194email address into an *archive*, so they can be read later, through a web
    195195interface.
    … …  
    220220****
    221221
    222 Default: ``/usr/local/postman/archives``
     222Default: ``/usr/local/mailjam/archives``
    223223
    224224Path to the directory where the archives will be saved.
    … …  
    238238.. warning::
    239239
    240    This parameters are not currently used in postman, we are still working
     240   This parameters are not currently used in mailjam, we are still working
    241241   on per-mailing-list configuration parameters.
    242242
    … …  
    265265.. warning::
    266266
    267    This parameters are not currently used in postman, we are still working
     267   This parameters are not currently used in mailjam, we are still working
    268268   on per-member configuration parameters.
    269269

  • docs/src/_build/html/_sources/index.txt

    r13 r16  
    1 Postman official documentation
     1Mailjam official documentation
    22==============================
    33
    4 This is the official documentation for Postman_, a mailing list management
     4This is the official documentation for Mailjam_, a mailing list management
    55software written in Python_.
    66
    … …  
    2525* :ref:`search`
    2626
    27 .. _Postman: https://bitbucket.org/codigo23/postman
     27.. _Mailjam: https://bitbucket.org/codigo23/mailjam
    2828.. _Python: http://python.org

  • docs/src/_build/html/_sources/install.txt

    r13 r16  
    99---------------------------
    1010
    11 So far, the only dependency you will need in order to run postman is Python_
     11So far, the only dependency you will need in order to run mailjam is Python_
    1212
    13 Postman has been tested with python *2.7.x*, but it should work with versions
     13Mailjam has been tested with python *2.7.x*, but it should work with versions
    1414*2.6.x* too.
    1515
    … …  
    1717more about how to install python.
    1818
    19 .. _install_postman:
     19.. _install_mailjam:
    2020
    21 Second, install Postman
     21Second, install Mailjam
    2222-----------------------
    2323
    … …  
    2727++++++++++++++++++++
    2828
    29 You can install Postman using pip_::
     29You can install Mailjam using pip_::
    3030
    31   pip install -e https://bitbucket.org/codigo23/postman#egg=postman
     31  pip install -e https://bitbucket.org/codigo23/mailjam#egg=mailjam
    3232
    3333.. note::
    3434
    35    Postman 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 Postman repo.
     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.
    3737
    3838.. _install_with_easy_install:
    … …  
    4141+++++++++++++++++++++++++++++
    4242
    43 You can not install Postman using easy_install_ yet (until we do record/upload
     43You can not install Mailjam using easy_install_ yet (until we do record/upload
    4444it to pypi)
    4545
    … …  
    4949++++++++++++++++++++++++++++++
    5050
    51 You can install Postman inside a virtualenv_. Just create a virtualenv::
     51You can install Mailjam inside a virtualenv_. Just create a virtualenv::
    5252
    5353  virtualenv /path/to/your/env
    … …  
    6464     source /path/to/your/env/bin/activate.csh
    6565
    66 And, once the environment has been activated, use pip to install Postman::
     66And, once the environment has been activated, use pip to install Mailjam::
    6767
    68   env$ pip install -e https://bitbucket.org/codigo23/postman#egg=postman
     68  env$ pip install -e https://bitbucket.org/codigo23/mailjam#egg=mailjam
    6969
    7070.. _install_from_sources:
    … …  
    8989***************
    9090
    91 The source code of Postman is hosted in bitbucket_ [1]_. In order to grab
     91The source code of Mailjam is hosted in bitbucket_ [1]_. In order to grab
    9292the latest sources you need Mercurial_.
    9393
    9494To get a copy of the sources, just *clone* the repository::
    9595
    96   hg clone https://bitbucket.org/codigo23/postman postman-repo
     96  hg clone https://bitbucket.org/codigo23/mailjam mailjam-repo
    9797
    98 Then, go inside the *postman-repo* directory and run::
     98Then, go inside the *mailjam-repo* directory and run::
    9999
    100100  python setup.py install
    … …  
    110110   This process will work inside a virtualenv_ too.
    111111
    112 .. _install_setting_up_postman:
     112.. _install_setting_up_mailjam:
    113113
    114 Setting up Postman
     114Setting up Mailjam
    115115------------------
    116116
    117117TBW
    118118
    119 .. _install_running_postman:
     119.. _install_running_mailjam:
    120120
    121 Running Postman
     121Running Mailjam
    122122---------------
    123123
    … …  
    140140.. _sudo: http://sudo.ws
    141141
    142 .. [1] https://bitbucket.org/codigo23/postman
     142.. [1] https://bitbucket.org/codigo23/mailjam

  • docs/src/_build/html/_sources/overview.txt

    r13 r16  
    1 Overview of postman's architecture
     1Overview of mailjam's architecture
    22==================================
    33
    … …  
    77------------
    88
    9 Postman has been designed following a **multi-component structure**. There is
     9Mailjam has been designed following a **multi-component structure**. There is
    1010**a daemon** that manage the mailing lists and members information in a storage
    1111backend and there are **different kinds of clients** (currently, three of them)
    … …  
    1414This is the scheme of the architecture:
    1515
    16 .. image:: /postman_architecture.png
    17    :alt: Scheme of the architecture behind Postman
     16.. image:: /mailjam_architecture.png
     17   :alt: Scheme of the architecture behind Mailjam
    1818   :class: open_fancybox
    1919
    2020
    21 .. _overview_postman_daemon:
     21.. _overview_mailjam_daemon:
    2222
    23 Postman daemon
     23Mailjam daemon
    2424--------------
    2525
    … …  
    3232to add/update/delete data from the backend.
    3333
    34 .. _overview_postman_mta_client:
     34.. _overview_mailjam_mta_client:
    3535
    3636MTA client
    … …  
    4141backend to tell the MTA what it has to do with the incoming emails.
    4242
    43 .. _overview_postman_cli_client:
     43.. _overview_mailjam_cli_client:
    4444
    4545CLI client
    … …  
    4747
    4848This is a shell-like interface that can be used to add mailing lists to a given
    49 Postman server, edit such mailing lists information, add members, etc.
     49Mailjam server, edit such mailing lists information, add members, etc.
    5050
    51 .. _overview_postman_web_client:
     51.. _overview_mailjam_web_client:
    5252
    5353Web client
    … …  
    5656This is a small *webapp* that can be used to perform the same management
    5757operations 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 Postman
     1Running Mailjam
    22===============
    33
Note: See TracChangeset for help on using the changeset viewer.