Newer
Older
postorius / README.rst
@Florian Fuchs Florian Fuchs on 23 Mar 2012 1 KB - removed some more mailmanweb remains
===================================
postorius - web ui for GNU Mailman
===================================

Copyright (C) 1998-2012 by the Free Software Foundation, Inc.

The postorius Django app provides a web user interface to
access GNU Mailman. 

postorius is free software: you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public License as
published by the Free Software Foundation, version 3 of the License.

postorius is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser
General Public License for more details.

You should have received a copy of the GNU Lesser General Public License
along with mailman.client. If not, see <http://www.gnu.org/licenses/>.


Requirements
============

postorius requires Python 2.6 or newer and mailman.client,
the official Python bindings for GNU Mailman, it also requires
django-social-auth.
The minimum Django version is 1.3.
postorius needs a running version of GNU Mailman version 3.


Installation
============

To install GNU Mailman follow the instructions in the documentation:
http://packages.python.org/mailman/

A description how to run postorius on Django's dev server, can be found in 
the GNU Mailman wiki: 
http://wiki.list.org/display/DEV/A+5+minute+guide+to+get+the+Mailman+web+UI+running

You can also find a guide how to run postorius using the Apache web server
on the Mailman wiki.


Acknowledgements
================

Many thanks go out to Anna Senarclens de Grancy and Benedict Stein for
developing the initial versions of this Django app during the Google Summer of
Code 2010 and 2011. 


Icons
=====

postorius uses the WPZOOM Developer Icon Set (http://www.wpzoom.com).