Skip to content
This repository has been archived by the owner on Nov 26, 2024. It is now read-only.

Latest commit

 

History

History
99 lines (75 loc) · 3.17 KB

README.rst

File metadata and controls

99 lines (75 loc) · 3.17 KB

GroupServer

A mailing list manager with a great web interface

Authors: Michael JasonSmith
Richard Waid
Alice Rose
Dan Randow
Bill Bushey
Marek Kuziel
Contact: Michael JasonSmith <[email protected]>
Date: 2015-12-16
Organization: GroupServer.org
Copyright: This document is licensed under a Creative Commons Attribution-Share Alike 4.0 International License
Status: Build Status Documentation Status

This is GroupServer: a mailing-list manager with an excellent integrated web interface.

  • If you are looking at this README in a directory, then the directory contains all the necessary information for downloading and installing GroupServer. The system will be run from a Python virtual-environment that is created in this folder.
  • If you are looking at the repository on GitHub, then this is what goes into a release of GroupServer.

Installing

An up-to-date version of installation documentation is available from Read the Docs, and a copy of the installation instructions that were current when this version of GroupServer was packaged is in the docs directory.

The documentation for GroupServer can be generated by installing Sphinx and running make in the docs directory:

$  virtualenv --python=python2.7 .
$ . ./bin/activate
$ pip install Sphinx
$ cd docs
$ make html

The HTML documentation will be written to the _build/html folder.

Repository

The repository on GitHub is named buildout because it uses zc.buildout to download and install all the components that make up the system. A release of GroupServer is little more than the contents of the repository in a tar-ball [1]:

$ hg archive -p groupserver-{yy}.{mm} -ttgz -X ".hg*" \
  groupserver-{yy}.{mm}.tar.gz
[1]Assuming that Hg-Git is used.

Resources