source: mailjam/docs/src/configuration.rst@ 14:0a6affee82cd

Last change on this file since 14:0a6affee82cd was 13:f1f11159dbed, checked in by Borja Lopez <borja@…>, 13 years ago

Added first version of the project documentation. Inside docs/src there is
the sphinx [1] project we use to manage the docs. Inside docs/html there is
a copy of the docs in html format.

Fixed some typos in the INSTALL file

Added two new parameters to the postman.conf file (both the example config
file inside conf/ and the one used for testing in postman/tests/). These
parameters do nothing yet (they are related to ssl stuff) but we do talk
about them in the docs.

Added a new method to the XMLRPC list of methods related to members.

[1] ​http://sphinx.pocoo.org
File size: 6.7 KB

Configuration

Postman daemon configuration file

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

Note

The postman.conf file will be installed in different locations depending on your setup. The usual locations are:

  • /etc/postman.conf - In most Linux systems (like archlinux, gentoo, fedora, debian, ubuntu, etc)
  • /usr/local/etc/postman.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.

xmlrpc_server

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

These are all the available parameters in this section:

address

Default: localhost

The address where the daemon will be listening for XMLRPC requests. Use * to listen an all available addresses, or any specific hostname or ip address value.

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 travel encrypted.

ssl_key

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

Path to the ssl key used for encrypted SSL sessions.

Warning

This parameter is not used right now, as ssl support hasn't been added yet)

ssl_crt

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

Path to the ssl certificate used for encrypted SSL sessions.

Warning

This parameter is not used right now, as ssl support hasn't been added yet)

logfile

Default: /var/log/postman/xmlrpc_server.log

Path to the file where log messages will be saved

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

Default: json

Sets the type of backend the daemon is going to use. Right now the only backend available is json.

path

Default: /usr/local/postman/storage

Path to the directory where the backend will save data.

lists_db

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

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

Note

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

lists_db = %(path)s/mailings.%(backend)s

That means that the parameter will inherit the values of the base path and the extension of the file from the storage.path and storage.backend settings.

?
.. seealso::

   More information about this (and other tricks) here:

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

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

members_db

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

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

Note

The same notes as for the lists_db parameter apply to this configuration parameter.

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

Default: true

Enables/disables the archives feature. When enabled, Postman saves copies of email address into an archive, so they can be read later, through a web interface.

To disable that feature, set this to false.

Warning

This feature is not ready yet, so it doesn't matter if you set this to true or false

backend

Default: json

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

Warning

This feature is not ready yet.

path

Default: /usr/local/postman/archives

Path to the directory where the archives will be saved.

Warning

This feature is not ready yet.

mailing_lists

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

Warning

This parameters are not currently used in postman, we are still working on per-mailing-list configuration parameters.

These are all the available parameters in this section:

private

Default: true

Sets if a given mailing list is private (only registered members can send messages to the list) or not (anyone can send messages to the list).

If false, by default all new lists will not be private.

members

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

Warning

This parameters are not currently used in postman, we are still working on per-member configuration parameters.

These are all the available parameters in this section:

auto_signup

Default: false

Enables/disables auto-registration of members to mailing lists through a public web application. If true, users can register themselves into mailing lists using a public web interface. If false, only mailing lists administrators will be able to add new members to the list.

allow_chpasswd

Default: false

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

If true, members of a mailing list will be able to update their passwords using a public web interface. If false, only mailing lists administrators will be able to reset those passwords.

[1]http://en.wikipedia.org/wiki/INI_file
[2]http://en.wikipedia.org/wiki/XML-RPC
[3]http://en.wikipedia.org/wiki/Secure_Socket_Layer
Note: See TracBrowser for help on using the repository browser.