Differences between revisions 10 and 36 (spanning 26 versions)
Revision 10 as of 2012-03-13 15:44:10
Size: 3939
Editor: benste
Comment:
Revision 36 as of 2018-04-20 06:16:05
Size: 180
Editor: maxking
Comment:
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
#pragma page-filename DEV/versions/13304111
This is a quick guide to setup a development environment to work on Mailman 3's web ui. If all goes as planned, you should be done within ~5 minutes. This has been tested on Ubuntu 11.04.
#pragma page-filename DEV/versions/13303871
Line 4: Line 3:
In order to download the components necessary you need to have the Bazaar VCS installed on your system. Mailman and mailman.client need at least Python version 2.6. {{{#!wiki warning
'''This guide is obsolete! See [[http://docs.mailman3.org/en/latest/devsetup.html]] to setup mailman3.'''
Line 6: Line 6:
== GNU Mailman 3 ==
First download the latest revision of Mailman 3 from launchpad.

{{{
$ bzr branch lp:mailman
Line 12: Line 7:

Install and test:

{{{
$ cd mailman 
$ python bootstrap.py
$ bin/buildout
$ bin/test
}}}

If you get no errors you can now start Mailman:

{{{
$ bin/mailman start
$ 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) ==
Download from launchpad:

{{{
$ bzr branch lp:mailman.client
}}}

Install in development mode to be able to change the code without working directly on the PYTHONPATH.

{{{
$ cd mailman.client
$ sudo python setup.py develop
$ cd ..
}}}

== Django >= 1.3 ==
The web ui is a pluggable Django application. Therefore you need to have Django (at least version 1.3) installed.

{{{
$ wget http://www.djangoproject.com/download/1.3.1/tarball/ -O Django-1.3.1.tar.gz
$ tar xzf Django-1.3.1.tar.gz
$ cd Django-1.3.1
$ sudo python setup.py install
$ cd ..
}}}

== The following information has changed during the current development and will be updated as soon as it becomes a little bit more stable ==
== --(mailman_django)-- ==
--(This Django app contains the code for the web ui. Thanks go out to Anna Granudd and Benedict Stein who started this app as part of their Google Summer of Code projects in 2010 and 2011!)--

{{{
$ bzr branch lp:mailmanweb
}}}

--(Install it, also in development mode:)--

{{{
$ cd mailmanweb
$ sudo python setup.py develop
$ cd ..
}}}

== --(Setup a simple Django project to host the web ui)-- ==
--(The last thing you need to set up is a Django site to host the web ui application. This sample project contains all necessary settings to get the application up and running using Django's development server:)--

{{{
$ bzr branch lp:~flo-fuchs/mailmanweb/django_dev_setup
}}}

--(Now change to the branch dir, let Django create a db file and start the dev server:)--

{{{
$ cd django_dev_setup
$ python manage.py syncdb
$ python manage.py runserver
}}}

--(Now direct your browser to:)-- --([[http://localhost:8000]])--

== --(Logging in)-- ==
--(Authentication against the ReST API is not yet implemented, but there's a dummy AuthBackend in mailman-django that mimics auth behaviour. To login use the credentials hard-coded in:)--

{{{
./transition/src/mailman_django/auth/restbackend.py
}}}

== --(A note for MacOS X users (and possibly others running python 2.7))-- ==
--(On an OS X 10.7 (Lion) system, some of these steps needed to be modified to use python2.6 instead of python. (In particular, bzr is known to behave badly when used python2.7 on OS X 10.7 at the moment )----( hopefully this will be fixed and no longer an issue soon.))--

--(You will need to install the latest version of XCode on MacOS 10.7, which is available for free from the app store. If you had a previous version of XCode installed when you upgraded to 10.7, it will no longer work and will not have automatically been upgraded, so be prepared to install again. Once you have it installed from the app store, you will still need to go run the installer from /Applications to complete the installation.)--
----

 * [[DEV/Mac Mailman development setup guide|Mac Mailman development setup guide]]

----

<<IncludeComments>>

This guide is obsolete! See http://docs.mailman3.org/en/latest/devsetup.html to setup mailman3.

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