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

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

Commit message

Installation Guide

Description of the change

Bug #965520 Improve installation documentation
Sorry for the inconvenience actually i forgot to do the bzr add so a wrong submssion was made. So please review the installation documentation and if everything is all right then marge the project.

To post a comment you must log in.
Barry Warsaw (barry) wrote :

Please reformat all the documentation using reStructuredText format.

http://docutils.sourceforge.net/rst.html

review: Needs Fixing

Unmerged revisions

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