Welcome to the Cortex Documentation! Here, you'll find everything you need to get started with Cortex, a modern admin interface for Elasticsearch, and leverage its powerful features to manage and monitor your Elasticsearch clusters effectively.
What is Cortex?
Cortex is a (currently) read-only admin interface for Elasticsearch. It is inspired by Cerebro, a popular Elasticsearch admin interface, and aims to provide a modern, user-friendly, and feature-rich alternative to Cerebro.
Features
Cortex offers a wide range of features to help you manage and monitor your Elasticsearch clusters effectively. Some of the key features include:
- Shard Relocation Information: Get detailed insights into shard relocation processes, helping you optimize and troubleshoot your cluster.
- Flowcharts: Visualize your Elasticsearch cluster's architecture and data flow with interactive flowcharts.
- Modern UI: Enjoy a sleek, responsive, and user-friendly interface built with React.
- Performance: Leveraging Rust for backend operations ensures high performance and reliability.
Getting Started
To get started with Cortex, be sure to check out the Getting Started (opens in a new tab) guide. It provides detailed instructions on how to install and configure Cortex on your machine.
Contributing
We welcome contributions to Cortex! Please follow these steps to contribute:
- Fork the repository
- Create a new branch (git checkout -b feature-branch)
- Make your changes
- Commit your changes (git commit -m 'Add some feature')
- Push to the branch (git push origin feature-branch)
- Open a Pull Request