diff options
author | Aurélien Bompard <aurelien@bompard.org> | 2013-04-22 17:00:36 +0200 |
---|---|---|
committer | Aurélien Bompard <aurelien@bompard.org> | 2013-04-22 17:00:36 +0200 |
commit | 550c28837ea236ea4c853519a23b97bd135fba3c (patch) | |
tree | ec2f07763b621241a548eaad64bbd2cd5f6b6f73 /doc | |
parent | 6dcf81e8d7e0f1c60a7d39bff241bc1e3436488b (diff) | |
download | hyperkitty-550c28837ea236ea4c853519a23b97bd135fba3c.tar.gz hyperkitty-550c28837ea236ea4c853519a23b97bd135fba3c.tar.xz hyperkitty-550c28837ea236ea4c853519a23b97bd135fba3c.zip |
Add some doc snippets
Diffstat (limited to 'doc')
-rw-r--r-- | doc/development.rst | 26 | ||||
-rw-r--r-- | doc/install.rst | 7 |
2 files changed, 33 insertions, 0 deletions
diff --git a/doc/development.rst b/doc/development.rst index 2e7acd5..42de8eb 100644 --- a/doc/development.rst +++ b/doc/development.rst @@ -35,6 +35,32 @@ Then download the components of HyperKitty:: git clone https://github.com/hyperkitty/hyperkitty_standalone.git +Configuration +============= + +For a development setup, you should create a +``hyperkitty_standalone/settings_local.py`` file with at least the following +content:: + + DEBUG = True + TEMPLATE_DEBUG = DEBUG + ASSETS_DEBUG = DEBUG + ASSETS_AUTO_BUILD = DEBUG + USE_SSL = False + +It's also recommanded to change the database access paths in the ``DATABASES`` +and ``KITTYSTORE_URL`` variables. + +If you ever want to turn the ``DEBUG`` variable to ``False`` (by removing it +from ``settings_local.py``), you'll have to run two additional commands at +first and each time you change the static files:: + + python hyperkitty_standalone/manage.py collectstatic + python hyperkitty_standalone/manage.py assets build --parse-templates + +But for development purposes, it's better to keep ``DEBUG = True``. + + .. Setting up the databases .. include:: database.rst diff --git a/doc/install.rst b/doc/install.rst index d020161..aadcf5d 100644 --- a/doc/install.rst +++ b/doc/install.rst @@ -94,6 +94,13 @@ key is an additional HyperKitty-specific configuration file for which an example is provided. See the included ``hyperkitty_standalone/hyperkitty.cfg`` file. +.. warning:: + The user that Mailman runs under (unually "mailman") must be able to read + both the ``settings.py`` and ``settings_local.py`` files. Remember that + those files also contain the database passwords, so make sure the + permissions are correct. We suggest adding the mailman user to the apache + group, and only giving this group read access to those files. + After having made these changes, you must restart Mailman. Check its log files to make sure the emails are correctly archived. You should not see "``Broken archiver: hyperkitty``" messages. |