diff options
Diffstat (limited to 'hyperkitty/doc/_build/html/install.html')
| -rw-r--r-- | hyperkitty/doc/_build/html/install.html | 171 |
1 files changed, 0 insertions, 171 deletions
diff --git a/hyperkitty/doc/_build/html/install.html b/hyperkitty/doc/_build/html/install.html deleted file mode 100644 index 3e9f0ec..0000000 --- a/hyperkitty/doc/_build/html/install.html +++ /dev/null @@ -1,171 +0,0 @@ - - -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> - -<html xmlns="http://www.w3.org/1999/xhtml"> - <head> - <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> - - <title>Installation — HyperKitty v0.1 documentation</title> - <link rel="stylesheet" href="_static/default.css" type="text/css" /> - <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> - <script type="text/javascript"> - var DOCUMENTATION_OPTIONS = { - URL_ROOT: '', - VERSION: '0.1', - COLLAPSE_INDEX: false, - FILE_SUFFIX: '.html', - HAS_SOURCE: true - }; - </script> - <script type="text/javascript" src="_static/jquery.js"></script> - <script type="text/javascript" src="_static/underscore.js"></script> - <script type="text/javascript" src="_static/doctools.js"></script> - <link rel="top" title="HyperKitty v0.1 documentation" href="index.html" /> - </head> - <body> - <div class="related"> - <h3>Navigation</h3> - <ul> - <li class="right" style="margin-right: 10px"> - <a href="genindex.html" title="General Index" - accesskey="I">index</a></li> - <li><a href="index.html">HyperKitty v0.1 documentation</a> »</li> - </ul> - </div> - - <div class="document"> - <div class="documentwrapper"> - <div class="bodywrapper"> - <div class="body"> - - <div class="section" id="installation"> -<h1>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h1> -<div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">This installation guide covers HyperKitty, the web user interfaceaccess GNU Mailman v3 -Archives. To install GNU Mailman follow the instructions in the documentation: -<a class="reference external" href="http://packages.python.org/mailman/">http://packages.python.org/mailman/</a></p> -</div> -<div class="section" id="install-dependencies"> -<h2>Install Dependencies<a class="headerlink" href="#install-dependencies" title="Permalink to this headline">¶</a></h2> -<p>sudo pip install -r requirements.txt</p> -</div> -<div class="section" id="install-hyperkitty"> -<h2>Install HyperKitty<a class="headerlink" href="#install-hyperkitty" title="Permalink to this headline">¶</a></h2> -<p>sudo python manage.py install</p> -</div> -<div class="section" id="setup-your-django-project"> -<h2>Setup your django project<a class="headerlink" href="#setup-your-django-project" title="Permalink to this headline">¶</a></h2> -<p>Since you have now installed the necessary packages to run HyperKitty, it’s -time to setup your Django site.</p> -<p>First, get the project directory from launchpad:</p> -<div class="highlight-python"><pre>$ bzr branch bzr://bzr.fedorahosted.org/bzr/hyperkitty/hk-app</pre> -</div> -<p>Second, change the database setting in <tt class="docutils literal"><span class="pre">postorius_standalone/settings.py</span></tt> 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.</p> -<div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">Detailed information on how to use different database engines can be found -in the <a class="reference external" href="https://docs.djangoproject.com/en/1.4/ref/settings/#databases">Django documentation</a>.</p> -</div> -<p>Third, prepare the database:</p> -<div class="highlight-python"><pre>$ cd hk-app -$ python manage.py syncdb -$ cd ..</pre> -</div> -<p>This will create the <tt class="docutils literal"><span class="pre">.db</span> <span class="pre">file</span></tt> (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</p> -</div> -<div class="section" id="running-the-development-server"> -<h2>Running the development server<a class="headerlink" href="#running-the-development-server" title="Permalink to this headline">¶</a></h2> -<p>The quickest way to run HyperKitty is to just start the development server:</p> -<div class="highlight-python"><pre>$ cd hk-app -$ python manage.py runserver</pre> -</div> -<div class="admonition warning"> -<p class="first admonition-title">Warning</p> -<p class="last">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.</p> -</div> -</div> -<div class="section" id="running-hyperkitty-on-apache-with-mod-wsgi"> -<h2>Running HyperKitty on Apache with mod_wsgi<a class="headerlink" href="#running-hyperkitty-on-apache-with-mod-wsgi" title="Permalink to this headline">¶</a></h2> -<div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">This guide assumes that you know how to setup a VirtualHost with Apache. -If you are using SQLite, the <tt class="docutils literal"><span class="pre">.db</span></tt> file as well as its folder need to be -writable by the web server.</p> -</div> -<p>Edit <tt class="docutils literal"><span class="pre">apache/apache_django_wsgi.conf</span></tt> to point to your source code location.</p> -<p>Add following line to your apache/httpd configuration file</p> -<p>:: -Include “/{path-to-hk-app}/apache/apache_django_wsgi.conf”</p> -<p>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 -<tt class="docutils literal"><span class="pre">hk-app</span></tt> directory and run:</p> -<div class="highlight-python"><pre>$ python manage.py collectstatic</pre> -</div> -</div> -</div> - - - </div> - </div> - </div> - <div class="sphinxsidebar"> - <div class="sphinxsidebarwrapper"> - <h3><a href="index.html">Table Of Contents</a></h3> - <ul> -<li><a class="reference internal" href="#">Installation</a><ul> -<li><a class="reference internal" href="#install-dependencies">Install Dependencies</a></li> -<li><a class="reference internal" href="#install-hyperkitty">Install HyperKitty</a></li> -<li><a class="reference internal" href="#setup-your-django-project">Setup your django project</a></li> -<li><a class="reference internal" href="#running-the-development-server">Running the development server</a></li> -<li><a class="reference internal" href="#running-hyperkitty-on-apache-with-mod-wsgi">Running HyperKitty on Apache with mod_wsgi</a></li> -</ul> -</li> -</ul> - - <h3>This Page</h3> - <ul class="this-page-menu"> - <li><a href="_sources/install.txt" - rel="nofollow">Show Source</a></li> - </ul> -<div id="searchbox" style="display: none"> - <h3>Quick search</h3> - <form class="search" action="search.html" method="get"> - <input type="text" name="q" size="18" /> - <input type="submit" value="Go" /> - <input type="hidden" name="check_keywords" value="yes" /> - <input type="hidden" name="area" value="default" /> - </form> - <p class="searchtip" style="font-size: 90%"> - Enter search terms or a module, class or function name. - </p> -</div> -<script type="text/javascript">$('#searchbox').show(0);</script> - </div> - </div> - <div class="clearer"></div> - </div> - <div class="related"> - <h3>Navigation</h3> - <ul> - <li class="right" style="margin-right: 10px"> - <a href="genindex.html" title="General Index" - >index</a></li> - <li><a href="index.html">HyperKitty v0.1 documentation</a> »</li> - </ul> - </div> - <div class="footer"> - © Copyright 2012, Mailman Coders. - Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7. - </div> - </body> -</html>
\ No newline at end of file |