summaryrefslogtreecommitdiff
path: root/src/mailman/docs/hyperkitty.rst
diff options
context:
space:
mode:
authorBarry Warsaw2017-05-22 22:48:01 +0000
committerBarry Warsaw2017-05-22 22:48:01 +0000
commitcabccce9f8a905e3a495486a0fd6d86d1acfff72 (patch)
treef8434851f4619431a44d4583c53deddb0d91a227 /src/mailman/docs/hyperkitty.rst
parent95fd3b9bd05b72038f2b20584edc6d9bb3fa3b19 (diff)
parent0a3e51fb2abae84c9d2ee42c171ccce5b3e67573 (diff)
downloadmailman-cabccce9f8a905e3a495486a0fd6d86d1acfff72.tar.gz
mailman-cabccce9f8a905e3a495486a0fd6d86d1acfff72.tar.zst
mailman-cabccce9f8a905e3a495486a0fd6d86d1acfff72.zip
Diffstat (limited to 'src/mailman/docs/hyperkitty.rst')
-rw-r--r--src/mailman/docs/hyperkitty.rst109
1 files changed, 7 insertions, 102 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
+