1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Installation — HyperKitty v0.1 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '0.1',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="HyperKitty v0.1 documentation" href="index.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li><a href="index.html">HyperKitty v0.1 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="installation">
<h1>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h1>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">This installation guide covers HyperKitty, the web user interfaceaccess GNU Mailman v3
Archives. To install GNU Mailman follow the instructions in the documentation:
<a class="reference external" href="http://packages.python.org/mailman/">http://packages.python.org/mailman/</a></p>
</div>
<div class="section" id="install-dependencies">
<h2>Install Dependencies<a class="headerlink" href="#install-dependencies" title="Permalink to this headline">¶</a></h2>
<p>sudo pip install -r requirements.txt</p>
</div>
<div class="section" id="install-hyperkitty">
<h2>Install HyperKitty<a class="headerlink" href="#install-hyperkitty" title="Permalink to this headline">¶</a></h2>
<p>sudo python manage.py install</p>
</div>
<div class="section" id="setup-your-django-project">
<h2>Setup your django project<a class="headerlink" href="#setup-your-django-project" title="Permalink to this headline">¶</a></h2>
<p>Since you have now installed the necessary packages to run HyperKitty, it’s
time to setup your Django site.</p>
<p>First, get the project directory from launchpad:</p>
<div class="highlight-python"><pre>$ bzr branch bzr://bzr.fedorahosted.org/bzr/hyperkitty/hk-app</pre>
</div>
<p>Second, change the database setting in <tt class="docutils literal"><span class="pre">postorius_standalone/settings.py</span></tt> to
your preferred database. HyperKitty uses two databases, one to store the metadata
and other to store mails. Edit this file to reflect the correct database credential.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Detailed information on how to use different database engines can be found
in the <a class="reference external" href="https://docs.djangoproject.com/en/1.4/ref/settings/#databases">Django documentation</a>.</p>
</div>
<p>Third, prepare the database:</p>
<div class="highlight-python"><pre>$ cd hk-app
$ python manage.py syncdb
$ cd ..</pre>
</div>
<p>This will create the <tt class="docutils literal"><span class="pre">.db</span> <span class="pre">file</span></tt> (if you are using SQLite) and will setup all the
necessary db tables. You will also be prompted to create a superuser which
will act as an admin account for HyperKitty</p>
</div>
<div class="section" id="running-the-development-server">
<h2>Running the development server<a class="headerlink" href="#running-the-development-server" title="Permalink to this headline">¶</a></h2>
<p>The quickest way to run HyperKitty is to just start the development server:</p>
<div class="highlight-python"><pre>$ cd hk-app
$ python manage.py runserver</pre>
</div>
<div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p class="last">You should use the development server only locally. While it’s possible to
make your site publicly available using the dev server, you should never
do that in a production environment.</p>
</div>
</div>
<div class="section" id="running-hyperkitty-on-apache-with-mod-wsgi">
<h2>Running HyperKitty on Apache with mod_wsgi<a class="headerlink" href="#running-hyperkitty-on-apache-with-mod-wsgi" title="Permalink to this headline">¶</a></h2>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">This guide assumes that you know how to setup a VirtualHost with Apache.
If you are using SQLite, the <tt class="docutils literal"><span class="pre">.db</span></tt> file as well as its folder need to be
writable by the web server.</p>
</div>
<p>Edit <tt class="docutils literal"><span class="pre">apache/apache_django_wsgi.conf</span></tt> to point to your source code location.</p>
<p>Add following line to your apache/httpd configuration file</p>
<p>::
Include “/{path-to-hk-app}/apache/apache_django_wsgi.conf”</p>
<p>We’re almost ready. But you need to collect the static files from HyperKitty
(which resides somewhere on your pythonpath) to be able to serve them from the
site directory. All you have to do is to change into the
<tt class="docutils literal"><span class="pre">hk-app</span></tt> directory and run:</p>
<div class="highlight-python"><pre>$ python manage.py collectstatic</pre>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Installation</a><ul>
<li><a class="reference internal" href="#install-dependencies">Install Dependencies</a></li>
<li><a class="reference internal" href="#install-hyperkitty">Install HyperKitty</a></li>
<li><a class="reference internal" href="#setup-your-django-project">Setup your django project</a></li>
<li><a class="reference internal" href="#running-the-development-server">Running the development server</a></li>
<li><a class="reference internal" href="#running-hyperkitty-on-apache-with-mod-wsgi">Running HyperKitty on Apache with mod_wsgi</a></li>
</ul>
</li>
</ul>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/install.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" size="18" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li><a href="index.html">HyperKitty v0.1 documentation</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2012, Mailman Coders.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
</div>
</body>
</html>
|
