[13] | 1 | Configuration
|
---|
| 2 | =============
|
---|
| 3 |
|
---|
| 4 | .. contents::
|
---|
| 5 |
|
---|
| 6 | .. _configuration_daemon:
|
---|
| 7 |
|
---|
| 8 | Postman daemon configuration file
|
---|
| 9 | ---------------------------------
|
---|
| 10 |
|
---|
| 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
|
---|
| 13 | parameters, separated in different *categories*.
|
---|
| 14 |
|
---|
| 15 | .. note::
|
---|
| 16 |
|
---|
| 17 | The postman.conf file will be installed in different locations depending on
|
---|
| 18 | your setup. The usual locations are:
|
---|
| 19 |
|
---|
| 20 | - */etc/postman.conf* - In most Linux systems (like archlinux, gentoo,
|
---|
| 21 | fedora, debian, ubuntu, etc)
|
---|
| 22 |
|
---|
| 23 | - */usr/local/etc/postman.conf* - In most BSD systems (like FreeBSD, OpenBSD,
|
---|
| 24 | NetBSD, etc)
|
---|
| 25 |
|
---|
| 26 | There is a copy of the configuration file in the *conf/* directory, within
|
---|
| 27 | the sources.
|
---|
| 28 |
|
---|
| 29 | .. _configuration_daemon_xmlrpc:
|
---|
| 30 |
|
---|
| 31 | xmlrpc_server
|
---|
| 32 | +++++++++++++
|
---|
| 33 |
|
---|
| 34 | This section contains the configuration parameters that modify the behaviour of
|
---|
| 35 | the daemon when serving content through XMLRPC [2]_.
|
---|
| 36 |
|
---|
| 37 | These are all the available parameters in this section:
|
---|
| 38 |
|
---|
| 39 | .. _configuration_daemon_xmlrpc_address:
|
---|
| 40 |
|
---|
| 41 | address
|
---|
| 42 | *******
|
---|
| 43 |
|
---|
| 44 | Default: ``localhost``
|
---|
| 45 |
|
---|
| 46 | The address where the daemon will be listening for XMLRPC requests. Use ``*``
|
---|
| 47 | to listen an all available addresses, or any specific ``hostname`` or
|
---|
| 48 | ``ip address`` value.
|
---|
| 49 |
|
---|
| 50 | .. _configuration_daemon_xmlrpc_port:
|
---|
| 51 |
|
---|
| 52 | port
|
---|
| 53 | ****
|
---|
| 54 |
|
---|
| 55 | Default: ``9876``
|
---|
| 56 |
|
---|
| 57 | The port where the daemon will be listening por XMLRPC requests.
|
---|
| 58 |
|
---|
| 59 | .. _configuration_daemon_xmlrpc_ssl:
|
---|
| 60 |
|
---|
| 61 | ssl
|
---|
| 62 | ***
|
---|
| 63 |
|
---|
| 64 | Default: ``off`` (because ssl support hasn't been added yet)
|
---|
| 65 |
|
---|
| 66 | Enables/disables SSL [3]_ support in the daemon. If ``off`` all the traffic
|
---|
| 67 | to/from the server will travel unencrypted. If ``on`` all the traffic will
|
---|
| 68 | travel encrypted.
|
---|
| 69 |
|
---|
| 70 | .. _configuration_daemon_xmlrpc_ssl_key:
|
---|
| 71 |
|
---|
| 72 | ssl_key
|
---|
| 73 | *******
|
---|
| 74 |
|
---|
| 75 | Default: ``/usr/local/etc/postman/ssl/postman.key``
|
---|
| 76 |
|
---|
| 77 | Path to the ssl key used for encrypted SSL sessions.
|
---|
| 78 |
|
---|
| 79 | .. warning::
|
---|
| 80 |
|
---|
| 81 | This parameter is not used right now, as ssl support hasn't been added yet)
|
---|
| 82 |
|
---|
| 83 | .. _configuration_daemon_xmlrpc_ssl_crt:
|
---|
| 84 |
|
---|
| 85 | ssl_crt
|
---|
| 86 | *******
|
---|
| 87 |
|
---|
| 88 | Default: ``/usr/local/etc/postman/ssl/postman.crt``
|
---|
| 89 |
|
---|
| 90 | Path to the ssl certificate used for encrypted SSL sessions.
|
---|
| 91 |
|
---|
| 92 | .. warning::
|
---|
| 93 |
|
---|
| 94 | This parameter is not used right now, as ssl support hasn't been added yet)
|
---|
| 95 |
|
---|
| 96 | .. _configuration_daemon_xmlrpc_logfile:
|
---|
| 97 |
|
---|
| 98 | logfile
|
---|
| 99 | *******
|
---|
| 100 |
|
---|
| 101 | Default: ``/var/log/postman/xmlrpc_server.log``
|
---|
| 102 |
|
---|
| 103 | Path to the file where log messages will be saved
|
---|
| 104 |
|
---|
| 105 | .. _configuration_daemon_storage:
|
---|
| 106 |
|
---|
| 107 | storage
|
---|
| 108 | +++++++
|
---|
| 109 |
|
---|
| 110 | This section contains the configuration parameters that modify the way the
|
---|
| 111 | daemon saves data to disk, using one of the storage backends.
|
---|
| 112 |
|
---|
| 113 | These are all the available parameters in this section:
|
---|
| 114 |
|
---|
| 115 | .. _configuration_daemon_storage_backend:
|
---|
| 116 |
|
---|
| 117 | backend
|
---|
| 118 | *******
|
---|
| 119 |
|
---|
| 120 | Default: ``json``
|
---|
| 121 |
|
---|
| 122 | Sets the type of backend the daemon is going to use. Right now the only backend
|
---|
| 123 | available is ``json``.
|
---|
| 124 |
|
---|
| 125 | .. _configuration_daemon_xmlrpc_path:
|
---|
| 126 |
|
---|
| 127 | path
|
---|
| 128 | ****
|
---|
| 129 |
|
---|
| 130 | Default: ``/usr/local/postman/storage``
|
---|
| 131 |
|
---|
| 132 | Path to the directory where the backend will save data.
|
---|
| 133 |
|
---|
| 134 | .. _configuration_daemon_storage_lists_db:
|
---|
| 135 |
|
---|
| 136 | lists_db
|
---|
| 137 | ********
|
---|
| 138 |
|
---|
| 139 | Default: ``/usr/local/postman/storage/mailings.json``
|
---|
| 140 |
|
---|
| 141 | Path to the file where the identifiers of existing mailing lists will be saved.
|
---|
| 142 |
|
---|
| 143 | .. note::
|
---|
| 144 |
|
---|
| 145 | The default configuration file contains a dynamic setting for this
|
---|
| 146 | parameter::
|
---|
| 147 |
|
---|
| 148 | lists_db = %(path)s/mailings.%(backend)s
|
---|
| 149 |
|
---|
| 150 | That means that the parameter will inherit the values of the base path and
|
---|
| 151 | the extension of the file from the *storage.path* and *storage.backend*
|
---|
| 152 | settings.
|
---|
| 153 |
|
---|
| 154 | .. seealso::
|
---|
| 155 |
|
---|
| 156 | More information about this (and other tricks) here:
|
---|
| 157 |
|
---|
| 158 | http://docs.python.org/library/configparser.html
|
---|
| 159 |
|
---|
| 160 | http://www.doughellmann.com/PyMOTW/ConfigParser
|
---|
| 161 |
|
---|
| 162 | .. _configuration_daemon_xmlrpc_members_db:
|
---|
| 163 |
|
---|
| 164 | members_db
|
---|
| 165 | **********
|
---|
| 166 |
|
---|
| 167 | Default: ``/usr/local/postman/storage/members.json``
|
---|
| 168 |
|
---|
| 169 | Path to the file where the identifiers of existing members will be saved.
|
---|
| 170 |
|
---|
| 171 | .. note::
|
---|
| 172 |
|
---|
| 173 | The same notes as for the *lists_db* parameter apply to this configuration
|
---|
| 174 | parameter.
|
---|
| 175 |
|
---|
| 176 | .. _configuration_daemon_archive:
|
---|
| 177 |
|
---|
| 178 | archive
|
---|
| 179 | +++++++
|
---|
| 180 |
|
---|
| 181 | This section contains the configuration parameters that modify the way the
|
---|
| 182 | daemon saves data to disk, using one of the storage backends.
|
---|
| 183 |
|
---|
| 184 | These are all the available parameters in this section:
|
---|
| 185 |
|
---|
| 186 | .. _configuration_daemon_archive_enabled:
|
---|
| 187 |
|
---|
| 188 | enabled
|
---|
| 189 | *******
|
---|
| 190 |
|
---|
| 191 | Default: ``true``
|
---|
| 192 |
|
---|
| 193 | Enables/disables the *archives* feature. When enabled, Postman saves copies of
|
---|
| 194 | email address into an *archive*, so they can be read later, through a web
|
---|
| 195 | interface.
|
---|
| 196 |
|
---|
| 197 | To disable that feature, set this to ``false``.
|
---|
| 198 |
|
---|
| 199 | .. warning::
|
---|
| 200 |
|
---|
| 201 | This feature is not ready yet, so it doesn't matter if you set this to true
|
---|
| 202 | or false
|
---|
| 203 |
|
---|
| 204 | .. _configuration_daemon_archive_backend:
|
---|
| 205 |
|
---|
| 206 | backend
|
---|
| 207 | *******
|
---|
| 208 |
|
---|
| 209 | Default: ``json``
|
---|
| 210 |
|
---|
| 211 | Sets the type of backend used to store messages into the archive.
|
---|
| 212 |
|
---|
| 213 | .. warning::
|
---|
| 214 |
|
---|
| 215 | This feature is not ready yet.
|
---|
| 216 |
|
---|
| 217 | .. _configuration_daemon_archive_path:
|
---|
| 218 |
|
---|
| 219 | path
|
---|
| 220 | ****
|
---|
| 221 |
|
---|
| 222 | Default: ``/usr/local/postman/archives``
|
---|
| 223 |
|
---|
| 224 | Path to the directory where the archives will be saved.
|
---|
| 225 |
|
---|
| 226 | .. warning::
|
---|
| 227 |
|
---|
| 228 | This feature is not ready yet.
|
---|
| 229 |
|
---|
| 230 | .. _configuration_daemon_mailing_lists:
|
---|
| 231 |
|
---|
| 232 | mailing_lists
|
---|
| 233 | +++++++++++++
|
---|
| 234 |
|
---|
| 235 | This section contains the configuration parameters that set the default
|
---|
| 236 | behaviour for mailing lists.
|
---|
| 237 |
|
---|
| 238 | .. warning::
|
---|
| 239 |
|
---|
| 240 | This parameters are not currently used in postman, we are still working
|
---|
| 241 | on per-mailing-list configuration parameters.
|
---|
| 242 |
|
---|
| 243 | These are all the available parameters in this section:
|
---|
| 244 |
|
---|
| 245 | .. _configuration_daemon_mailing_lists_private:
|
---|
| 246 |
|
---|
| 247 | private
|
---|
| 248 | *******
|
---|
| 249 |
|
---|
| 250 | Default: ``true``
|
---|
| 251 |
|
---|
| 252 | Sets if a given mailing list is *private* (only registered members can send
|
---|
| 253 | messages to the list) or not (anyone can send messages to the list).
|
---|
| 254 |
|
---|
| 255 | If ``false``, by default all new lists will not be private.
|
---|
| 256 |
|
---|
| 257 | .. _configuration_daemon_members:
|
---|
| 258 |
|
---|
| 259 | members
|
---|
| 260 | +++++++
|
---|
| 261 |
|
---|
| 262 | This section contains the configuration parameters that set the default
|
---|
| 263 | behaviour for members.
|
---|
| 264 |
|
---|
| 265 | .. warning::
|
---|
| 266 |
|
---|
| 267 | This parameters are not currently used in postman, we are still working
|
---|
| 268 | on per-member configuration parameters.
|
---|
| 269 |
|
---|
| 270 | These are all the available parameters in this section:
|
---|
| 271 |
|
---|
| 272 | .. _configuration_daemon_members_auto_signup:
|
---|
| 273 |
|
---|
| 274 | auto_signup
|
---|
| 275 | ***********
|
---|
| 276 |
|
---|
| 277 | Default: ``false``
|
---|
| 278 |
|
---|
| 279 | Enables/disables auto-registration of members to mailing lists through a public
|
---|
| 280 | web application. If ``true``, users can register themselves into mailing lists
|
---|
| 281 | using a public web interface. If ``false``, only mailing lists administrators
|
---|
| 282 | will be able to add new members to the list.
|
---|
| 283 |
|
---|
| 284 | .. _configuration_daemon_members_allow_chpasswd:
|
---|
| 285 |
|
---|
| 286 | allow_chpasswd
|
---|
| 287 | **************
|
---|
| 288 |
|
---|
| 289 | Default: ``false``
|
---|
| 290 |
|
---|
| 291 | Enables/disables the option to update passwords by the members themselves.
|
---|
| 292 |
|
---|
| 293 | If ``true``, members of a mailing list will be able to update their passwords
|
---|
| 294 | using a public web interface. If ``false``, only mailing lists administrators
|
---|
| 295 | will be able to reset those passwords.
|
---|
| 296 |
|
---|
| 297 |
|
---|
| 298 | .. [1] http://en.wikipedia.org/wiki/INI_file
|
---|
| 299 | .. [2] http://en.wikipedia.org/wiki/XML-RPC
|
---|
| 300 | .. [3] http://en.wikipedia.org/wiki/Secure_Socket_Layer
|
---|