From 4573cd4e74103c83c2e136474bb966dcb6b8e036 Mon Sep 17 00:00:00 2001 From: Holger Frey Date: Thu, 3 Aug 2017 16:58:49 +0200 Subject: [PATCH] Updated readme --- README.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8efea5e..1dc1d74 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,21 @@ # moinmoin-scripts -helper scripts for our [MoinMoin](https://moinmo.in/) deployment \ No newline at end of file +Helper scripts for our [MoinMoin](https://moinmo.in/) deployment. + + +### install-xapian.sh + +The full text search indexing is provided by Xapian(https://xapian.org/). Since +our MoinMoin installation is done in a [virtual environment](https://docs.python.org/3/glossary.html#term-virtual-environment) +we can't use the system provided installer package. + +For an easy build and update process, the script `install-xapian.sh` can be +used, but the virtual environment must be [activated first](https://wiki.cpi.imtek.uni-freiburg.de/CPIvServerDocumentation/MoinMoinWikis#Full_Text_Indexing_with_Xapian). + + +### rebuild-search-index.py + +This scirpt rebuilds the full text search index. This might be needed if a +search setting in one of the configuration files was changed. Since MoinMoin +rebuilds the search index by each wiki, this scripts helps to automate the +process for all wikis in one go.