diff options
| author | Terri Oda | 2017-05-22 22:48:01 +0000 |
|---|---|---|
| committer | Barry Warsaw | 2017-05-22 22:48:01 +0000 |
| commit | 0a3e51fb2abae84c9d2ee42c171ccce5b3e67573 (patch) | |
| tree | f8434851f4619431a44d4583c53deddb0d91a227 /src/mailman/docs/postorius.rst | |
| parent | 95fd3b9bd05b72038f2b20584edc6d9bb3fa3b19 (diff) | |
| download | mailman-0a3e51fb2abae84c9d2ee42c171ccce5b3e67573.tar.gz mailman-0a3e51fb2abae84c9d2ee42c171ccce5b3e67573.tar.zst mailman-0a3e51fb2abae84c9d2ee42c171ccce5b3e67573.zip | |
Diffstat (limited to 'src/mailman/docs/postorius.rst')
| -rw-r--r-- | src/mailman/docs/postorius.rst | 85 |
1 files changed, 9 insertions, 76 deletions
diff --git a/src/mailman/docs/postorius.rst b/src/mailman/docs/postorius.rst index f1cc2b96e..be522bb71 100644 --- a/src/mailman/docs/postorius.rst +++ b/src/mailman/docs/postorius.rst @@ -1,83 +1,16 @@ ================================== - Set up Postorius in five minutes + Set up Postorius (web interface) ================================== -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. +`Postorius`_ is Mailman 3's `Django`_-based web interface. You can +run Mailman 3 without it, but most people prefer to use the web interface for +changing list settings, viewing information about available lists, and +subscribing or unsubscribing. -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. +To set up Postorius, please see `the Postorius documentation`_. -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). +.. _`Postorius`: https://gitlab.com/mailman/postorius/ +.. _`Django`: http://djangoproject.org/ +.. _`the Postorius documentation`: https://postorius.readthedocs.io -.. _`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. |
