diff options
author | Aurélien Bompard <aurelien@bompard.org> | 2013-04-24 15:31:05 +0200 |
---|---|---|
committer | Aurélien Bompard <aurelien@bompard.org> | 2013-04-24 15:31:05 +0200 |
commit | 16497ae38af476515e1d28b6047affa0c5639743 (patch) | |
tree | 7e331cd69a19616e4318cc928b21b197c61e70db /doc | |
parent | fbbf1285969298c4f48bbdafe92aa87edd92b8d2 (diff) | |
download | hyperkitty-16497ae38af476515e1d28b6047affa0c5639743.tar.gz hyperkitty-16497ae38af476515e1d28b6047affa0c5639743.tar.xz hyperkitty-16497ae38af476515e1d28b6047affa0c5639743.zip |
Improve doc about the databases
Diffstat (limited to 'doc')
-rw-r--r-- | doc/database.rst | 13 |
1 files changed, 12 insertions, 1 deletions
diff --git a/doc/database.rst b/doc/database.rst index 433335c..6ef8cba 100644 --- a/doc/database.rst +++ b/doc/database.rst @@ -1,6 +1,10 @@ Setting up the databases ======================== +There are two databases in HyperKitty: one for the Django app, configured in +the regular ``DATABASES`` variable, and one for the KittyStore backend, +configured in the ``KITTYSTORE_URL`` variable. + Now you can create the KittyStore and HyperKitty databases, and set their access URLs in ``hyperkitty_standalone/settings.py`` (or ``hyperkitty_standalone/settings_local.py``). HyperKitty's database can be @@ -9,7 +13,14 @@ created using the following command:: python hyperkitty_standalone/manage.py syncdb python hyperkitty_standalone/manage.py migrate hyperkitty -KittyStore's database will be created automatically on first access. +KittyStore's database will be created automatically on first access, but you +still need to configure its URI. The syntax is as follows:: + + KITTYSTORE_URL = "scheme://username:password@hostname:port/database_name" + +The scheme may be "sqlite", "postgres", or "mysql". For example, with sqlite:: + + KITTYSTORE_URL = "sqlite:////path/to/hyperkitty/directory/kittystore.db' Then, you can run ``kittystore-import`` to import existing archives into the mailman database. Thoses archives can be downloaded by calling |