1
=====================================
2
Set up the archive ui in five minutes
3
=====================================
5
The `hyperkitty`_ application aims at providing an interface to visualize and
6
explore Mailman archives.
8
This is a `Django`_ project.
13
- A mail archive in `maildir format`_ (no, you don't need a running Mailman
14
3!) Eventually hyperkitty will support `mbox format`_ for backward
15
compatibility with *Pipermail*, and *zipped maildirs* seem like a good idea
16
to save space. **Beware:** Although you'd think that we would be able to
17
manipulate the venerable *mbox* format safely and efficiently, that doesn't
18
seem to be the case. *Maildir* archives are **strongly** preferred, because
19
they are more robust to program bugs (whether in Mailman, hyperkitty, or in
21
- Django is the web framework that supports the UI.
23
- The `notmuch mail indexer`_ is used to generate indexes (and requires
25
- hyperkitty itself, which is a UI, and not responsible for maintaining the
26
message archive itself. (Since the archive is in `maildir format`_, any
27
modern MTA or MDA can build one for you.)
30
Get it running (under virtualenv):
31
----------------------------------
33
It is generally a good idea to use `virtualenv`_ to create a stable
34
environment for your Python applications.
36
- Create the virtualenv::
40
- Activate the virtualenv::
45
You don't *have* to use virtualenv, though, and if you don't want to, just
46
omit the preceding steps. Continue with these steps.
48
- Install Django and dependencies::
53
- Install notmuch -- these are bindings that come with the notmuch C library.
54
The easiest way is probably to install them for your OS vendor and then
55
symlink them into the virtualenv similar to this::
57
% yum install -y python-notmuch
59
- Note: on a multiarch system like Fedora, the directories may be lib64 rather
60
than lib on 64 bit systems. Next::
62
% cd lib/python2.7/site-packages
63
% ln -s /usr/lib/python2.7/site-packages/notmuch .
65
- Note: this is the version of notmuch I tested with; others may work::
67
% ln -s /usr/lib/python2.7/site-packages/notmuch-0.11-py2.7.egg-info .
69
- Install the hyperkitty sources::
71
% git clone http://ambre.pingoured.fr/cgit/hyperkitty.git/
81
- Put the static content where it should be::
83
% python manage.py collectstatic
85
- Run the Django server::
87
% python manage.py runserver
90
.. _`hyperkitty`: https://launchpad.net/hyperkitty
91
.. _`Django`: http://djangoproject.org/
92
.. _`notmuch mail indexer`: http://notmuchmail.org
93
.. _`bunch`: http://pypi.python.org/pypi/bunch
94
.. _`Xapian`: http://xapian.org/
95
.. _`maildir format`: http://en.wikipedia.org/wiki/Maildir
96
.. _`mbox format`: http://en.wikipedia.org/wiki/Mbox
97
.. _`virtualenv`: http://pypi.python.org/pypi/virtualenv
added
removed
src/mailman/docs/ArchiveUIin5.rst
