2022-06-29 10:05:14 +02: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-01-18 11:02:48 +01:00
# Kiwix pour YunoHost
2022-01-18 11:02:42 +01:00
2022-06-29 10:05:14 +02:00
[![Niveau d'intégration ](https://dash.yunohost.org/integration/kiwix.svg )](https://dash.yunohost.org/appci/app/kiwix) ![Statut du fonctionnement ](https://ci-apps.yunohost.org/ci/badges/kiwix.status.svg ) ![Statut de maintenance ](https://ci-apps.yunohost.org/ci/badges/kiwix.maintain.svg )
2022-01-18 11:02:48 +01:00
[![Installer Kiwix avec YunoHost ](https://install-app.yunohost.org/install-with-yunohost.svg )](https://install-app.yunohost.org/?app=kiwix)
2022-01-18 11:02:42 +01:00
*[Read this readme in english.](./README.md)*
2022-01-18 11:02:48 +01:00
> *Ce package vous permet d'installer Kiwix 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.*
2022-01-18 11:02:42 +01:00
## Vue d'ensemble
2022-01-18 11:02:48 +01:00
Kiwix est un lecteur hors-ligne pour contenus web qui permet en particulier d’ accéder à Wikipédia sans connexion à Internet.
2022-01-18 11:02:42 +01:00
2022-01-18 11:02:48 +01:00
### Fonctionnalités
- Un moteur de recherche de tout texte
- Suggestions de recherche
- Réellement petit et efficace
- Compatible avec la majorité des navigateurs internet
- Disponible avec toutes les plateformes
- Disponible par ligne de commande exécutables
- Embedded in Kiwix UI
- Capable de traiter un fichier ZIM ou des fichiers de bibliothèque XML
2022-01-18 11:02:42 +01:00
2022-06-30 19:25:28 +02:00
**Version incluse :** 3.1.2~ynh2
2022-01-18 11:02:42 +01:00
2022-01-18 11:02:48 +01:00
**Démo :** http://library.kiwix.org/
2022-01-18 11:02:42 +01:00
## Captures d'écran
2022-06-29 10:05:14 +02:00
![Capture d'écran de Kiwix ](./doc/screenshots/screenshot.png )
## Avertissements / informations importantes
### Comment ajouter des fichiers ZIM ?
- Téléchargez un ou plusieurs fichiers ZIM, par ex. [https://download.kiwix.org/zim/ ](https://download.kiwix.org/zim/ )
- Mettez les fichiers ZIM dans `/home/yunohost.app/kiwix/`
- Ajoutez-les à la bibliothèque avec la commande suivante :
```
/var/www/kiwix/kiwix-manage /home/yunohost.app/kiwix/library.xml add /home/yunohost.app/kiwix/*.zim
```
- Redémarrez le service :
`yunohost service restart kiwix`
2022-01-18 11:02:42 +01:00
## Documentations et ressources
2022-06-29 10:05:14 +02:00
* Site officiel de l'app : < https: // www . kiwix . org />
* Documentation officielle de l'admin : < https: // wiki . kiwix . org / wiki / Kiwix-serve />
* Dépôt de code officiel de l'app : < https: // github . com / kiwix / kiwix-tools >
* Documentation YunoHost pour cette app : < https: // yunohost . org / app_kiwix >
* Signaler un bug : < https: // github . com / YunoHost-Apps / kiwix_ynh / issues >
2022-01-18 11:02:42 +01:00
## Informations pour les développeurs
2022-01-18 11:02:48 +01:00
Merci de faire vos pull request sur la [branche testing ](https://github.com/YunoHost-Apps/kiwix_ynh/tree/testing ).
2022-01-18 11:02:42 +01:00
Pour essayer la branche testing, procédez comme suit.
2022-06-29 10:05:14 +02:00
``` bash
2022-01-18 11:02:48 +01:00
sudo yunohost app install https://github.com/YunoHost-Apps/kiwix_ynh/tree/testing --debug
ou
sudo yunohost app upgrade kiwix -u https://github.com/YunoHost-Apps/kiwix_ynh/tree/testing --debug
2022-01-18 11:02:42 +01:00
```
2022-06-29 10:05:14 +02:00
**Plus d'infos sur le packaging d'applications :** < https: / / yunohost . org / packaging_apps >