Index: docs/src/_build/html/configuration.html =================================================================== --- docs/src/_build/html/configuration.html (revision 16) +++ docs/src/_build/html/configuration.html (revision 27) @@ -53,52 +53,85 @@
-

Configuration

+

Configuration

+

Mailjam has separate configuration files for the different apps (the daemon and +the variety of different clients available). Check below to read more about the +configuration file you need to modify depending on what you want to do.

Contents

-
-
-

Mailjam daemon configuration file

-

All the configurations that can be applied to the Mailjam daemon are registered -in the mailjam.conf file. That file contains ini-style [1] configuration -parameters, separated in different categories.

+
  • Configuration +
    • + +
    +
    +

    Mailjam daemon configuration file - mailjam.conf

    +

    All the configurations that can be applied to the Mailjam daemon +are registered in the mailjam.conf file. That file contains ini-style [1] +configuration parameters, separated in different categories.

    Note

    @@ -106,8 +139,8 @@ your setup. The usual locations are:

      -
    • /etc/mailjam.conf - In most Linux systems (like archlinux, gentoo, -fedora, debian, ubuntu, etc)
      • -
    • /usr/local/etc/mailjam.conf - In most BSD systems (like FreeBSD, OpenBSD, -NetBSD, etc)
      • +
    • /etc/mailjam/mailjam.conf - In most Linux systems (like archlinux, +gentoo, fedora, debian, ubuntu, etc)
      • +
    • /usr/local/etc/mailjam/mailjam.conf - In most BSD systems (like FreeBSD, +OpenBSD, NetBSD, etc)

    There is a copy of the configuration file in the conf/ directory, within @@ -115,10 +148,10 @@

    -

    xmlrpc_server

    +

    xmlrpc_server

    This section contains the configuration parameters that modify the behaviour of -the daemon when serving content through XMLRPC [2].

    +the daemon when serving content through XMLRPC [2].

    These are all the available parameters in this section:

    -

    address

    +

    address

    Default: localhost

    The address where the daemon will be listening for XMLRPC requests. Use * @@ -127,17 +160,17 @@

    -

    port

    +

    port

    Default: 9876

    The port where the daemon will be listening por XMLRPC requests.

    -

    ssl

    -

    Default: off (because ssl support hasn’t been added yet)

    -

    Enables/disables SSL [3] support in the daemon. If off all the traffic -to/from the server will travel unencrypted. If on all the traffic will +

    ssl

    +

    Default: false (because ssl support hasn’t been added yet)

    +

    Enables/disables SSL [3] support in the daemon. If false all the traffic +to/from the server will travel unencrypted. If true all the traffic will travel encrypted.

    -

    ssl_key

    +

    ssl_key

    Default: /usr/local/etc/mailjam/ssl/mailjam.key

    Path to the ssl key used for encrypted SSL sessions.

    @@ -148,5 +181,5 @@
    -

    ssl_crt

    +

    ssl_crt

    Default: /usr/local/etc/mailjam/ssl/mailjam.crt

    Path to the ssl certificate used for encrypted SSL sessions.

    @@ -157,5 +190,5 @@
    -

    logfile

    +

    logfile

    Default: /var/log/mailjam/xmlrpc_server.log

    Path to the file where log messages will be saved

    @@ -163,10 +196,10 @@
    -

    storage

    +

    storage

    This section contains the configuration parameters that modify the way the daemon saves data to disk, using one of the storage backends.

    These are all the available parameters in this section:

    -

    backend

    +

    backend

    Default: json

    Sets the type of backend the daemon is going to use. Right now the only backend @@ -174,10 +207,10 @@

    -

    path

    +

    path

    Default: /usr/local/mailjam/storage

    Path to the directory where the backend will save data.

    -

    lists_db

    +

    lists_db

    Default: /usr/local/mailjam/storage/mailings.json

    Path to the file where the identifiers of existing mailing lists will be saved.

    @@ -200,5 +233,5 @@
    -

    members_db

    +

    members_db

    Default: /usr/local/mailjam/storage/members.json

    Path to the file where the identifiers of existing members will be saved.

    @@ -211,10 +244,10 @@
    -

    archive

    +

    archive

    This section contains the configuration parameters that modify the way the daemon saves data to disk, using one of the storage backends.

    These are all the available parameters in this section:

    -

    enabled

    +

    enabled

    Default: true

    Enables/disables the archives feature. When enabled, Mailjam saves copies of @@ -229,5 +262,5 @@

    -

    backend

    +

    backend

    Default: json

    Sets the type of backend used to store messages into the archive.

    @@ -238,5 +271,5 @@
    -

    path

    +

    path

    Default: /usr/local/mailjam/archives

    Path to the directory where the archives will be saved.

    @@ -248,5 +281,5 @@
    -

    mailing_lists

    +

    mailing_lists

    This section contains the configuration parameters that set the default behaviour for mailing lists.

    @@ -258,5 +291,5 @@

    These are all the available parameters in this section:

    -

    private

    +

    private

    Default: true

    Sets if a given mailing list is private (only registered members can send @@ -266,5 +299,5 @@

    -

    members

    +

    members

    This section contains the configuration parameters that set the default behaviour for members.

    @@ -276,5 +309,5 @@

    These are all the available parameters in this section:

    -

    auto_signup

    +

    auto_signup

    Default: false

    Enables/disables auto-registration of members to mailing lists through a public @@ -284,5 +317,5 @@

    -

    allow_chpasswd

    +

    allow_chpasswd

    Default: false

    Enables/disables the option to update passwords by the members themselves.

    @@ -290,11 +323,233 @@ using a public web interface. If false, only mailing lists administrators will be able to reset those passwords.

    - + + + +
    +

    Mailjam MTA client configuration file - mailjam-mta.conf

    +

    This file contains all the parameters to configure the +MTA client properly. It contains ini-style [1] +configuration parameters, separated in different categories.

    +
    +

    Note

    +

    The mailjam-mta.conf file will be installed in different locations +depending on your setup. The usual locations are:

    +
      +
    • /etc/mailjam/mailjam-mta.conf - In most Linux systems (like archlinux, +gentoo, fedora, debian, ubuntu, etc)
      • +
    • /usr/local/etc/mailjam/mailjam-mta.conf - In most BSD systems (like +FreeBSD, OpenBSD, NetBSD, etc)
      • +
    +

    There is a copy of the configuration file in the conf/ directory, within +the sources.

    +
    +
    +

    server

    +

    This section contains the configuration parameters that tell the MTA client +where to connect when trying to interact with the +Mailjam daemon.

    +

    These are all the available parameters in this section:

    +
    +

    address

    +

    Default: localhost

    +

    The address where the daemon is listening for XMLRPC requests. This is +the address to where the client will try to connect to.

    +
    +
    +

    port

    +

    Default: 9876

    +

    The port where the daemon accepts incoming XMLRPC requests. This is the +port to where the client will try to connect to.

    +
    +
    +

    uri

    +

    Default: http://localhost:9876

    +

    This is the URI [4] to where the client will connect to. It is constructed +based on the values of the address +and port parameters.

    +
    +

    Note

    +

    The default configuration file contains a dynamic setting for this +parameter:

    +
    uri = http://%(address)s:%(port)s
    +
    +

    That means that the parameter will inherit the values from the +address +and port parameters.

    +
    +
    +

    See also

    +

    More information about this (and other tricks) here:

    +

    http://docs.python.org/library/configparser.html

    +

    http://www.doughellmann.com/PyMOTW/ConfigParser

    +
    +
    +

    Warning

    +

    You can replace this with any URI you would like, this is the parameter +that is really used for establishing new connections so be aware that if +you remove the references to the +address and +port parameters, the values you have +provided for those parameters will be ignored.

    +
    +
    +
    +

    ssl

    +

    Default: false (because ssl support hasn’t been added yet)

    +

    Enables/disables SSL [3] connections to the daemon. If false all the +traffic to/from the server will travel unencrypted. If true all the traffic +will travel encrypted.

    +
    +

    Warning

    +

    In order to enable SSL support in the client, you have to be sure the +Mailjam daemon supports SSL too (check the +ssl parameter in the +xmlrpc_server section of the +daemon configuration file)

    +
    +
    +
    +
    +

    archive

    +

    This section contains the configuration parameters that set where the files +generated by the client will be stored/saved.

    +
    +

    See also

    +

    For more information about the kind of files the client does generate, +take a look at the +MTA client documentation.

    +
    +

    These are all the available parameters in this section:

    +
    +

    persistent

    +

    Default: true

    +

    Enables/disables the local archive for the client. If true, the client +will save a copy of every email sent to the list in an internal archive, +that could be checked/queried later. If false, the emails will not be +kept on disk after being processed.

    +
    +

    Warning

    +

    This feature is not ready yet.

    +
    +
    +
    +

    path

    +

    Default: /usr/local/mailjam/archive-mta

    +

    Path to the directory where the archives will be saved.

    +
    +

    Warning

    +

    This feature is not ready yet.

    +
    +
    +
    +
    +
    +

    Mailjam CLI client configuration file - mailjam-cli.conf

    +

    This file contains all the parameters to configure the +CLI client properly. It contains ini-style [1] +configuration parameters, separated in different categories.

    +
    +

    Note

    +

    The mailjam-cli.conf file will be installed in different locations +depending on your setup. The usual locations are:

    +
      +
    • /etc/mailjam/mailjam-cli.conf - In most Linux systems (like archlinux, +gentoo, fedora, debian, ubuntu, etc)
      • +
    • /usr/local/etc/mailjam/mailjam-cli.conf - In most BSD systems (like +FreeBSD, OpenBSD, NetBSD, etc)
      • +
    +

    There is a copy of the configuration file in the conf/ directory, within +the sources.

    +
    +
    +

    server

    +

    This section contains the configuration parameters that tell the cli client +where to connect when trying to interact with the +Mailjam daemon.

    +

    These are all the available parameters in this section:

    +
    +

    address

    +

    Default: localhost

    +

    The address where the daemon is listening for XMLRPC requests. This is +the address to where the client will try to connect to.

    +
    +
    +

    port

    +

    Default: 9876

    +

    The port where the daemon accepts incoming XMLRPC requests. This is the +port to where the client will try to connect to.

    +
    +
    +

    uri

    +

    Default: http://localhost:9876

    +

    This is the URI [4] to where the client will connect to. It is constructed +based on the values of the address +and port parameters.

    +
    +

    Note

    +

    The default configuration file contains a dynamic setting for this +parameter:

    +
    uri = http://%(address)s:%(port)s
    +
    +

    That means that the parameter will inherit the values from the +address +and port parameters.

    +
    +
    +

    See also

    +

    More information about this (and other tricks) here:

    +

    http://docs.python.org/library/configparser.html

    +

    http://www.doughellmann.com/PyMOTW/ConfigParser

    +
    +
    +

    Warning

    +

    You can replace this with any URI you would like, this is the parameter +that is really used for establishing new connections so be aware that if +you remove the references to the +address and +port parameters, the values you have +provided for those parameters will be ignored.

    +
    +
    +
    +

    ssl

    +

    Default: false (because ssl support hasn’t been added yet)

    +

    Enables/disables SSL [3] connections to the daemon. If false all the +traffic to/from the server will travel unencrypted. If true all the traffic +will travel encrypted.

    +
    +

    Warning

    +

    In order to enable SSL support in the client, you have to be sure the +Mailjam daemon supports SSL too (check the +ssl parameter in the +xmlrpc_server section of the +daemon configuration file)

    +
    +
    +
    +
    +

    history

    +

    This section contains the configuration parameters that set the behaviour +of the client feature that allows it to save a history of commands provided +by the user.

    +

    These are all the available parameters in this section:

    +
    +

    enabled

    +

    Default: true

    +

    Enables/disables history support in the client. If true all commands +provided by an user will be saved to disk. If false nothing will be +written to disk.

    +
    +
    +

    path

    +

    Default: ~/.mailjam/cli/history

    +

    Path to the file where the list of executed commands will be saved.

    +
    - +
    [1]http://en.wikipedia.org/wiki/INI_file
    [1](1, 2, 3) http://en.wikipedia.org/wiki/INI_file
    - +
    @@ -302,8 +557,14 @@
    - +
    - + + +
    [3]http://en.wikipedia.org/wiki/Secure_Socket_Layer
    [3](1, 2, 3) http://en.wikipedia.org/wiki/Secure_Socket_Layer
    + + + +
    [4](1, 2) http://en.wikipedia.org/wiki/Uniform_resource_identifier
    @@ -322,5 +583,5 @@