diff options
| author | Aurélien Bompard <aurelien@bompard.org> | 2013-09-30 11:42:01 +0200 |
|---|---|---|
| committer | Aurélien Bompard <aurelien@bompard.org> | 2013-09-30 11:42:01 +0200 |
| commit | 45813b176e39cc46159897693636990635d54b15 (patch) | |
| tree | 007e3c5d9944bdaadc39ecb6661684eba2b83660 /doc | |
| parent | 98449f23e5f4e323f3e1b6ca593fee90be472de5 (diff) | |
| download | hyperkitty-45813b176e39cc46159897693636990635d54b15.tar.gz hyperkitty-45813b176e39cc46159897693636990635d54b15.tar.xz hyperkitty-45813b176e39cc46159897693636990635d54b15.zip | |
Update documentation
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/database.rst | 13 | ||||
| -rw-r--r-- | doc/development.rst | 4 | ||||
| -rw-r--r-- | doc/install.rst | 6 |
3 files changed, 17 insertions, 6 deletions
diff --git a/doc/database.rst b/doc/database.rst index 1c822e6..6607138 100644 --- a/doc/database.rst +++ b/doc/database.rst @@ -26,6 +26,19 @@ The scheme may be "sqlite", "postgres", or "mysql". For example, with sqlite:: If you're using SQLite and you're getting "Database is locked" errors, stop your webserver during the import. +If you want to force the creation of the KittyStore database, you can run:: + + kittystore-updatedb -p hyperkitty_standalone -s settings + +and it will be created. + +KittyStore also uses a fulltext search engine which resides in a directory on +the filesystem. The path to this directory must be configured in the +``KITTYSTORE_SEARCH_INDEX`` variable. This directory should be writable by the +user running Mailman and readable by the user running HyperKitty. It will be +automatically created, but the creation can be forced using the +``kittystore-updatedb`` command described above. + Importing the current archives ============================== diff --git a/doc/development.rst b/doc/development.rst index 42de8eb..57a618d 100644 --- a/doc/development.rst +++ b/doc/development.rst @@ -48,8 +48,8 @@ content:: ASSETS_AUTO_BUILD = DEBUG USE_SSL = False -It's also recommanded to change the database access paths in the ``DATABASES`` -and ``KITTYSTORE_URL`` variables. +It's also recommanded to change the database access paths in the ``DATABASES``, +``KITTYSTORE_URL`` and ``KITTYSTORE_SEARCH_INDEX`` 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 diff --git a/doc/install.rst b/doc/install.rst index b335d18..83057cb 100644 --- a/doc/install.rst +++ b/doc/install.rst @@ -131,11 +131,9 @@ which serves HyperKitty (Apache HTTPd for example). There are two main databases in HyperKitty. The one from KittyStore and the one from HyperKitty itself. To update the KittyStore database, just run:: - kittystore-update -s KITTYSTORE_URL + kittystore-updatedb -p hyperkitty_standalone -s settings -where "``KITTYSTORE_URL``" is the content of the ``KITTYSTORE_URL`` variable in -``settings.py`` (or ``settings_local.py``). This command may take a long time -to complete, donc interrupt it. +This command may take a long time to complete, donc interrupt it. Then, to update the HyperKitty database, run:: |