source: mailjam/docs/src/_build/html/_sources/configuration.txt@ 16:cd4170142d87

Last change on this file since 16:cd4170142d87 was 16:cd4170142d87, checked in by Borja Lopez <borja@…>, 10 years ago

Renamed the project to Mailjam

File size: 6.7 KB
Line 
1Configuration
2=============
3
4.. contents::
5
6.. _configuration_daemon:
7
8Mailjam daemon configuration file
9---------------------------------
10
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
13parameters, separated in different *categories*.
14
15.. note::
16
17 The mailjam.conf file will be installed in different locations depending on
18 your setup. The usual locations are:
19
20 - */etc/mailjam.conf* - In most Linux systems (like archlinux, gentoo,
21 fedora, debian, ubuntu, etc)
22
23 - */usr/local/etc/mailjam.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
31xmlrpc_server
32+++++++++++++
33
34This section contains the configuration parameters that modify the behaviour of
35the daemon when serving content through XMLRPC [2]_.
36
37These are all the available parameters in this section:
38
39.. _configuration_daemon_xmlrpc_address:
40
41address
42*******
43
44Default: ``localhost``
45
46The address where the daemon will be listening for XMLRPC requests. Use ``*``
47to listen an all available addresses, or any specific ``hostname`` or
48``ip address`` value.
49
50.. _configuration_daemon_xmlrpc_port:
51
52port
53****
54
55Default: ``9876``
56
57The port where the daemon will be listening por XMLRPC requests.
58
59.. _configuration_daemon_xmlrpc_ssl:
60
61ssl
62***
63
64Default: ``off`` (because ssl support hasn't been added yet)
65
66Enables/disables SSL [3]_ support in the daemon. If ``off`` all the traffic
67to/from the server will travel unencrypted. If ``on`` all the traffic will
68travel encrypted.
69
70.. _configuration_daemon_xmlrpc_ssl_key:
71
72ssl_key
73*******
74
75Default: ``/usr/local/etc/mailjam/ssl/mailjam.key``
76
77Path 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
85ssl_crt
86*******
87
88Default: ``/usr/local/etc/mailjam/ssl/mailjam.crt``
89
90Path 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
98logfile
99*******
100
101Default: ``/var/log/mailjam/xmlrpc_server.log``
102
103Path to the file where log messages will be saved
104
105.. _configuration_daemon_storage:
106
107storage
108+++++++
109
110This section contains the configuration parameters that modify the way the
111daemon saves data to disk, using one of the storage backends.
112
113These are all the available parameters in this section:
114
115.. _configuration_daemon_storage_backend:
116
117backend
118*******
119
120Default: ``json``
121
122Sets the type of backend the daemon is going to use. Right now the only backend
123available is ``json``.
124
125.. _configuration_daemon_xmlrpc_path:
126
127path
128****
129
130Default: ``/usr/local/mailjam/storage``
131
132Path to the directory where the backend will save data.
133
134.. _configuration_daemon_storage_lists_db:
135
136lists_db
137********
138
139Default: ``/usr/local/mailjam/storage/mailings.json``
140
141Path 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
164members_db
165**********
166
167Default: ``/usr/local/mailjam/storage/members.json``
168
169Path 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
178archive
179+++++++
180
181This section contains the configuration parameters that modify the way the
182daemon saves data to disk, using one of the storage backends.
183
184These are all the available parameters in this section:
185
186.. _configuration_daemon_archive_enabled:
187
188enabled
189*******
190
191Default: ``true``
192
193Enables/disables the *archives* feature. When enabled, Mailjam saves copies of
194email address into an *archive*, so they can be read later, through a web
195interface.
196
197To 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
206backend
207*******
208
209Default: ``json``
210
211Sets 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
219path
220****
221
222Default: ``/usr/local/mailjam/archives``
223
224Path 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
232mailing_lists
233+++++++++++++
234
235This section contains the configuration parameters that set the default
236behaviour for mailing lists.
237
238.. warning::
239
240 This parameters are not currently used in mailjam, we are still working
241 on per-mailing-list configuration parameters.
242
243These are all the available parameters in this section:
244
245.. _configuration_daemon_mailing_lists_private:
246
247private
248*******
249
250Default: ``true``
251
252Sets if a given mailing list is *private* (only registered members can send
253messages to the list) or not (anyone can send messages to the list).
254
255If ``false``, by default all new lists will not be private.
256
257.. _configuration_daemon_members:
258
259members
260+++++++
261
262This section contains the configuration parameters that set the default
263behaviour for members.
264
265.. warning::
266
267 This parameters are not currently used in mailjam, we are still working
268 on per-member configuration parameters.
269
270These are all the available parameters in this section:
271
272.. _configuration_daemon_members_auto_signup:
273
274auto_signup
275***********
276
277Default: ``false``
278
279Enables/disables auto-registration of members to mailing lists through a public
280web application. If ``true``, users can register themselves into mailing lists
281using a public web interface. If ``false``, only mailing lists administrators
282will be able to add new members to the list.
283
284.. _configuration_daemon_members_allow_chpasswd:
285
286allow_chpasswd
287**************
288
289Default: ``false``
290
291Enables/disables the option to update passwords by the members themselves.
292
293If ``true``, members of a mailing list will be able to update their passwords
294using a public web interface. If ``false``, only mailing lists administrators
295will 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
Note: See TracBrowser for help on using the repository browser.