Merge lp:~saprativejana/mailman/starting_guide into lp:mailman

Proposed by Saprative on 2015-03-09
Status: Needs review
Proposed branch: lp:~saprativejana/mailman/starting_guide
Merge into: lp:mailman
Diff against target: 166 lines (+161/-0)
1 file modified
src/mailman/doc/START.rst (+161/-0)
To merge this branch: bzr merge lp:~saprativejana/mailman/starting_guide
Reviewer Review Type Date Requested Status
Barry Warsaw 2015-03-09 Needs Fixing on 2015-03-15
Review via email: mp+252347@code.launchpad.net

Description of the change

this is the documentation of installation of mailman 3.Patch for the Bug #965520 Improve installation documentation reported by barry.

To post a comment you must log in.
7306. By saprative <email address hidden> on 2015-03-09

install document final

Barry Warsaw (barry) wrote :

Why does this branch add a directory src/mailman/doc and put START.rst in it? There's already a src/mailman/docs (notice the plural) directory with a START.rst file in it.

review: Needs Fixing

Unmerged revisions

7306. By saprative <email address hidden> on 2015-03-09

install document final

7305. By saprative <email address hidden> on 2015-03-09

Installation document

7304. By saprative <email address hidden> on 2015-03-08

installation_guide

7303. By saprative <email address hidden> on 2015-03-08

test

7302. By saprative <email address hidden> on 2015-03-08

install_doc

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
=== added directory 'src/mailman/doc'
=== added file 'src/mailman/doc/START.rst'
--- src/mailman/doc/START.rst 1970-01-01 00:00:00 +0000
+++ src/mailman/doc/START.rst 2015-03-09 19:15:57 +0000
@@ -0,0 +1,161 @@
1==================
2INSTALLATION GUIDE
3==================
4
5This is a quick guide to setup a development environment to work on
6Postorius, Mailman 3's web UI (and, in the process, install the core Mailman
7engine and Mailman.client as well). If all goes as planned, you should be
8done within ~5 minutes. This has been tested on Ubuntu 11.04 and OS X
910.8.1. Please note that the Python provided by apple for OSX will not
10work; you need to install your own version of python (e.g. using fink or
11macports). The Mac Mailman development setup guide has instructions using
12homebrew if you need additional instructions.
13
14
15Packages to be installed:
16
17bzr python-dev python-virtualenv build-essential postfix
18
19For Ubuntu users: sudo apt-get install bzr python-dev python-virtualenv
20build-essential postfix
21
22For Mac user: Go to http://wiki.list.org/DEV/Mac%20Mailman%20development%
2320setup%20guide
24
25
26Virtual Environment
27===================
28
29Install virtualenv via pip:
30
31$ pip install virtualenv
32
33Basic
34-----
35Create a virtual environment for a project:
36$ cd my_project_folder
37$ virtualenv venv
38
39virtualenv venv will create a folder in the current directory which will
40contain the Python executable files, and a copy of the pip library which
41you can use to install other packages. The name of the virtual environment
42(in this case, it was venv) can be anything; omitting the name will
43place the files in the current directory instead.This creates a copy of
44Python in whichever directory you ran the command in, placing it in a
45folder named venv.
46
47Interpreter choice
48------------------
49You can also use a Python interpreter of your choice.
50
51$ virtualenv -p /usr/bin/python2.7 venv
52
53This will use the Python interpreter in /usr/bin/python2.7
54
55Activating Environment
56-----------------------
57To begin using the virtual environment, it needs to be activated.
58
59$ source venv/bin/activate
60
61The name of the current virtual environment will now appear on the left of
62the prompt (e.g. (venv)Your-Computer:your_project UserName$) to let you
63know that it’s active. From now on, any package that you install using pip
64will be placed in the venv folder, isolated from the global Python
65installation.
66
67Installing packages
68-------------------
69Install packages as usual, for example:
70
71$ pip install requests
72
73Deactivate
74----------
75If you are done working in the virtual environment for the moment, you can
76deactivate it:
77
78$ deactivate
79
80This puts you back to the system’s default Python interpreter with all its
81installed libraries.
82
83To delete a virtual environment, just delete its folder. (In this case, it
84would be rm -rf venv.)
85
86For more info go to: http://docs.python-guide.org/en/latest/dev/virtualenvs/
87
88
89Get the sources
90===============
91
92(venv)$ bzr branch lp:mailman
93(venv)$ bzr branch lp:mailman.client
94(venv)$ bzr branch lp:postorius
95(venv)$ bzr branch lp:~mailman-coders/postorius/postorius_standalone
96
97If you get permission errors on this step, your ssh key is probably not in
98sync with what is on launchpad.net.
99
100
101GNU Mailman 3
102=============
103
104Mailman 3 sould be installed using python 3.4
105
106$virtualenv -p /usr/bin/python3.4 venv #for using python 3.4
107
108(venv)$ cd mailman
109(venv)$ python setup.py install
110
111If you get no errors you can now start Mailman:
112
113(venv)$ mailman start
114(venv)$ cd ..
115
116At this point Mailman will not send nor receive any real emails. But that's
117fine as long as you only want to work on the components related to the
118ReST client or the web ui.
119
120
121mailman.client (the Python bindings for Mailman's ReST API)
122===========================================================
123
124mailman.client sould be installed using python 2.7
125
126$virtualenv -p /usr/bin/python2.7 venv #for using python 2.7
127
128(venv)$ cd mailman.client
129(venv)$ python setup.py develop
130(venv)$ cd ..
131
132
133Postorius
134=========
135
136Postorius sould be installed using python 2.7
137
138$virtualenv -p /usr/bin/python2.7 venv #for using python 2.7
139
140(venv)$ cd postorius
141(venv)$ python setup.py develop
142(venv)$ cd ..
143
144Server Configuration
145====================
146Start the development server
147
148Postorius sould be installed using python 2.7
149
150$virtualenv -p /usr/bin/python2.7 venv #for using python 2.7
151
152(venv)$ cd postorius_standalone
153(venv)$ python manage.py syncdb
154(venv)$ python manage.py runserver
155
156Now go to http://localhost:8000 to see the web UI for mailman!
157
158For hyperkitty installation: https://fedorahosted.org/hyperkitty/wiki/
159DevelopmentSetupGuide
160
161