« back to all changes in this revision
Viewing changes to src/postorius/doc/_build/html/setup.html
- browse files at revision 56
- compare with another revision
- download diff
- download tarball
- view history from revision 56
- Committer: Florian Fuchs
- Date: 2012-03-23 22:54:46 UTC
- Revision ID: flo.fuchs@gmail.com-20120323225446-bm7y4b0pc70zug79
doc folder cleanup
- files added:
- src/postorius/doc/_build/doctrees/news.doctree
- files removed:
- src/postorius/doc/_build/doctrees/acknowledgements.doctree
- files modified:
- src/postorius/doc/_build/doctrees/environment.pickle
added
removed
src/postorius/doc/_build/html/setup.html
7
7
<head>
8
8
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9
9
10
<title>Installation — mailman_django v0.1 documentation</title>
10
<title>Installation — mailmanweb v0.1 documentation</title>
11
11
<link rel="stylesheet" href="_static/default.css" type="text/css" />
12
12
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
13
13
<script type="text/javascript">
22
22
<script type="text/javascript" src="_static/jquery.js"></script>
23
23
<script type="text/javascript" src="_static/underscore.js"></script>
24
24
<script type="text/javascript" src="_static/doctools.js"></script>
25
<link rel="top" title="mailman_django v0.1 documentation" href="index.html" />
25
<link rel="top" title="mailmanweb v0.1 documentation" href="index.html" />
26
26
<link rel="next" title="Using the Django App - Developers Resource" href="using.html" />
27
<link rel="prev" title="Welcome to mailman_django’s documentation!" href="index.html" />
27
<link rel="prev" title="News" href="news.html" />
28
28
</head>
29
29
<body>
30
30
<div class="related">
40
40
<a href="using.html" title="Using the Django App - Developers Resource"
41
41
accesskey="N">next</a> |</li>
42
42
<li class="right" >
43
<a href="index.html" title="Welcome to mailman_django’s documentation!"
43
<a href="news.html" title="News"
44
44
accesskey="P">previous</a> |</li>
45
<li><a href="index.html">mailman_django v0.1 documentation</a> »</li>
45
<li><a href="index.html">mailmanweb v0.1 documentation</a> »</li>
46
46
</ul>
47
47
</div>
48
48
53
53
54
54
<div class="section" id="installation">
55
55
<h1>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h1>
56
<blockquote>
57
<div><div class="admonition warning">
58
<p class="first admonition-title">Warning</p>
59
<p>This installation guide is outdated and needs to be updated.
60
Please use the following resources instead:</p>
61
<p>To install GNU Mailman follow the instructions in the documentation:
62
<a class="reference external" href="http://packages.python.org/mailman/">http://packages.python.org/mailman/</a></p>
63
<p>A description how to run postorius on Django’s dev server, can be found in
64
the GNU Mailman wiki:
65
<a class="reference external" href="http://wiki.list.org/display/DEV/A+5+minute+guide+to+get+the+Mailman+web+UI+running">http://wiki.list.org/display/DEV/A+5+minute+guide+to+get+the+Mailman+web+UI+running</a></p>
66
<p class="last">You can also find a guide how to run postorius using the Apache web server
67
on the Mailman wiki:
68
<a class="reference external" href="http://wiki.list.org/display/DEV/How+to+get+Postorius+running+on+Apache+and+mod_wsgi">http://wiki.list.org/display/DEV/How+to+get+Postorius+running+on+Apache+and+mod_wsgi</a></p>
69
</div>
70
</div></blockquote>
56
71
<div class="section" id="mailman3-a7">
57
72
<h2>Mailman3 - a7<a class="headerlink" href="#mailman3-a7" title="Permalink to this headline">¶</a></h2>
58
73
<ul>
78
93
</li>
79
94
<li><p class="first">Run the Installation from a Shell (not Python)</p>
80
95
<blockquote>
81
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>python bootstrap.py
96
<div><div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>python bootstrap.py
82
97
<span class="nv">$ </span>bin/buildout
83
98
</pre></div>
84
99
</div>
85
</blockquote>
100
</div></blockquote>
86
101
</li>
87
102
<li><p class="first">Vertify that everything was setup correclty and your branch fullfills the version requirements by running it’s own test module</p>
88
103
<blockquote>
89
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>bin/test
104
<div><div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>bin/test
90
105
</pre></div>
91
106
</div>
92
</blockquote>
107
</div></blockquote>
93
108
</li>
94
109
<li><p class="first">Now you’re able to run mailman using</p>
95
110
<blockquote>
96
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>bin/mailman
111
<div><div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>bin/mailman
97
112
</pre></div>
98
113
</div>
99
</blockquote>
114
</div></blockquote>
100
115
</li>
101
116
</ul>
102
117
</div>
106
121
The Python Bindings were used later on within our Django Application to access the Server. Failing to install the Client would result in an offline version of WebUI</p>
107
122
<p>Once again start by branching the code which is on Launchpad</p>
108
123
<blockquote>
109
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>bzr branch lp:mailman.client
124
<div><div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>bzr branch lp:mailman.client
110
125
</pre></div>
111
126
</div>
112
</blockquote>
127
</div></blockquote>
113
128
<div class="admonition note">
114
129
<p class="first admonition-title">Note</p>
115
130
<p class="last">We’ve successfully tested our functionality with Revision 16 - In case the Client gets updated which it surely will in future we can’t guarentee that it is compatible anymore.</p>
116
131
</div>
117
132
<p>As you only want to run the Client and not modify it’s code you’re fine with running the install command from within the directory. At the moment this requires Sudo Priveledges as files will copied to the Python Site-Packages Directory which is available to all users.</p>
118
133
<blockquote>
119
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>sudo python setup.py install
134
<div><div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>sudo python setup.py install
120
135
</pre></div>
121
136
</div>
122
</blockquote>
137
</div></blockquote>
123
138
<div class="admonition note">
124
139
<p class="first admonition-title">Note</p>
125
140
<p>If you want to change parts of the Client you can use the development option which will create a Symlink instead of a Hardcopy of all files:</p>
152
167
<p>We’ve created this branch for quick development - everyone is free to use his own Django site, but this one already includes a couple of modifications we’ve made that will allow running the Development Server just a few seconds after Branching both Site and App.</p>
153
168
<p>As far as I know at the moment we’ve made the following alignments: (All of these are in the settings.py file of the Django Site)</p>
154
169
<blockquote>
155
<p>REST_SERVER = ‘localhost:8001’
170
<div><p>REST_SERVER = ‘localhost:8001’
156
171
API_USER = ‘restadmin’
157
172
API_PASS = ‘restpass’</p>
158
173
<div class="admonition note">
159
174
<p class="first admonition-title">Note</p>
160
175
<p class="last">These are the default values used by the Mailman Client we’ve installed earlier. Feel free to modify the password and username if you need to.</p>
161
176
</div>
162
</blockquote>
177
</div></blockquote>
163
178
<p>MAILMAN_TEST_BINDIR = ‘/home/benste/Projects/Gsoc_mailman/mailman-3.0.0a7/bin’
164
179
#/home/florian/Development/mailman/bin’</p>
165
180
<blockquote>
166
<div class="admonition note">
181
<div><div class="admonition note">
167
182
<p class="first admonition-title">Note</p>
168
183
<p class="last">Running the test modules requires to launch a special version of mailman with it’s own testing DB otherwise you’d destroy you’re sites content during testing. This Path needs to point to YOUR own installation of mailman.</p>
169
184
</div>
170
</blockquote>
185
</div></blockquote>
171
186
<p>MAILMAN_THEME = “default”</p>
172
187
<blockquote>
173
<div class="admonition note">
188
<div><div class="admonition note">
174
189
<p class="first admonition-title">Note</p>
175
190
<p class="last">We decided to allow simple Appearance Modifications, to use a custom CSS you could simply add a Directory within the media directory of the app and Link it’s name here. All HTML Pages will use the Styles from the Directory mentioned in here</p>
176
191
</div>
177
</blockquote>
192
</div></blockquote>
178
193
<p>PROJECT_PATH = os.path.abspath(os.path.dirname(__file__))
179
194
MEDIA_ROOT = os.path.join(os.path.split(PROJECT_PATH)[0], “mailman_django/media/mailman_django/”)</p>
180
195
<blockquote>
181
<div class="admonition note">
196
<div><div class="admonition note">
182
197
<p class="first admonition-title">Note</p>
183
198
<p class="last">Absolute path to the directory that holds media.
184
199
Example: “/home/media/media.lawrence.com/”</p>
185
200
</div>
186
</blockquote>
201
</div></blockquote>
187
202
<p>MEDIA_URL = ‘/mailman_media/’</p>
188
203
<blockquote>
189
<div class="admonition note">
204
<div><div class="admonition note">
190
205
<p class="first admonition-title">Note</p>
191
<p class="last">URL that handles the media served from MEDIA_ROOT. Make sure to use a trailing slash if there is a path component (optional in other cases).Examples: “<a class="reference external" href="http://media.lawrence.com">http://media.lawrence.com</a>“, “<a class="reference external" href="http://example.com/media/">http://example.com/media/</a>“</p>
206
<p class="last">URL that handles the media served from MEDIA_ROOT. Make sure to use a trailing slash if there is a path component (optional in other cases).Examples: “<a class="reference external" href="http://media.lawrence.com">http://media.lawrence.com</a>”, “<a class="reference external" href="http://example.com/media/">http://example.com/media/</a>“</p>
192
207
</div>
193
</blockquote>
208
</div></blockquote>
194
209
<dl class="docutils">
195
210
<dt>AUTHENTICATION_BACKENDS = (</dt>
196
211
<dd><p class="first">‘mailman_django.auth.restbackend.RESTBackend’,
220
235
</dl>
221
236
<p>ROOT_URLCONF = ‘mailman_django.urls’</p>
222
237
<blockquote>
223
<div class="admonition note">
238
<div><div class="admonition note">
224
239
<p class="first admonition-title">Note</p>
225
240
<p class="last">This is where our URL Config is - if you run your own site with other Apps as well you might want to adjust this to your urls.py which includes our file.</p>
226
241
</div>
227
</blockquote>
242
</div></blockquote>
228
243
<dl class="docutils">
229
244
<dt>TEMPLATE_DIRS = (</dt>
230
245
<dd><p class="first">os.path.join(PROJECT_PATH, “mailman_django/templates”),</p>
251
266
</dl>
252
267
<p>Now that you know about all these you might start the development server. As usual in Django this is done by running</p>
253
268
<blockquote>
254
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>python manage.py runserver
269
<div><div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>python manage.py runserver
255
270
</pre></div>
256
271
</div>
257
</blockquote>
272
</div></blockquote>
258
273
<p>within the Django Site Directory - as usual the default address is localhost:8000
259
274
Of course it will only be able to start once our app is in place as well.</p>
260
275
</div>
262
277
<h2>Django Application<a class="headerlink" href="#django-application" title="Permalink to this headline">¶</a></h2>
263
278
<p>First get the files, and make sure you paste them into your Project directory and adjust it’s name to the appropriate configuration you’ve made earlier in the Django Site. Remeber our default is mailman_django</p>
264
279
<blockquote>
265
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>bzr branch lp:mailmanwebgsoc2011
280
<div><div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>bzr branch lp:mailmanwebgsoc2011
266
281
</pre></div>
267
282
</div>
268
</blockquote>
283
</div></blockquote>
269
284
<div class="admonition note">
270
285
<p class="first admonition-title">Note</p>
271
286
<p class="last">We’ve tested Revision 172</p>
296
311
</ul>
297
312
298
313
<h4>Previous topic</h4>
299
<p class="topless"><a href="index.html"
300
title="previous chapter">Welcome to mailman_django’s documentation!</a></p>
314
<p class="topless"><a href="news.html"
315
title="previous chapter">News</a></p>
301
316
<h4>Next topic</h4>
302
317
<p class="topless"><a href="using.html"
303
318
title="next chapter">Using the Django App - Developers Resource</a></p>
336
351
<a href="using.html" title="Using the Django App - Developers Resource"
337
352
>next</a> |</li>
338
353
<li class="right" >
339
<a href="index.html" title="Welcome to mailman_django’s documentation!"
354
<a href="news.html" title="News"
340
355
>previous</a> |</li>
341
<li><a href="index.html">mailman_django v0.1 documentation</a> »</li>
356
<li><a href="index.html">mailmanweb v0.1 documentation</a> »</li>
342
357
</ul>
343
358
</div>
344
359
<div class="footer">
345
360
© Copyright 2011, Benedict Stein.
346
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.1.
361
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
347
362
</div>
348
363
</body>
349
364
</html>
b'\\ No newline at end of file'
Loggerhead is a web-based interface for Breezy
Version: 2.0.1