source: mailjam/docs/src/_build/html/index.html@ 34:ea8b7fdd203d

Last change on this file since 34:ea8b7fdd203d was 27:b1d527287347, checked in by Borja Lopez <borja@…>, 12 years ago

Added more information to the README file

Updated the architecture scheme so it fits the renaming of the project
to mailjam

Fixed the search path for configuration files. Now it searches on /etc
first, /usr/local/etc then.

Added more docs regarding the installation, configuration and running
of each component
File size: 7.3 KB
RevLine 
[13]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
[16]11 <title>Mailjam official documentation &mdash; Mailjam 0.1.0 documentation</title>
[13]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>
[16]28 <link rel="top" title="Mailjam 0.1.0 documentation" href="#" />
29 <link rel="next" title="Overview of mailjam’s architecture" href="overview.html" />
[13]30 </head>
31 <body>
32 <div class="related">
33 <h3>Navigation</h3>
34 <ul>
35 <li class="right" style="margin-right: 10px">
36 <a href="genindex.html" title="General Index"
37 accesskey="I">index</a></li>
38 <li class="right" >
[16]39 <a href="overview.html" title="Overview of mailjam’s architecture"
[13]40 accesskey="N">next</a> |</li>
[16]41 <li><a href="#">Mailjam 0.1.0 documentation</a> &raquo;</li>
[13]42 </ul>
43 </div>
44
45 <div class="document">
46 <div class="documentwrapper">
47 <div class="bodywrapper">
48 <div class="body">
49
[16]50 <div class="section" id="mailjam-official-documentation">
51<h1>Mailjam official documentation<a class="headerlink" href="#mailjam-official-documentation" title="Permalink to this headline"></a></h1>
52<p>This is the official documentation for <a class="reference external" href="https://bitbucket.org/codigo23/mailjam">Mailjam</a>, a mailing list management
[13]53software written in <a class="reference external" href="http://python.org">Python</a>.</p>
54<p>Contents:</p>
55<div class="toctree-wrapper compound">
56<ul>
[16]57<li class="toctree-l1"><a class="reference internal" href="overview.html">Overview of mailjam&#8217;s architecture</a><ul>
[13]58<li class="toctree-l2"><a class="reference internal" href="overview.html#introduction">Introduction</a></li>
[16]59<li class="toctree-l2"><a class="reference internal" href="overview.html#mailjam-daemon">Mailjam daemon</a></li>
[13]60<li class="toctree-l2"><a class="reference internal" href="overview.html#mta-client">MTA client</a></li>
61<li class="toctree-l2"><a class="reference internal" href="overview.html#cli-client">CLI client</a></li>
62<li class="toctree-l2"><a class="reference internal" href="overview.html#web-client">Web client</a></li>
63</ul>
64</li>
65<li class="toctree-l1"><a class="reference internal" href="install.html">Installation instructions</a><ul>
66<li class="toctree-l2"><a class="reference internal" href="install.html#first-install-dependencies">First, install dependencies</a></li>
[16]67<li class="toctree-l2"><a class="reference internal" href="install.html#second-install-mailjam">Second, install Mailjam</a></li>
68<li class="toctree-l2"><a class="reference internal" href="install.html#setting-up-mailjam">Setting up Mailjam</a></li>
69<li class="toctree-l2"><a class="reference internal" href="install.html#running-mailjam">Running Mailjam</a></li>
[13]70<li class="toctree-l2"><a class="reference internal" href="install.html#running-tests-developers-only">Running tests (developers only)</a></li>
71</ul>
72</li>
73<li class="toctree-l1"><a class="reference internal" href="configuration.html">Configuration</a><ul>
[27]74<li class="toctree-l2"><a class="reference internal" href="configuration.html#mailjam-daemon-configuration-file-mailjam-conf">Mailjam daemon configuration file - mailjam.conf</a></li>
75<li class="toctree-l2"><a class="reference internal" href="configuration.html#mailjam-mta-client-configuration-file-mailjam-mta-conf">Mailjam MTA client configuration file - mailjam-mta.conf</a></li>
76<li class="toctree-l2"><a class="reference internal" href="configuration.html#mailjam-cli-client-configuration-file-mailjam-cli-conf">Mailjam CLI client configuration file - mailjam-cli.conf</a></li>
[13]77</ul>
78</li>
[27]79<li class="toctree-l1"><a class="reference internal" href="running.html">Running Mailjam</a><ul>
80<li class="toctree-l2"><a class="reference internal" href="running.html#the-daemon">The daemon</a></li>
81<li class="toctree-l2"><a class="reference internal" href="running.html#the-cli-client">The CLI client</a></li>
82<li class="toctree-l2"><a class="reference internal" href="running.html#the-mta-client">The MTA client</a></li>
83<li class="toctree-l2"><a class="reference internal" href="running.html#the-web-client">The Web client</a></li>
84</ul>
85</li>
[13]86<li class="toctree-l1"><a class="reference internal" href="examples.html">Some examples</a></li>
87<li class="toctree-l1"><a class="reference internal" href="development.html">Developers documentation</a></li>
88</ul>
89</div>
90</div>
91<div class="section" id="indices-and-tables">
92<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline"></a></h1>
93<ul class="simple">
94<li><a class="reference internal" href="genindex.html"><em>Index</em></a></li>
95<li><a class="reference internal" href="py-modindex.html"><em>Module Index</em></a></li>
96<li><a class="reference internal" href="search.html"><em>Search Page</em></a></li>
97</ul>
98</div>
99
100
101 </div>
102 </div>
103 </div>
104 <div class="sphinxsidebar">
105 <div class="sphinxsidebarwrapper">
106 <h3><a href="#">Table Of Contents</a></h3>
107 <ul>
[16]108<li><a class="reference internal" href="#">Mailjam official documentation</a><ul>
[13]109</ul>
110</li>
111<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
112</ul>
113
114 <h4>Next topic</h4>
115 <p class="topless"><a href="overview.html"
[16]116 title="next chapter">Overview of mailjam&#8217;s architecture</a></p>
[13]117 <h3>This Page</h3>
118 <ul class="this-page-menu">
119 <li><a href="_sources/index.txt"
120 rel="nofollow">Show Source</a></li>
121 </ul>
122<div id="searchbox" style="display: none">
123 <h3>Quick search</h3>
124 <form class="search" action="search.html" method="get">
125 <input type="text" name="q" />
126 <input type="submit" value="Go" />
127 <input type="hidden" name="check_keywords" value="yes" />
128 <input type="hidden" name="area" value="default" />
129 </form>
130 <p class="searchtip" style="font-size: 90%">
131 Enter search terms or a module, class or function name.
132 </p>
133</div>
134<script type="text/javascript">$('#searchbox').show(0);</script>
135 </div>
136 </div>
137 <div class="clearer"></div>
138 </div>
139 <div class="related">
140 <h3>Navigation</h3>
141 <ul>
142 <li class="right" style="margin-right: 10px">
143 <a href="genindex.html" title="General Index"
144 >index</a></li>
145 <li class="right" >
[16]146 <a href="overview.html" title="Overview of mailjam’s architecture"
[13]147 >next</a> |</li>
[16]148 <li><a href="#">Mailjam 0.1.0 documentation</a> &raquo;</li>
[13]149 </ul>
150 </div>
151 <div class="footer">
152 &copy; Copyright 2012, Soluciones Informaticas Codigo23 S.L.U..
153 Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.2.
154 </div>
155 </body>
156</html>
Note: See TracBrowser for help on using the repository browser.