peertube-search-index_ynh/README_fr.md

<!--
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.
-->

# PeerTube search-index pour YunoHost

[![Niveau d’intégration](https://dash.yunohost.org/integration/peertube-search-index.svg)](https://dash.yunohost.org/appci/app/peertube-search-index) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/peertube-search-index.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/peertube-search-index.maintain.svg)

[![Installer PeerTube search-index avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=peertube-search-index)

*[Read this readme in english.](./README.md)*

> *Ce package vous permet d’installer PeerTube search-index rapidement et simplement sur un serveur YunoHost.
Si vous n’avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l’installer et en profiter.*

## Vue d’ensemble

A search engine for [PeerTube](https://joinpeertube.org/) videos and channels, developed by Framasoft.


**Version incluse :** 0.0.1.2023.08.08~ynh1

**Démo :** https://search.joinpeertube.org/

## Captures d’écran

![Capture d’écran de PeerTube search-index](./doc/screenshots/sepia-search-screenshot.png)

## Avertissements / informations importantes

## Important points to read before installing

1. **PeerTube search-index** requires a dedicated **root domain**, e.g. search.domain.tld

## Configuration

To configure this app: modify the file `/var/www/peertube-search-index/config/production.yaml` with SSH.

## :red_circle: Fonctions indésirables

- **Not totally free upstream**: The packaged app is under an overall free licence, but with clauses that restrict its use.

## Documentations et ressources

* Site officiel de l’app : <https://search.joinpeertube.org/>
* Documentation officielle de l’admin : <https://framagit.org/framasoft/peertube/search-index>
* Dépôt de code officiel de l’app : <https://framagit.org/framasoft/peertube/search-index>
* YunoHost Store: <https://apps.yunohost.org/app/peertube-search-index>
* Signaler un bug : <https://github.com/YunoHost-Apps/peertube-search-index_ynh/issues>

## Informations pour les développeurs

Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/peertube-search-index_ynh/tree/testing).

Pour essayer la branche testing, procédez comme suit.

``` bash
sudo yunohost app install https://github.com/YunoHost-Apps/peertube-search-index_ynh/tree/testing --debug
ou
sudo yunohost app upgrade peertube-search-index -u https://github.com/YunoHost-Apps/peertube-search-index_ynh/tree/testing --debug
```

**Plus d’infos sur le packaging d’applications :** <https://yunohost.org/packaging_apps>