diff options
Diffstat (limited to 'src/mailman/docs')
| -rw-r--r-- | src/mailman/docs/hyperkitty.rst | 109 | ||||
| -rw-r--r-- | src/mailman/docs/postorius.rst | 85 |
2 files changed, 16 insertions, 178 deletions
diff --git a/src/mailman/docs/hyperkitty.rst b/src/mailman/docs/hyperkitty.rst index d56031fa9..e4296ceb4 100644 --- a/src/mailman/docs/hyperkitty.rst +++ b/src/mailman/docs/hyperkitty.rst @@ -1,108 +1,13 @@ -=================================== - Set up HyperKitty in five minutes -=================================== - -.. note:: - This document is way out of date. If you have access to the Web, - the most recent explanation of setting up a full Mailman 3 system, - including Postorius and HyperKitty, is the `Development Setup Guide`_ at - `FedoraHosted`_. If you must work offline, this document may be of some - use, but be careful. +============================== + Set up HyperKitty (archiver) +============================== The `HyperKitty`_ application aims at providing an interface to visualize and -explore Mailman archives. - -This is a `Django`_ project. - -Requirements -============ - -- A mail archive in `maildir format`_ (no, you don't need a running Mailman - 3!) Eventually HyperKitty will support `mbox format`_ for backward - compatibility with *Pipermail*, and *zipped maildirs* seem like a good idea - to save space. **Beware:** Although you'd think that we would be able to - manipulate the venerable *mbox* format safely and efficiently, that doesn't - seem to be the case. *Maildir* archives are **strongly** preferred, because - they are more robust to program bugs (whether in Mailman, HyperKitty, or in - the originating MUA!) -- Django is the web framework that supports the UI. -- `bunch`_ DOES WHAT? -- The `notmuch mail indexer`_ is used to generate indexes (and requires - `Xapian`_). -- HyperKitty itself, which is a UI, and not responsible for maintaining the - message archive itself. (Since the archive is in `maildir format`_, any - modern MTA or MDA can build one for you.) - - -Get it running (under virtualenv): ----------------------------------- - -It is generally a good idea to use `virtualenv`_ to create a stable -environment for your Python applications. - -- Create the virtualenv:: - - % virtualenv mailman3 - -- Activate the virtualenv:: - - % cd mailman3 - % source bin/activate - -You don't *have* to use virtualenv, though, and if you don't want to, just -omit the preceding steps. Continue with these steps. - -- Install Django and dependencies:: - - % easy_install django - % easy_install bunch - -- Install notmuch -- these are bindings that come with the notmuch C library. - The easiest way is probably to install them for your OS vendor and then - symlink them into the virtualenv similar to this:: - - % yum install -y python-notmuch +explore Mailman archives. This is a `Django`_ project. -- Note: on a multiarch system like Fedora, the directories may be lib64 rather - than lib on 64 bit systems. Next:: +To set up `HyperKitty`_, please see `the Hyperkitty documentation`_. - % cd lib/python2.7/site-packages - % ln -s /usr/lib/python2.7/site-packages/notmuch . - -- Note: this is the version of notmuch I tested with; others may work:: - - % ln -s /usr/lib/python2.7/site-packages/notmuch-0.11-py2.7.egg-info . - -- Install the HyperKitty sources:: - - % git clone https://github.com/hyperkitty/kittystore.git - % git clone https://github.com/hyperkitty/hyperkitty.git - % git clone https://github.com/hyperkitty/hyperkitty_standalone.git - - -Running HyperKitty ------------------- - -- Start it:: - - % cd hyperkitty - -- Put the static content where it should be:: - - % python manage.py collectstatic - -- Run the Django server:: - - % python manage.py runserver - - -.. _`Development Setup Guide`: https://fedorahosted.org/hyperkitty/wiki/DevelopmentSetupGuide -.. _`FedoraHosted`: https://fedorahosted.org/ .. _`HyperKitty`: https://fedorahosted.org/hyperkitty/ .. _`Django`: http://djangoproject.org/ -.. _`notmuch mail indexer`: http://notmuchmail.org -.. _`bunch`: http://pypi.python.org/pypi/bunch -.. _`Xapian`: http://xapian.org/ -.. _`maildir format`: http://en.wikipedia.org/wiki/Maildir -.. _`mbox format`: http://en.wikipedia.org/wiki/Mbox -.. _`virtualenv`: http://pypi.python.org/pypi/virtualenv +.. _`the Hyperkitty documentation`: https://hyperkitty.readthedocs.io + diff --git a/src/mailman/docs/postorius.rst b/src/mailman/docs/postorius.rst index f1cc2b96e..be522bb71 100644 --- a/src/mailman/docs/postorius.rst +++ b/src/mailman/docs/postorius.rst @@ -1,83 +1,16 @@ ================================== - Set up Postorius in five minutes + Set up Postorius (web interface) ================================== -This is a quick guide for setting up a development environment to work on -Mailman 3's web UI, called Postorius. If all goes as planned, you should be -done within 5 minutes. This has been tested on Ubuntu 11.04. +`Postorius`_ is Mailman 3's `Django`_-based web interface. You can +run Mailman 3 without it, but most people prefer to use the web interface for +changing list settings, viewing information about available lists, and +subscribing or unsubscribing. -In order to download the components necessary you need to have the `Git`_ -version control system installed on your system. Mailman requires Python 3.4 -or newer, while mailman.client needs at least Python version 2.6. +To set up Postorius, please see `the Postorius documentation`_. -It's probably a good idea to set up a virtual Python environment using -`virtualenv`_. `Here is a brief HOWTO`_. You would need two separate virtual -environment one using Python version 2.6 or 2.7 (for Postorius and -mailman.client) and other using Python 3 (for Mailman core). +.. _`Postorius`: https://gitlab.com/mailman/postorius/ +.. _`Django`: http://djangoproject.org/ +.. _`the Postorius documentation`: https://postorius.readthedocs.io -.. _`virtualenv`: http://pypi.python.org/pypi/virtualenv -.. _`Here is a brief HOWTO`: ./ArchiveUIin5.html#get-it-running-under-virtualenv -.. _`Git`: http://git-scm.com - -Mailman Core -============ - -First download the latest revision of Mailman 3 from Gitlab. -:: - - $(py3) git clone git@gitlab.com:mailman/mailman.git - -Install the Core:: - - $(py3) cd mailman - $(py3) python setup.py develop - -If you get no errors you can now start Mailman:: - - $(py3) mailman start - $(py3) 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) -=========================================================== - -Now you should switch to the virtual environment running Python version 2.6 or -2.7. Download the client from Gitlab:: - - $(py2) git clone git@gitlab.com:mailman/mailmanclient.git - -Install in development mode to be able to change the code without working -directly on the PYTHONPATH. -:: - - $(py2) cd mailmanclient - $(py2) python setup.py develop - $(py2) cd .. - - -Postorius -========= - -:: - - $(py2) git clone git@gitlab.com:mailman/postorius.git - $(py2) cd postorius - $(py2) python setup.py develop - - -Start the development server -============================ - -Postorius is a Django app which can be used with any Django project. We have -a project already developed which you can set up like this:: - - $(py2) cd example_project - $(py2) python manage.py migrate - $(py2) python manage.py runserver - -The last command will start the dev server on http://localhost:8000. |