Official documentation for Search Guard, the Elasticsearch security suite

This project is maintained by floragunncom

Search Guard Documentation

This is the official documentation for Search Guard 5 and Search Guard 2. If you find any errors, or want to contribute, feel free to fork this repository and issue pull requests.

Unless stated otherwise, all instructions apply for Search Guard 5 and Search Guard 2. If there are differences between the versions, this will be made clear in the documentation.

Search Guard is a trademark of floragunn GmbH, registered in the U.S. and in other countries

Elasticsearch, Kibana, Logstash, and Beats are trademarks of Elasticsearch BV, registered in the U.S. and in other countries.

floragunn GmbH is not affiliated with Elasticsearch BV.

Copyright 2016-2017 floragunn GmbH

Table of contents



Configuring TLS

Configuring Users, Roles and Permissions

Configuring Authentication and Authorisation modules

Document- and Field-Level-Security

Audit Logging

REST Management API

Search Guard index management

Running Search Guard behind a Proxy

Integrating with the Elastic Stack

Integrating with X-Pack

Integrating with X-Pack Alternatives


Search Guard End Of Life policy