README.rst

   1 ===================================
   2 Postorius - web ui for GNU Mailman
   3 ===================================
   4 .. image:: https://gitlab.com/mailman/postorius/badges/master/build.svg
   5     :target: https://gitlab.com/mailman/postorius/commits/master
   6
   7 .. image:: https://readthedocs.org/projects/postorius/badge
   8     :target: https://postorius.readthedocs.io
   9
  10 .. image:: https://gitlab.com/mailman/postorius/badges/master/coverage.svg?job=coverage
  11     :target: https://mailman.gitlab.io/postorius
  12
  13 .. image:: http://img.shields.io/pypi/v/postorius.svg
  14     :target: https://pypi.python.org/pypi/postorius
  15
  16 .. image:: http://img.shields.io/pypi/dm/postorius.svg
  17     :target: https://pypi.python.org/pypi/postorius
  18
  19 Copyright (C) 1998-2017 by the Free Software Foundation, Inc.
  20
  21 The Postorius Django app provides a web user interface to
  22 access GNU Mailman.
  23
  24 Postorius is free software: you can redistribute it and/or
  25 modify it under the terms of the GNU Lesser General Public License as
  26 published by the Free Software Foundation, version 3 of the License.
  27
  28 Postorius is distributed in the hope that it will be useful,
  29 but WITHOUT ANY WARRANTY; without even the implied warranty of
  30 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser
  31 General Public License for more details.
  32
  33 You should have received a copy of the GNU Lesser General Public License
  34 along with mailman.client. If not, see <http://www.gnu.org/licenses/>.
  35
  36
  37 Requirements
  38 ============
  39
  40 Postorius requires Python 2.7 or newer and mailmanclient,
  41 the official Python bindings for GNU Mailman.
  42 The minimum Django version is 1.8.
  43 Postorius needs a running version of GNU Mailman version 3.
  44
  45
  46 NEWS/Changelog
  47 ==============
  48
  49 News and the changelog can be found in the package documentation:
  50
  51 src/postorius/doc/news.rst
  52
  53
  54 Installation
  55 ============
  56
  57 To install GNU Mailman follow the instructions in the documentation:
  58 http://mailman.readthedocs.org/
  59
  60 A description how to run Postorius on Django's dev server or deploying it
  61 using Apache/mod_wsgi or Nginx/uwsig, can be found in the package documentation:
  62
  63 src/postorius/doc/setup.rst
  64 src/postorius/doc/deployment.rst
  65
  66
  67 Acknowledgements
  68 ================
  69
  70 Many thanks go out to Anna Senarclens de Grancy and Benedict Stein for
  71 developing the initial versions of this Django app during the Google Summer of
  72 Code 2010 and 2011.