1 files changed, 83 insertions, 0 deletions

diff --git a/src/mailman/docs/postorius.rst b/src/mailman/docs/postorius.rst
new file mode 100644
index 000000000..f1cc2b96e
--- /dev/null
+++ b/src/mailman/docs/postorius.rst
@@ -0,0 +1,83 @@
+==================================
+ Set up Postorius in five minutes
+==================================
+
+This is a quick guide for setting up a development environment to work on
+Mailman 3's web UI, called Postorius.  If all goes as planned, you should be
+done within 5 minutes.  This has been tested on Ubuntu 11.04.
+
+In order to download the components necessary you need to have the `Git`_
+version control system installed on your system.  Mailman requires Python 3.4
+or newer, while mailman.client needs at least Python version 2.6.
+
+It's probably a good idea to set up a virtual Python environment using
+`virtualenv`_.  `Here is a brief HOWTO`_.  You would need two separate virtual
+environment one using Python version 2.6 or 2.7 (for Postorius and
+mailman.client) and other using Python 3 (for Mailman core).
+
+.. _`virtualenv`: http://pypi.python.org/pypi/virtualenv
+.. _`Here is a brief HOWTO`: ./ArchiveUIin5.html#get-it-running-under-virtualenv
+.. _`Git`: http://git-scm.com
+
+
+Mailman Core
+============
+
+First download the latest revision of Mailman 3 from Gitlab.
+::
+
+  $(py3) git clone git@gitlab.com:mailman/mailman.git
+
+Install the Core::
+
+  $(py3) cd mailman
+  $(py3) python setup.py develop
+
+If you get no errors you can now start Mailman::
+
+  $(py3) mailman start
+  $(py3) cd ..
+
+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.
+
+
+mailman.client (the Python bindings for Mailman's REST API)
+===========================================================
+
+Now you should switch to the virtual environment running Python version 2.6 or
+2.7.  Download the client from Gitlab::
+
+  $(py2) git clone git@gitlab.com:mailman/mailmanclient.git
+
+Install in development mode to be able to change the code without working
+directly on the PYTHONPATH.
+::
+
+  $(py2) cd mailmanclient
+  $(py2) python setup.py develop
+  $(py2) cd ..
+
+
+Postorius
+=========
+
+::
+
+  $(py2) git clone git@gitlab.com:mailman/postorius.git
+  $(py2) cd postorius
+  $(py2) python setup.py develop
+
+
+Start the development server
+============================
+
+Postorius is a Django app which can be used with any Django project.  We have
+a project already developed which you can set up like this::
+
+  $(py2) cd example_project
+  $(py2) python manage.py migrate
+  $(py2) python manage.py runserver
+
+The last command will start the dev server on http://localhost:8000.