~abompard/mailman/mailman-templates-utf8

« back to all changes in this revision

Viewing changes to src/mailman/docs/WebUIin5.rst

  • Committer: Barry Warsaw
  • Date: 2015-01-20 22:37:20 UTC
  • mfrom: (7288.1.3 mailman-maxking)
  • Revision ID: barry@list.org-20150120223720-c05vtjylqvhmkiht
 * Improve the documentation describing how to run Alembic to add new schema
   migrations.  Given by Abhilash Raj.

Show diffs side-by-side

added added

removed removed

Lines of Context:
7
7
done within 5 minutes.  This has been tested on Ubuntu 11.04.
8
8
 
9
9
In order to download the components necessary you need to have the `Bazaar`_
10
 
version control system installed on your system.  Mailman requires Python 2.7,
 
10
version control system installed on your system.  Mailman requires Python 3.4,
11
11
while mailman.client needs at least Python version 2.6.
12
12
 
13
13
It's probably a good idea to set up a virtual Python environment using
14
 
`virtualenv`_.  `Here is a brief HOWTO`_.
 
14
`virtualenv`_.  `Here is a brief HOWTO`_.  You would need two separate virtual
 
15
environment one using Python version 2.6 or 2.7 (for Postorius and
 
16
mailman.client) and other using Python version 3.4 (for Mailman core).
15
17
 
16
18
.. _`virtualenv`: http://pypi.python.org/pypi/virtualenv
17
19
.. _`Here is a brief HOWTO`: ./ArchiveUIin5.html#get-it-running-under-virtualenv
24
26
First download the latest revision of Mailman 3 from Launchpad.
25
27
::
26
28
 
27
 
  $ bzr branch lp:mailman
28
 
 
29
 
Install and test::
30
 
 
31
 
  $ cd mailman
32
 
  $ python bootstrap.py
33
 
  $ bin/buildout
34
 
  $ bin/test
 
29
  $(py3) bzr branch lp:mailman
 
30
 
 
31
Install the Core::
 
32
 
 
33
  $(py3) cd mailman
 
34
  $(py3) python setup.py develop
35
35
 
36
36
If you get no errors you can now start Mailman::
37
37
 
38
 
  $ bin/mailman start
39
 
  $ cd ..
 
38
  $(py3) mailman start
 
39
  $(py3) cd ..
40
40
 
41
41
At this point Mailman will not send nor receive any real emails.  But that's
42
42
fine as long as you only want to work on the components related to the REST
46
46
mailman.client (the Python bindings for Mailman's REST API)
47
47
===========================================================
48
48
 
49
 
Download from Launchpad::
 
49
Now you should switch to the virtual environment running Python version 2.6 or
 
50
2.7.  Download the client from Launchpad::
50
51
 
51
 
  $ bzr branch lp:mailman.client
 
52
  $(py2) bzr branch lp:mailman.client
52
53
 
53
54
Install in development mode to be able to change the code without working
54
55
directly on the PYTHONPATH.
55
56
::
56
57
 
57
 
  $ cd mailman.client
58
 
  $ sudo python setup.py develop
59
 
  $ cd ..
60
 
 
61
 
 
62
 
Django >= 1.3
63
 
=============
64
 
 
65
 
Postorius is a pluggable Django application.  Therefore you need to have
66
 
Django (at least version 1.3) installed.
67
 
::
68
 
 
69
 
  $ wget http://www.djangoproject.com/download/1.3.1/tarball/ -O Django-1.3.1.tar.gz
70
 
  $ tar xzf Django-1.3.1.tar.gz
71
 
  $ cd Django-1.3.1
72
 
  $ sudo python setup.py install
73
 
  $ cd ..
 
58
  $(py2) cd mailman.client
 
59
  $(py2) sudo python setup.py develop
 
60
  $(py2) cd ..
74
61
 
75
62
 
76
63
Postorius
78
65
 
79
66
::
80
67
 
81
 
  $ bzr branch lp:postorius
82
 
  $ cd postorius
83
 
  $ sudo python setup.py develop
 
68
  $(py2) bzr branch lp:postorius
 
69
  $(py2) cd postorius
 
70
  $(py2) sudo python setup.py develop
84
71
 
85
72
 
86
73
Start the development server
87
74
============================
88
75
 
89
 
::
 
76
Postorius is a Django app which can be used with any Django project.  We have
 
77
a project already developed which you can set up like this::
90
78
 
91
 
  $ cd dev_setup
92
 
  $ python manage.py syncdb
93
 
  $ python manage.py runserver
 
79
  $(py2) bzr branch lp:~mailman-coders/postorius/postorius_standalone
 
80
  $(py2) cd postorius_standalone
 
81
  $(py2) python manage.py syncdb
 
82
  $(py2) python manage.py runserver
94
83
 
95
84
The last command will start the dev server on http://localhost:8000.
96
85