It's better when it's simple

User Tools

Site Tools


elasticsearch Plugin

Compatible with DokuWiki

  • 2024-02-06 "Kaos" yes
  • 2023-04-04 "Jack Jackrum" yes
  • 2022-07-31 "Igor" yes
  • 2020-07-29 "Hogfather" yes

plugin Integrate an external Elasticsearch engine into DokuWiki

Last updated on
CLI, Action

Similar to docsearch, searchtext

Tagged with search


A CosmoCode Plugin

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

Download and install the plugin using the Extension Manager. Refer to Plugins on how to install plugins manually.

Configure and setup the plugin as outlined under Configuration below.


Once installed, the plugin will automatically react on the ?do=search action, replacing DokuWiki's builtin search. However, the typical DokuWiki query shortcuts (like @namespace) do not work in ElasticSearch.

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. With tagging plugin installed, the search tools will include a dropdown with tags available for the current result set. So if none of the current results are tagged, the filter will not be displayed.

If the text plugin is installed, the rendered content of pages will be indexed in addition to raw wiki syntax. By default, search uses both fields. If you want to disable search in syntax, change the searchSyntax setting in the plugin's configuration.

Configuration and Settings

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

  1. enter the configuration of your Elasticsearch server in the Configuration Settings
  2. optional: if your ES instance has security enabled (default setting since 8.0), enter the authentication username and password in Configuration Settings
  3. copy and adjust a sample configuration for media indexing
  4. create the Index
  5. index your pages

Creating the Index

Indexing media

Copy the elasticsearch.conf.example included in this plugin's conf directory into /conf/elasticsearch.conf. The defaults should be fine for typical Linux servers. They include some popular file extensions and point to tools for extracting text from them, either as UNIX commands or a URL of a public Apache Tika server.

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.

Re-creating the index

Sometimes it is necessary to throw away the old index and replace it with a new one. This can be done via the same DokuWiki script with an additional parameter:

./bin/plugin.php elasticsearch createindex --clear

:!: Make sure to re-create your index after upgrading the plugin to 2022-11-02. This will update index structure and index your media.

One of the main reasons for using a dedicated search engine is that it provides advanced features, such as fuzzy search.

If you have configured multiple languages using the Translation plugin, they will be recognized.

By default all available translation are searched. Users can change the language selection in Advanced Search Tools.

You can also enable translation detection in the plugin configuration. The option is called detectTranslation. When activated, the search will try to detect the current language context from the top namespace, and then set the language filter accordingly. For example, if the translation plugin is configured to handle the en es fr namespaces and the user starts the search when browsing the page es:capítulos:tres, the language filter will be automatically set to es.

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

You can index pages or media separately:

./bin/plugin.php elasticsearch index --only=pages
./bin/plugin.php elasticsearch index --only=media

Other plugins

The tagging plugin integrates well with Elasticsearch. You can search for tags explicitly using #sometag search terms. If any of the results are tagged, a tag filter will be added to Advanced Search Tools.


Plugin integration

Elasticsearch emits several events that can be used by other plugins to put their own data into the search index. Take a look at the implementation tagging to see how those events can be used.

  • PLUGIN_ELASTICSEARCH_CREATEMAPPING: Triggered when creating the index. Plugins may add their own fields and mappings via event data.
  • PLUGIN_ELASTICSEARCH_INDEXPAGE: While indexing a page, plugins can provide their own data.
  • PLUGIN_ELASTICSEARCH_FILTERS: Adds search configurations provided by plugins.
  • PLUGIN_ELASTICSEARCH_SEARCHFIELDS: Lets plugins add their own fields to the list of search fields included in the Elastic query.
  • PLUGIN_ELASTICSEARCH_QUERY: Lets plugins append their data to the query string.



ToDo/Wish List

  • search a specific language
  • exact match (non-fuzzy search)
plugin/elasticsearch.txt · Last modified: 2024-02-15 12:01 by Aleksandr

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki