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