elasticsearch7_ynh/README.md

57 lines
2.6 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.
-->
2022-11-28 18:09:14 +01:00
# OpenSearch for YunoHost
2022-11-26 19:48:19 +01:00
2022-11-28 18:09:14 +01:00
[![Integration level](https://dash.yunohost.org/integration/opensearch.svg)](https://dash.yunohost.org/appci/app/opensearch) ![Working status](https://ci-apps.yunohost.org/ci/badges/opensearch.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/opensearch.maintain.svg)
[![Install OpenSearch with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=opensearch)
2022-11-26 19:48:19 +01:00
*[Lire ce readme en français.](./README_fr.md)*
2022-11-28 18:09:14 +01:00
> *This package allows you to install OpenSearch 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-04 16:07:39 +01:00
OpenSearch makes it easy to ingest, search, visualize, and analyze your data.
2022-11-26 19:48:19 +01:00
### Features
2023-01-04 16:07:39 +01:00
OpenSearch is a scalable, flexible, and extensible open-source software suite for search, analytics, and observability applications licensed under Apache 2.0. Powered by Apache Lucene and driven by the OpenSearch Project community, OpenSearch offers a vendor-agnostic toolset you can use to build secure, high-performance, cost-efficient applications. Use OpenSearch as an end-to-end solution or connect it with your preferred open-source tools or partner projects.
2022-11-26 19:48:19 +01:00
2023-01-04 16:07:39 +01:00
**Shipped version:** 2.4.1~ynh1
2022-11-26 19:48:19 +01:00
2022-11-28 18:09:14 +01:00
**Demo:** https://playground.opensearch.org/app/home
2022-11-26 19:48:19 +01:00
## Disclaimers / important information
2023-01-04 16:07:39 +01:00
### Limitations
- 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
2022-11-28 18:09:14 +01:00
* Official app website: <https://opensearch.org>
* Official admin documentation: <https://opensearch.org/docs/latest/>
* Upstream app code repository: <https://github.com/opensearch-project/OpenSearch>
* YunoHost documentation for this app: <https://yunohost.org/app_opensearch>
* Report a bug: <https://github.com/YunoHost-Apps/opensearch_ynh/issues>
2022-11-26 19:48:19 +01:00
## Developer info
2022-11-28 18:09:14 +01:00
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/opensearch_ynh/tree/testing).
2022-11-26 19:48:19 +01:00
To try the testing branch, please proceed like that.
``` bash
2022-11-28 18:09:14 +01:00
sudo yunohost app install https://github.com/YunoHost-Apps/opensearch_ynh/tree/testing --debug
2022-11-26 19:48:19 +01:00
or
2022-11-28 18:09:14 +01:00
sudo yunohost app upgrade opensearch -u https://github.com/YunoHost-Apps/opensearch_ynh/tree/testing --debug
2022-11-26 19:48:19 +01:00
```
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>