Differences between revisions 31 and 32
⇤ ← Revision 31 as of 2015-04-15 17:24:15 →
Size: 2517
Editor: terri
Comment: Removing warning
← Revision 32 as of 2015-11-04 00:53:03 → ⇥
Size: 2696
Editor: maxking
Comment:
Deletions are marked like this. Additions are marked like this.
Line 2: Line 2:

{{{#!wiki warning
'''This guide is obsolete! Look for other [[ http://mailman.readthedocs.org/en/latest/src/mailman/docs/WebUIin5.html | guide ]] to setup mailman3.'''

}}}

This guide is obsolete! Look for other guide to setup mailman3.

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.

Also, this 5-minute guide will not help you install HyperKitty, the web-based list archiver; for that, see this guide.

Set up your environment

Install the essentials

$ sudo apt-get install bzr python-dev python-virtualenv build-essential postfix

Set up a virtual environment (here we're calling it "postorius").

Get the sources 

(postorius)$ bzr branch lp:mailman
(postorius)$ bzr branch lp:mailman.client
(postorius)$ bzr branch lp:postorius
(postorius)$ bzr branch lp:~mailman-coders/postorius/postorius_standalone

If you get permission errors on this step, your ssh key is probably not in sync with what is on launchpad.net.

Set up sources

GNU Mailman 3

(postorius)$ cd mailman 
(postorius)$ python setup.py install

If you get no errors you can now start Mailman: 

(postorius)$ mailman start
(postorius)$ 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)

(postorius)$ cd mailman.client
(postorius)$ python setup.py develop
(postorius)$ cd ..

Postorius

(postorius)$ cd postorius
(postorius)$ python setup.py develop
(postorius)$ cd ..

Start the development server

(postorius)$ cd postorius_standalone
(postorius)$ python manage.py syncdb
(postorius)$ python manage.py runserver

Profit!

Now go to http://localhost:8000 to see the web UI for mailman!

Comments

Máirín Duffy

It looks like bootstrap.py was removed in late July, marked as obsolete. I followed these instructions to get mailman and postorious running, except I replaced the bootstrap.py step with the following: 

virtualenv --system-site-packages /path/to/your/installation
$ source /path/to/your/installation/bin/activate
$ python setup.py install

Now, if you get weird errors, remove the --system-site-packages from your virtualenv and try again. I guess depending on how your system is setup, it may or may not work with that option.

Máirín Duffy

I wrote up a guide on how to get hyperkitty up and running for development, and it includes the full modified steps I ran based on this document to get mailman 3 working. That guide is here:

https://fedorahosted.org/hyperkitty/wiki/DevelopmentSetupGuide

maxking

MailmanWiki: DEV/A 5 minute guide to get the Mailman web UI running (last edited 2018-04-20 06:16:05 by maxking)