elasticsearch7_ynh/README.md

62 lines
2.7 KiB
Markdown
Raw Normal View History

2022-11-26 19:48:19 +01:00
<!--
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
It shall NOT be edited by hand.
-->
2023-01-06 11:41:47 +01:00
# ElasticSearch 7 for YunoHost
2022-11-26 19:48:19 +01:00
2023-01-06 11:41:47 +01:00
[![Integration level](https://dash.yunohost.org/integration/elasticsearch7.svg)](https://dash.yunohost.org/appci/app/elasticsearch7) ![Working status](https://ci-apps.yunohost.org/ci/badges/elasticsearch7.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/elasticsearch7.maintain.svg)
[![Install ElasticSearch 7 with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=elasticsearch7)
2022-11-26 19:48:19 +01:00
*[Lire ce readme en français.](./README_fr.md)*
2023-01-06 11:41:47 +01:00
> *This package allows you to install ElasticSearch 7 quickly and simply on a YunoHost server.
2022-11-26 19:48:19 +01:00
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
## Overview
2023-01-06 11:41:47 +01:00
Elasticsearch is the distributed, RESTful search and analytics engine at the heart of the [Elastic Stack](https://www.elastic.co/products). You can use Elasticsearch to store, search, and manage data for:
- Logs
- Metrics
- A search backend
- Application monitoring
- Endpoint security
2023-01-04 16:07:39 +01:00
2023-01-06 11:41:47 +01:00
... and more!
2022-11-26 19:48:19 +01:00
2023-01-06 11:41:47 +01:00
To learn more about Elasticsearchs features and capabilities, see the [product page](https://www.elastic.co/products/elasticsearch).
2022-11-26 19:48:19 +01:00
2023-01-06 11:41:47 +01:00
**Shipped version:** 7.17.8~ynh3
2022-11-26 19:48:19 +01:00
2023-01-06 11:41:47 +01:00
**Demo:** https://www.elastic.co/demos
2022-11-26 19:48:19 +01:00
## Disclaimers / important information
2023-01-04 16:07:39 +01:00
### Limitations
2023-01-06 11:41:47 +01:00
- **Not totally free**: Licensed under SSPL, see for more information: <https://en.wikipedia.org/wiki/Server_Side_Public_License>
2023-01-04 16:07:39 +01:00
- Currently the security is disabled
- Therefore, the package is configured to remain not public for now (i.e. not accessible through the web, the apps depending on it should be installed on the same server)
- Not scalable for now
2022-11-26 19:48:19 +01:00
## Documentation and resources
2023-01-06 11:41:47 +01:00
* Official app website: <https://elastic.co>
* Official admin documentation: <https://www.elastic.co/guide/en/elasticsearch/reference/7.17/elasticsearch-intro.html>
* Upstream app code repository: <https://github.com/elastic/elasticsearch>
* YunoHost documentation for this app: <https://yunohost.org/app_elasticsearch7>
* Report a bug: <https://github.com/YunoHost-Apps/elasticsearch7_ynh/issues>
2022-11-26 19:48:19 +01:00
## Developer info
2023-01-06 11:41:47 +01:00
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/elasticsearch7_ynh/tree/testing).
2022-11-26 19:48:19 +01:00
To try the testing branch, please proceed like that.
``` bash
2023-01-06 11:41:47 +01:00
sudo yunohost app install https://github.com/YunoHost-Apps/elasticsearch7_ynh/tree/testing --debug
2022-11-26 19:48:19 +01:00
or
2023-01-06 11:41:47 +01:00
sudo yunohost app upgrade elasticsearch7 -u https://github.com/YunoHost-Apps/elasticsearch7_ynh/tree/testing --debug
2022-11-26 19:48:19 +01:00
```
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>