Personal/realms-wiki
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Add information about Whoosh to README

Browse source
This commit is contained in:
Fabian Schlager 2014-11-21 17:24:49 +01:00
parent a8f61dfb13
commit b38b4238f3
1 changed files with 21 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
README.md
View file

@ -214,8 +214,8 @@ _Don't forget to create your database._
## Search
Realms wiki comes with basic search capabilities but it is not recommended
for large wikis or if you require more advanced search capabilities. The only
backend we currently support is ElasticSearch
for large wikis or if you require more advanced search capabilities. The
backends we currently support are ElasticSearch and Whoosh.
### Elasticsearch Setup
@ -239,6 +239,25 @@ In your Realms Config, have the following options set:
"SEARCH_TYPE": "elasticsearch"
"ELASTICSEARCH_URL": "http://127.0.0.1:9200"
### Whoosh Setup
Simply install Whoosh to your Python environment, e.g.
pip install Whoosh
**Configuring Whoosh**
To use Whoosh, set the following in your Realms config:
"SEARCH_TYPE": "whoosh"
"WHOOSH_INDEX": "/path/to/your/whoosh/index"
"WHOOSH_LANGUAGE": "en"
WHOOSH_INDEX has to be a path read- and writeable by Realm's user. It will be created automatically if it doesn't exist.
Whoosh is set up to use language optimization, so set WHOOSH_LANGUAGE to the language used in your wiki. For available languages, check whoosh.lang.languages.
If your language is not supported, Realms will fall back to a simple text analyzer.
## Running
realms-wiki start