mirror of
https://github.com/alexbelgium/hassio-addons.git
synced 2026-01-10 09:51:02 +01:00
101 lines
5.4 KiB
Markdown
101 lines
5.4 KiB
Markdown
# Home assistant add-on: elasticsearch server
|
||
|
||
|
||
I maintain this and other Home Assistant add-ons in my free time: keeping up with upstream changes, HA changes, and testing on real hardware takes a lot of time (and some money). I use around 5-10 of my >110 addons so regularly I install test machines (and purchase some test services such as vpn) that I don't use myself to troubleshoot and improve the addons
|
||
|
||
If this add-on saves you time or makes your setup easier, I would be very grateful for your support!
|
||
|
||
[![Buy me a coffee][donation-badge]](https://www.buymeacoffee.com/alexbelgium)
|
||
[![Donate via PayPal][paypal-badge]](https://www.paypal.com/donate/?hosted_button_id=DZFULJZTP3UQA)
|
||
|
||
## Addon informations
|
||
|
||
|
||
|
||
|
||
|
||
[](https://www.codacy.com/gh/alexbelgium/hassio-addons/dashboard?utm_source=github.com&utm_medium=referral&utm_content=alexbelgium/hassio-addons&utm_campaign=Badge_Grade)
|
||
[](https://github.com/alexbelgium/hassio-addons/actions/workflows/weekly-supelinter.yaml)
|
||
[](https://github.com/alexbelgium/hassio-addons/actions/workflows/onpush_builder.yaml)
|
||
|
||
[donation-badge]: https://img.shields.io/badge/Buy%20me%20a%20coffee-%23d32f2f?logo=buy-me-a-coffee&style=flat&logoColor=white
|
||
[paypal-badge]: https://img.shields.io/badge/Donate%20via%20PayPal-0070BA?logo=paypal&style=flat&logoColor=white
|
||
|
||
_Thanks to everyone having starred my repo! To star it click on the image below, then it will be on top right. Thanks!_
|
||
|
||
[](https://github.com/alexbelgium/hassio-addons/stargazers)
|
||
|
||
|
||
|
||
## About
|
||
|
||
---
|
||
|
||
[Elasticsearch](https://github.com/elastic/elasticsearch) is the distributed, RESTful search and analytics engine at the heart of the [Elastic Stack](https://www.elastic.co/fr/products/).
|
||
You can use Elasticsearch to store, search, and manage data for:
|
||
|
||
- Logs
|
||
- Metrics
|
||
- A search backend
|
||
- Application monitoring
|
||
- Endpoint security
|
||
- ... and more!
|
||
|
||
To learn more about Elasticsearch’s features and capabilities, see their [product page](https://www.elastic.co/fr/elasticsearch/) .
|
||
|
||
Here, this addon is used to single node that can be called from other addons needing it.
|
||
|
||
## Installation
|
||
|
||
---
|
||
|
||
The installation of this add-on is pretty straightforward and not different in comparison to installing any other add-on.
|
||
|
||
1. Add my add-ons repository to your home assistant instance (in supervisor addons store at top right, or click button below if you have configured my HA) [](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Falexbelgium%2Fhassio-addons)
|
||
2. Install this add-on.
|
||
3. Click the `Save` button to store your configuration.
|
||
4. Set the add-on options to your preferences
|
||
5. Start the add-on.
|
||
6. Check the logs of the add-on to see if everything went well.
|
||
|
||
## Configuration
|
||
|
||
Elasticsearch runs as a single-node cluster accessible at <http://homeassistant:9200>.
|
||
This addon has no web interface - it provides API endpoints for other applications.
|
||
|
||
### API Endpoints
|
||
|
||
- **HTTP API**: Port 9200 for REST API calls
|
||
- **Transport**: Port 9300 for internal cluster communication
|
||
|
||
### Options
|
||
|
||
No configuration options are available through the addon interface. Elasticsearch is pre-configured for single-node operation with:
|
||
- Memory allocation: 1GB heap (ES_JAVA_OPTS)
|
||
- Discovery type: single-node
|
||
- Memory lock: enabled
|
||
- Tini subreaper: enabled
|
||
|
||
### Example Usage
|
||
|
||
Connect other applications to Elasticsearch using:
|
||
- URL: `http://homeassistant:9200`
|
||
- No authentication required (local network only)
|
||
|
||
### Integration Examples
|
||
|
||
- **Nextcloud**: Configure Full Text Search app to use this Elasticsearch instance
|
||
- **Home Assistant**: Use with the Elasticsearch component for event publishing
|
||
|
||
### Environment variables
|
||
|
||
Use the add-on `env_vars` option to pass extra environment variables (uppercase or lowercase names). See https://github.com/alexbelgium/hassio-addons/wiki/Add-Environment-variables-to-your-Addon-2 for details.
|
||
|
||
## Integration with HA
|
||
|
||
Component : https://community.home-assistant.io/t/elasticsearch-component-publish-home-assistant-events-to-elasticsearch/66877
|
||
|
||
## Support
|
||
|
||
Create an issue on github
|