DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:elasticsearch

This is an old revision of the document!


elasticsearch Plugin

Compatible with DokuWiki

  • 2018-04-22 "Greebo" yes
  • 2017-02-19 "Frusterick Manners" unknown
  • 2016-06-26 "Elenor Of Tsort" unknown
  • 2015-08-10 "Detritus" unknown

plugin Integrate Elasticsearch engine

Last updated on
2019-07-31
Provides
Action
Repository
Source

Tagged with search

Installation

A CosmoCode Plugin

:!: External requirements: This plugin requires the following additional components that must be installed separately:

Install the plugin using the Plugin Manager and the download URL above, which points to latest version of the plugin. Refer to Plugins on how to install plugins manually.

Configure and setup the plugin as outlined under Configuration below.

Examples/Usage

Once installed, the plugin will automatically react on the ?do=search action, replacing DokuWiki's builtin search.

All access rights are respected, so users will only find pages for which they have at least read privileges.

You can use the Advanced Search Tools to filter the results by namespace and date of the last modification.

Configuration and Settings

To integrate this plugin, you will need to dp some configuration and run a few commands on the command line.

  1. enter the configuration of your Elasticsearch server in the Configuration Settings
  2. create the Index
  3. create the Language Mappings
  4. index your pages

Creating the Index

You can use the tools provided by ElasticSearch to create the index or simply run the provided command line tool to do so:

./bin/plugin.php elasticsearch createindex

The name of the index is determined by the configuration.

One of the main reasons for using a dedicated search engine is that it provides advanced features, such as fuzzy search. To enable it, the pages must be indexed using a linguistic analyzer in the appropriate language. Make sure to create the language mapping using the CLI tool before filling the index.

./bin/plugin.php elasticsearch createlangmapping

If you have configured multiple languages using the Translation plugin, they will be mapped as well.

At present there is no special filter that would let the user search in a particular language only. However, it is possible to filter the results by language namespaces.

Index management

The pages will be indexed automatically when browsed, just like with the DokuWiki builtin mechanism. When a page is updated, its entry in the index will be updated as well.

You can also force indexing the whole Wiki at once using the CLI tool. This is recommended when you build the index for the first time or when you have made extensive changes (like moving pages or updating the ACLs).

./bin/plugin.php elasticsearch index

Development

Commit-Ticker

Releases:

ToDo/Wish List

  • search a specific language
  • exact match (non-fuzzy search)
  • integration of the tagging plugin; tagged pages are shown on the results page but this bypasses Elasticsearch
plugin/elasticsearch.1564609832.txt.gz · Last modified: 2019-07-31 23:50 by andi