1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/meilisearch_ynh.git synced 2024-09-03 19:45:59 +02:00
meilisearch_ynh/README.md

57 lines
2 KiB
Markdown
Raw Normal View History

2020-07-27 12:39:19 +02:00
# Meilisearch for YunoHost
2020-05-16 19:20:53 +02:00
2020-07-27 12:39:19 +02:00
[![Integration level](https://dash.yunohost.org/integration/meilisearch.svg)](https://dash.yunohost.org/appci/app/meilisearch) ![](https://ci-apps.yunohost.org/ci/badges/meilisearch.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/meilisearch.maintain.svg)
2020-12-20 09:18:13 +01:00
[![Install Meilisearch with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=meilisearch)
2020-05-16 19:20:53 +02:00
*[Lire ce readme en français.](./README_fr.md)*
> *This package allow you to install Meilisearch quickly and simply on a YunoHost server.
If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.*
## Overview
Meilisearch is an opensource next generation search API.
2021-04-23 23:34:30 +02:00
**Shipped version:** 0.20.0
2020-05-16 19:20:53 +02:00
## Screenshots
2020-10-05 20:58:38 +02:00
![](movies-web-demo.gif)
2020-05-16 19:20:53 +02:00
## Configuration
At the installation, be sure to set up an API key to secure your API.
2020-05-26 16:13:34 +02:00
## Problem and todo
2020-07-27 12:38:40 +02:00
2020-05-26 16:13:34 +02:00
- Doesn't install on subpath (WIP).
2020-05-16 19:20:53 +02:00
#### Multi-users support
It's an API and there is no authentification, without API key.
#### Supported architectures
2021-04-23 23:34:30 +02:00
* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/meilisearch.svg)](https://ci-apps.yunohost.org/ci/apps/meilisearch/)
* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/meilisearch.svg)](https://ci-apps-arm.yunohost.org/ci/apps/meilisearch/)
2020-05-16 19:20:53 +02:00
## Links
2020-07-27 12:38:40 +02:00
* Report a bug: https://github.com/YunoHost-Apps/meilisearch_ynh/issues
2020-05-16 19:20:53 +02:00
* App website: https://www.meilisearch.com/
* Upstream app repository: https://github.com/meilisearch/MeiliSearch
* YunoHost website: https://yunohost.org/
---
2020-10-05 19:31:42 +02:00
## Developers info
2020-05-16 19:20:53 +02:00
2020-07-27 12:38:40 +02:00
Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/meilisearch_ynh/tree/testing).
2020-05-16 19:20:53 +02:00
To try the testing branch, please proceed like that.
```
2020-07-27 12:38:40 +02:00
sudo yunohost app install https://github.com/YunoHost-Apps/meilisearch_ynh/tree/testing --debug
2020-05-16 19:20:53 +02:00
or
2020-07-27 12:38:40 +02:00
sudo yunohost app upgrade meilisearch -u https://github.com/YunoHost-Apps/meilisearch_ynh/tree/testing --debug
2020-05-16 19:20:53 +02:00
```