From 276b6ec8e34695bb7ddb0a2bf5ea6470b355b499 Mon Sep 17 00:00:00 2001 From: Aamir Khan Date: Fri, 10 Aug 2012 21:11:33 +0530 Subject: Add HTML documentation --- hyperkitty/doc/_build/html/install.html | 171 ++++++++++++++++++++++++++++++++ 1 file changed, 171 insertions(+) create mode 100644 hyperkitty/doc/_build/html/install.html (limited to 'hyperkitty/doc/_build/html/install.html') diff --git a/hyperkitty/doc/_build/html/install.html b/hyperkitty/doc/_build/html/install.html new file mode 100644 index 0000000..3e9f0ec --- /dev/null +++ b/hyperkitty/doc/_build/html/install.html @@ -0,0 +1,171 @@ + + + + + + + + + Installation — HyperKitty v0.1 documentation + + + + + + + + + +
+

Navigation

+ +
+ +
+
+
+
+ +
+

Installation

+
+

Note

+

This installation guide covers HyperKitty, the web user interfaceaccess GNU Mailman v3 +Archives. To install GNU Mailman follow the instructions in the documentation: +http://packages.python.org/mailman/

+
+
+

Install Dependencies

+

sudo pip install -r requirements.txt

+
+
+

Install HyperKitty

+

sudo python manage.py install

+
+
+

Setup your django project

+

Since you have now installed the necessary packages to run HyperKitty, it’s +time to setup your Django site.

+

First, get the project directory from launchpad:

+
$ bzr branch bzr://bzr.fedorahosted.org/bzr/hyperkitty/hk-app
+
+

Second, change the database setting in postorius_standalone/settings.py to +your preferred database. HyperKitty uses two databases, one to store the metadata +and other to store mails. Edit this file to reflect the correct database credential.

+
+

Note

+

Detailed information on how to use different database engines can be found +in the Django documentation.

+
+

Third, prepare the database:

+
$ cd hk-app
+$ python manage.py syncdb
+$ cd ..
+
+

This will create the .db file (if you are using SQLite) and will setup all the +necessary db tables. You will also be prompted to create a superuser which +will act as an admin account for HyperKitty

+
+
+

Running the development server

+

The quickest way to run HyperKitty is to just start the development server:

+
$ cd hk-app
+$ python manage.py runserver
+
+
+

Warning

+

You should use the development server only locally. While it’s possible to +make your site publicly available using the dev server, you should never +do that in a production environment.

+
+
+
+

Running HyperKitty on Apache with mod_wsgi

+
+

Note

+

This guide assumes that you know how to setup a VirtualHost with Apache. +If you are using SQLite, the .db file as well as its folder need to be +writable by the web server.

+
+

Edit apache/apache_django_wsgi.conf to point to your source code location.

+

Add following line to your apache/httpd configuration file

+

:: +Include “/{path-to-hk-app}/apache/apache_django_wsgi.conf”

+

We’re almost ready. But you need to collect the static files from HyperKitty +(which resides somewhere on your pythonpath) to be able to serve them from the +site directory. All you have to do is to change into the +hk-app directory and run:

+
$ python manage.py collectstatic
+
+
+
+ + +
+
+
+
+
+

Table Of Contents

+ + +

This Page

+ + + +
+
+
+
+
+

Navigation

+ +
+
+ © Copyright 2012, Mailman Coders. + Created using Sphinx 1.0.7. +
+ + \ No newline at end of file -- cgit