source: mailjam/docs/src/_build/html/configuration.html@ 13:f1f11159dbed

Last change on this file since 13:f1f11159dbed 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: 22.4 KB
Line 
1
2
3<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
6
7<html xmlns="http://www.w3.org/1999/xhtml">
8 <head>
9 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
10
11 <title>Configuration &mdash; Postman 0.1.0 documentation</title>
12
13 <link rel="stylesheet" href="_static/default.css" type="text/css" />
14 <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
15
16 <script type="text/javascript">
17 var DOCUMENTATION_OPTIONS = {
18 URL_ROOT: '',
19 VERSION: '0.1.0',
20 COLLAPSE_INDEX: false,
21 FILE_SUFFIX: '.html',
22 HAS_SOURCE: true
23 };
24 </script>
25 <script type="text/javascript" src="_static/jquery.js"></script>
26 <script type="text/javascript" src="_static/underscore.js"></script>
27 <script type="text/javascript" src="_static/doctools.js"></script>
28 <link rel="top" title="Postman 0.1.0 documentation" href="index.html" />
29 <link rel="next" title="Running Postman" href="running.html" />
30 <link rel="prev" title="Installation instructions" href="install.html" />
31 </head>
32 <body>
33 <div class="related">
34 <h3>Navigation</h3>
35 <ul>
36 <li class="right" style="margin-right: 10px">
37 <a href="genindex.html" title="General Index"
38 accesskey="I">index</a></li>
39 <li class="right" >
40 <a href="running.html" title="Running Postman"
41 accesskey="N">next</a> |</li>
42 <li class="right" >
43 <a href="install.html" title="Installation instructions"
44 accesskey="P">previous</a> |</li>
45 <li><a href="index.html">Postman 0.1.0 documentation</a> &raquo;</li>
46 </ul>
47 </div>
48
49 <div class="document">
50 <div class="documentwrapper">
51 <div class="bodywrapper">
52 <div class="body">
53
54 <div class="section" id="configuration">
55<h1><a class="toc-backref" href="#id9">Configuration</a><a class="headerlink" href="#configuration" title="Permalink to this headline"></a></h1>
56<div class="contents topic" id="contents">
57<p class="topic-title first">Contents</p>
58<ul class="simple">
59<li><a class="reference internal" href="#configuration" id="id9">Configuration</a><ul>
60<li><a class="reference internal" href="#postman-daemon-configuration-file" id="id10">Postman daemon configuration file</a><ul>
61<li><a class="reference internal" href="#xmlrpc-server" id="id11">xmlrpc_server</a><ul>
62<li><a class="reference internal" href="#address" id="id12">address</a></li>
63<li><a class="reference internal" href="#port" id="id13">port</a></li>
64<li><a class="reference internal" href="#ssl" id="id14">ssl</a></li>
65<li><a class="reference internal" href="#ssl-key" id="id15">ssl_key</a></li>
66<li><a class="reference internal" href="#ssl-crt" id="id16">ssl_crt</a></li>
67<li><a class="reference internal" href="#logfile" id="id17">logfile</a></li>
68</ul>
69</li>
70<li><a class="reference internal" href="#storage" id="id18">storage</a><ul>
71<li><a class="reference internal" href="#backend" id="id19">backend</a></li>
72<li><a class="reference internal" href="#path" id="id20">path</a></li>
73<li><a class="reference internal" href="#lists-db" id="id21">lists_db</a></li>
74<li><a class="reference internal" href="#members-db" id="id22">members_db</a></li>
75</ul>
76</li>
77<li><a class="reference internal" href="#archive" id="id23">archive</a><ul>
78<li><a class="reference internal" href="#enabled" id="id24">enabled</a></li>
79<li><a class="reference internal" href="#configuration-daemon-archive-backend" id="id25">backend</a></li>
80<li><a class="reference internal" href="#configuration-daemon-archive-path" id="id26">path</a></li>
81</ul>
82</li>
83<li><a class="reference internal" href="#mailing-lists" id="id27">mailing_lists</a><ul>
84<li><a class="reference internal" href="#private" id="id28">private</a></li>
85</ul>
86</li>
87<li><a class="reference internal" href="#members" id="id29">members</a><ul>
88<li><a class="reference internal" href="#auto-signup" id="id30">auto_signup</a></li>
89<li><a class="reference internal" href="#allow-chpasswd" id="id31">allow_chpasswd</a></li>
90</ul>
91</li>
92</ul>
93</li>
94</ul>
95</li>
96</ul>
97</div>
98<div class="section" id="postman-daemon-configuration-file">
99<span id="configuration-daemon"></span><h2><a class="toc-backref" href="#id10">Postman daemon configuration file</a><a class="headerlink" href="#postman-daemon-configuration-file" title="Permalink to this headline"></a></h2>
100<p>All the configurations that can be applied to the Postman daemon are registered
101in the <strong>postman.conf</strong> file. That file contains ini-style <a class="footnote-reference" href="#id6" id="id1">[1]</a> configuration
102parameters, separated in different <em>categories</em>.</p>
103<div class="admonition note">
104<p class="first admonition-title">Note</p>
105<p>The postman.conf file will be installed in different locations depending on
106your setup. The usual locations are:</p>
107<ul class="simple">
108<li><em>/etc/postman.conf</em> - In most Linux systems (like archlinux, gentoo,
109fedora, debian, ubuntu, etc)</li>
110<li><em>/usr/local/etc/postman.conf</em> - In most BSD systems (like FreeBSD, OpenBSD,
111NetBSD, etc)</li>
112</ul>
113<p class="last">There is a copy of the configuration file in the <em>conf/</em> directory, within
114the sources.</p>
115</div>
116<div class="section" id="xmlrpc-server">
117<span id="configuration-daemon-xmlrpc"></span><h3><a class="toc-backref" href="#id11">xmlrpc_server</a><a class="headerlink" href="#xmlrpc-server" title="Permalink to this headline"></a></h3>
118<p>This section contains the configuration parameters that modify the behaviour of
119the daemon when serving content through XMLRPC <a class="footnote-reference" href="#id7" id="id2">[2]</a>.</p>
120<p>These are all the available parameters in this section:</p>
121<div class="section" id="address">
122<span id="configuration-daemon-xmlrpc-address"></span><h4><a class="toc-backref" href="#id12">address</a><a class="headerlink" href="#address" title="Permalink to this headline"></a></h4>
123<p>Default: <tt class="docutils literal"><span class="pre">localhost</span></tt></p>
124<p>The address where the daemon will be listening for XMLRPC requests. Use <tt class="docutils literal"><span class="pre">*</span></tt>
125to listen an all available addresses, or any specific <tt class="docutils literal"><span class="pre">hostname</span></tt> or
126<tt class="docutils literal"><span class="pre">ip</span> <span class="pre">address</span></tt> value.</p>
127</div>
128<div class="section" id="port">
129<span id="configuration-daemon-xmlrpc-port"></span><h4><a class="toc-backref" href="#id13">port</a><a class="headerlink" href="#port" title="Permalink to this headline"></a></h4>
130<p>Default: <tt class="docutils literal"><span class="pre">9876</span></tt></p>
131<p>The port where the daemon will be listening por XMLRPC requests.</p>
132</div>
133<div class="section" id="ssl">
134<span id="configuration-daemon-xmlrpc-ssl"></span><h4><a class="toc-backref" href="#id14">ssl</a><a class="headerlink" href="#ssl" title="Permalink to this headline"></a></h4>
135<p>Default: <tt class="docutils literal"><span class="pre">off</span></tt> (because ssl support hasn&#8217;t been added yet)</p>
136<p>Enables/disables SSL <a class="footnote-reference" href="#id8" id="id3">[3]</a> support in the daemon. If <tt class="docutils literal"><span class="pre">off</span></tt> all the traffic
137to/from the server will travel unencrypted. If <tt class="docutils literal"><span class="pre">on</span></tt> all the traffic will
138travel encrypted.</p>
139</div>
140<div class="section" id="ssl-key">
141<span id="configuration-daemon-xmlrpc-ssl-key"></span><h4><a class="toc-backref" href="#id15">ssl_key</a><a class="headerlink" href="#ssl-key" title="Permalink to this headline"></a></h4>
142<p>Default: <tt class="docutils literal"><span class="pre">/usr/local/etc/postman/ssl/postman.key</span></tt></p>
143<p>Path to the ssl key used for encrypted SSL sessions.</p>
144<div class="admonition warning">
145<p class="first admonition-title">Warning</p>
146<p class="last">This parameter is not used right now, as ssl support hasn&#8217;t been added yet)</p>
147</div>
148</div>
149<div class="section" id="ssl-crt">
150<span id="configuration-daemon-xmlrpc-ssl-crt"></span><h4><a class="toc-backref" href="#id16">ssl_crt</a><a class="headerlink" href="#ssl-crt" title="Permalink to this headline"></a></h4>
151<p>Default: <tt class="docutils literal"><span class="pre">/usr/local/etc/postman/ssl/postman.crt</span></tt></p>
152<p>Path to the ssl certificate used for encrypted SSL sessions.</p>
153<div class="admonition warning">
154<p class="first admonition-title">Warning</p>
155<p class="last">This parameter is not used right now, as ssl support hasn&#8217;t been added yet)</p>
156</div>
157</div>
158<div class="section" id="logfile">
159<span id="configuration-daemon-xmlrpc-logfile"></span><h4><a class="toc-backref" href="#id17">logfile</a><a class="headerlink" href="#logfile" title="Permalink to this headline"></a></h4>
160<p>Default: <tt class="docutils literal"><span class="pre">/var/log/postman/xmlrpc_server.log</span></tt></p>
161<p>Path to the file where log messages will be saved</p>
162</div>
163</div>
164<div class="section" id="storage">
165<span id="configuration-daemon-storage"></span><h3><a class="toc-backref" href="#id18">storage</a><a class="headerlink" href="#storage" title="Permalink to this headline"></a></h3>
166<p>This section contains the configuration parameters that modify the way the
167daemon saves data to disk, using one of the storage backends.</p>
168<p>These are all the available parameters in this section:</p>
169<div class="section" id="backend">
170<span id="configuration-daemon-storage-backend"></span><h4><a class="toc-backref" href="#id19">backend</a><a class="headerlink" href="#backend" title="Permalink to this headline"></a></h4>
171<p>Default: <tt class="docutils literal"><span class="pre">json</span></tt></p>
172<p>Sets the type of backend the daemon is going to use. Right now the only backend
173available is <tt class="docutils literal"><span class="pre">json</span></tt>.</p>
174</div>
175<div class="section" id="path">
176<span id="configuration-daemon-xmlrpc-path"></span><h4><a class="toc-backref" href="#id20">path</a><a class="headerlink" href="#path" title="Permalink to this headline"></a></h4>
177<p>Default: <tt class="docutils literal"><span class="pre">/usr/local/postman/storage</span></tt></p>
178<p>Path to the directory where the backend will save data.</p>
179</div>
180<div class="section" id="lists-db">
181<span id="configuration-daemon-storage-lists-db"></span><h4><a class="toc-backref" href="#id21">lists_db</a><a class="headerlink" href="#lists-db" title="Permalink to this headline"></a></h4>
182<p>Default: <tt class="docutils literal"><span class="pre">/usr/local/postman/storage/mailings.json</span></tt></p>
183<p>Path to the file where the identifiers of existing mailing lists will be saved.</p>
184<div class="admonition note">
185<p class="first admonition-title">Note</p>
186<p>The default configuration file contains a dynamic setting for this
187parameter:</p>
188<div class="highlight-python"><pre>lists_db = %(path)s/mailings.%(backend)s</pre>
189</div>
190<p class="last">That means that the parameter will inherit the values of the base path and
191the extension of the file from the <em>storage.path</em> and <em>storage.backend</em>
192settings.</p>
193</div>
194<div class="admonition-see-also admonition seealso">
195<p class="first admonition-title">See also</p>
196<p>More information about this (and other tricks) here:</p>
197<p><a class="reference external" href="http://docs.python.org/library/configparser.html">http://docs.python.org/library/configparser.html</a></p>
198<p class="last"><a class="reference external" href="http://www.doughellmann.com/PyMOTW/ConfigParser">http://www.doughellmann.com/PyMOTW/ConfigParser</a></p>
199</div>
200</div>
201<div class="section" id="members-db">
202<span id="configuration-daemon-xmlrpc-members-db"></span><h4><a class="toc-backref" href="#id22">members_db</a><a class="headerlink" href="#members-db" title="Permalink to this headline"></a></h4>
203<p>Default: <tt class="docutils literal"><span class="pre">/usr/local/postman/storage/members.json</span></tt></p>
204<p>Path to the file where the identifiers of existing members will be saved.</p>
205<div class="admonition note">
206<p class="first admonition-title">Note</p>
207<p class="last">The same notes as for the <em>lists_db</em> parameter apply to this configuration
208parameter.</p>
209</div>
210</div>
211</div>
212<div class="section" id="archive">
213<span id="configuration-daemon-archive"></span><h3><a class="toc-backref" href="#id23">archive</a><a class="headerlink" href="#archive" title="Permalink to this headline"></a></h3>
214<p>This section contains the configuration parameters that modify the way the
215daemon saves data to disk, using one of the storage backends.</p>
216<p>These are all the available parameters in this section:</p>
217<div class="section" id="enabled">
218<span id="configuration-daemon-archive-enabled"></span><h4><a class="toc-backref" href="#id24">enabled</a><a class="headerlink" href="#enabled" title="Permalink to this headline"></a></h4>
219<p>Default: <tt class="docutils literal"><span class="pre">true</span></tt></p>
220<p>Enables/disables the <em>archives</em> feature. When enabled, Postman saves copies of
221email address into an <em>archive</em>, so they can be read later, through a web
222interface.</p>
223<p>To disable that feature, set this to <tt class="docutils literal"><span class="pre">false</span></tt>.</p>
224<div class="admonition warning">
225<p class="first admonition-title">Warning</p>
226<p class="last">This feature is not ready yet, so it doesn&#8217;t matter if you set this to true
227or false</p>
228</div>
229</div>
230<div class="section" id="configuration-daemon-archive-backend">
231<span id="id4"></span><h4><a class="toc-backref" href="#id25">backend</a><a class="headerlink" href="#configuration-daemon-archive-backend" title="Permalink to this headline"></a></h4>
232<p>Default: <tt class="docutils literal"><span class="pre">json</span></tt></p>
233<p>Sets the type of backend used to store messages into the archive.</p>
234<div class="admonition warning">
235<p class="first admonition-title">Warning</p>
236<p class="last">This feature is not ready yet.</p>
237</div>
238</div>
239<div class="section" id="configuration-daemon-archive-path">
240<span id="id5"></span><h4><a class="toc-backref" href="#id26">path</a><a class="headerlink" href="#configuration-daemon-archive-path" title="Permalink to this headline"></a></h4>
241<p>Default: <tt class="docutils literal"><span class="pre">/usr/local/postman/archives</span></tt></p>
242<p>Path to the directory where the archives will be saved.</p>
243<div class="admonition warning">
244<p class="first admonition-title">Warning</p>
245<p class="last">This feature is not ready yet.</p>
246</div>
247</div>
248</div>
249<div class="section" id="mailing-lists">
250<span id="configuration-daemon-mailing-lists"></span><h3><a class="toc-backref" href="#id27">mailing_lists</a><a class="headerlink" href="#mailing-lists" title="Permalink to this headline"></a></h3>
251<p>This section contains the configuration parameters that set the default
252behaviour for mailing lists.</p>
253<div class="admonition warning">
254<p class="first admonition-title">Warning</p>
255<p class="last">This parameters are not currently used in postman, we are still working
256on per-mailing-list configuration parameters.</p>
257</div>
258<p>These are all the available parameters in this section:</p>
259<div class="section" id="private">
260<span id="configuration-daemon-mailing-lists-private"></span><h4><a class="toc-backref" href="#id28">private</a><a class="headerlink" href="#private" title="Permalink to this headline"></a></h4>
261<p>Default: <tt class="docutils literal"><span class="pre">true</span></tt></p>
262<p>Sets if a given mailing list is <em>private</em> (only registered members can send
263messages to the list) or not (anyone can send messages to the list).</p>
264<p>If <tt class="docutils literal"><span class="pre">false</span></tt>, by default all new lists will not be private.</p>
265</div>
266</div>
267<div class="section" id="members">
268<span id="configuration-daemon-members"></span><h3><a class="toc-backref" href="#id29">members</a><a class="headerlink" href="#members" title="Permalink to this headline"></a></h3>
269<p>This section contains the configuration parameters that set the default
270behaviour for members.</p>
271<div class="admonition warning">
272<p class="first admonition-title">Warning</p>
273<p class="last">This parameters are not currently used in postman, we are still working
274on per-member configuration parameters.</p>
275</div>
276<p>These are all the available parameters in this section:</p>
277<div class="section" id="auto-signup">
278<span id="configuration-daemon-members-auto-signup"></span><h4><a class="toc-backref" href="#id30">auto_signup</a><a class="headerlink" href="#auto-signup" title="Permalink to this headline"></a></h4>
279<p>Default: <tt class="docutils literal"><span class="pre">false</span></tt></p>
280<p>Enables/disables auto-registration of members to mailing lists through a public
281web application. If <tt class="docutils literal"><span class="pre">true</span></tt>, users can register themselves into mailing lists
282using a public web interface. If <tt class="docutils literal"><span class="pre">false</span></tt>, only mailing lists administrators
283will be able to add new members to the list.</p>
284</div>
285<div class="section" id="allow-chpasswd">
286<span id="configuration-daemon-members-allow-chpasswd"></span><h4><a class="toc-backref" href="#id31">allow_chpasswd</a><a class="headerlink" href="#allow-chpasswd" title="Permalink to this headline"></a></h4>
287<p>Default: <tt class="docutils literal"><span class="pre">false</span></tt></p>
288<p>Enables/disables the option to update passwords by the members themselves.</p>
289<p>If <tt class="docutils literal"><span class="pre">true</span></tt>, members of a mailing list will be able to update their passwords
290using a public web interface. If <tt class="docutils literal"><span class="pre">false</span></tt>, only mailing lists administrators
291will be able to reset those passwords.</p>
292<table class="docutils footnote" frame="void" id="id6" rules="none">
293<colgroup><col class="label" /><col /></colgroup>
294<tbody valign="top">
295<tr><td class="label"><a class="fn-backref" href="#id1">[1]</a></td><td><a class="reference external" href="http://en.wikipedia.org/wiki/INI_file">http://en.wikipedia.org/wiki/INI_file</a></td></tr>
296</tbody>
297</table>
298<table class="docutils footnote" frame="void" id="id7" rules="none">
299<colgroup><col class="label" /><col /></colgroup>
300<tbody valign="top">
301<tr><td class="label"><a class="fn-backref" href="#id2">[2]</a></td><td><a class="reference external" href="http://en.wikipedia.org/wiki/XML-RPC">http://en.wikipedia.org/wiki/XML-RPC</a></td></tr>
302</tbody>
303</table>
304<table class="docutils footnote" frame="void" id="id8" rules="none">
305<colgroup><col class="label" /><col /></colgroup>
306<tbody valign="top">
307<tr><td class="label"><a class="fn-backref" href="#id3">[3]</a></td><td><a class="reference external" href="http://en.wikipedia.org/wiki/Secure_Socket_Layer">http://en.wikipedia.org/wiki/Secure_Socket_Layer</a></td></tr>
308</tbody>
309</table>
310</div>
311</div>
312</div>
313</div>
314
315
316 </div>
317 </div>
318 </div>
319 <div class="sphinxsidebar">
320 <div class="sphinxsidebarwrapper">
321 <h3><a href="index.html">Table Of Contents</a></h3>
322 <ul>
323<li><a class="reference internal" href="#">Configuration</a><ul>
324<li><a class="reference internal" href="#postman-daemon-configuration-file">Postman daemon configuration file</a><ul>
325<li><a class="reference internal" href="#xmlrpc-server">xmlrpc_server</a><ul>
326<li><a class="reference internal" href="#address">address</a></li>
327<li><a class="reference internal" href="#port">port</a></li>
328<li><a class="reference internal" href="#ssl">ssl</a></li>
329<li><a class="reference internal" href="#ssl-key">ssl_key</a></li>
330<li><a class="reference internal" href="#ssl-crt">ssl_crt</a></li>
331<li><a class="reference internal" href="#logfile">logfile</a></li>
332</ul>
333</li>
334<li><a class="reference internal" href="#storage">storage</a><ul>
335<li><a class="reference internal" href="#backend">backend</a></li>
336<li><a class="reference internal" href="#path">path</a></li>
337<li><a class="reference internal" href="#lists-db">lists_db</a></li>
338<li><a class="reference internal" href="#members-db">members_db</a></li>
339</ul>
340</li>
341<li><a class="reference internal" href="#archive">archive</a><ul>
342<li><a class="reference internal" href="#enabled">enabled</a></li>
343<li><a class="reference internal" href="#configuration-daemon-archive-backend">backend</a></li>
344<li><a class="reference internal" href="#configuration-daemon-archive-path">path</a></li>
345</ul>
346</li>
347<li><a class="reference internal" href="#mailing-lists">mailing_lists</a><ul>
348<li><a class="reference internal" href="#private">private</a></li>
349</ul>
350</li>
351<li><a class="reference internal" href="#members">members</a><ul>
352<li><a class="reference internal" href="#auto-signup">auto_signup</a></li>
353<li><a class="reference internal" href="#allow-chpasswd">allow_chpasswd</a></li>
354</ul>
355</li>
356</ul>
357</li>
358</ul>
359</li>
360</ul>
361
362 <h4>Previous topic</h4>
363 <p class="topless"><a href="install.html"
364 title="previous chapter">Installation instructions</a></p>
365 <h4>Next topic</h4>
366 <p class="topless"><a href="running.html"
367 title="next chapter">Running Postman</a></p>
368 <h3>This Page</h3>
369 <ul class="this-page-menu">
370 <li><a href="_sources/configuration.txt"
371 rel="nofollow">Show Source</a></li>
372 </ul>
373<div id="searchbox" style="display: none">
374 <h3>Quick search</h3>
375 <form class="search" action="search.html" method="get">
376 <input type="text" name="q" />
377 <input type="submit" value="Go" />
378 <input type="hidden" name="check_keywords" value="yes" />
379 <input type="hidden" name="area" value="default" />
380 </form>
381 <p class="searchtip" style="font-size: 90%">
382 Enter search terms or a module, class or function name.
383 </p>
384</div>
385<script type="text/javascript">$('#searchbox').show(0);</script>
386 </div>
387 </div>
388 <div class="clearer"></div>
389 </div>
390 <div class="related">
391 <h3>Navigation</h3>
392 <ul>
393 <li class="right" style="margin-right: 10px">
394 <a href="genindex.html" title="General Index"
395 >index</a></li>
396 <li class="right" >
397 <a href="running.html" title="Running Postman"
398 >next</a> |</li>
399 <li class="right" >
400 <a href="install.html" title="Installation instructions"
401 >previous</a> |</li>
402 <li><a href="index.html">Postman 0.1.0 documentation</a> &raquo;</li>
403 </ul>
404 </div>
405 <div class="footer">
406 &copy; Copyright 2012, Soluciones Informaticas Codigo23 S.L.U..
407 Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.2.
408 </div>
409 </body>
410</html>
Note: See TracBrowser for help on using the repository browser.