YunoHost-Apps/kiwix_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/kiwix_ynh.git synced 2024-09-03 19:35:56 +02:00
Code Issues Activity Actions

Auto-update README

Browse source
This commit is contained in:
yunohost-bot 2022-06-29 08:05:14 +00:00
parent 163525601d
commit 7303c70c70
2 changed files with 55 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

34
README.md
View file

@ -5,7 +5,7 @@ It shall NOT be edited by hand.
# Kiwix for YunoHost # Kiwix for YunoHost
[![Integration level](https://dash.yunohost.org/integration/kiwix.svg)](https://dash.yunohost.org/appci/app/kiwix) ![](https://ci-apps.yunohost.org/ci/badges/kiwix.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/kiwix.maintain.svg) [![Integration level](https://dash.yunohost.org/integration/kiwix.svg)](https://dash.yunohost.org/appci/app/kiwix) ![Working status](https://ci-apps.yunohost.org/ci/badges/kiwix.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/kiwix.maintain.svg)
[![Install Kiwix with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=kiwix) [![Install Kiwix with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=kiwix)
*[Lire ce readme en français.](./README_fr.md)* *[Lire ce readme en français.](./README_fr.md)*
@ -36,25 +36,41 @@ Kiwix is an offline reader for online content like Wikipedia, Project Gutenberg,
## Screenshots ## Screenshots
![](./doc/screenshots/screenshot.png) ![Screenshot of Kiwix](./doc/screenshots/screenshot.png)
## Disclaimers / important information
### How to add zim files?
- Download one or more ZIM files, e.g. from [https://download.kiwix.org/zim/](https://download.kiwix.org/zim/)
- Put the ZIM files into `/home/yunohost.app/kiwix/`
- Add them to the library with the following command:
```
/var/www/kiwix/kiwix-manage /home/yunohost.app/kiwix/library.xml add /home/yunohost.app/kiwix/*.zim
```
- Restart the service:
`yunohost service restart kiwix`
## Documentation and resources ## Documentation and resources
* Official app website: https://www.kiwix.org/ * Official app website: <https://www.kiwix.org/>
* Official admin documentation: https://wiki.kiwix.org/wiki/Kiwix-serve/ * Official admin documentation: <https://wiki.kiwix.org/wiki/Kiwix-serve/>
* Upstream app code repository: https://github.com/kiwix/kiwix-tools * Upstream app code repository: <https://github.com/kiwix/kiwix-tools>
* YunoHost documentation for this app: https://yunohost.org/app_kiwix * YunoHost documentation for this app: <https://yunohost.org/app_kiwix>
* Report a bug: https://github.com/YunoHost-Apps/kiwix_ynh/issues * Report a bug: <https://github.com/YunoHost-Apps/kiwix_ynh/issues>
## Developer info ## Developer info
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/kiwix_ynh/tree/testing). Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/kiwix_ynh/tree/testing).
To try the testing branch, please proceed like that. To try the testing branch, please proceed like that.
```
``` bash
sudo yunohost app install https://github.com/YunoHost-Apps/kiwix_ynh/tree/testing --debug sudo yunohost app install https://github.com/YunoHost-Apps/kiwix_ynh/tree/testing --debug
or or
sudo yunohost app upgrade kiwix -u https://github.com/YunoHost-Apps/kiwix_ynh/tree/testing --debug sudo yunohost app upgrade kiwix -u https://github.com/YunoHost-Apps/kiwix_ynh/tree/testing --debug
``` ```
**More info regarding app packaging:** https://yunohost.org/packaging_apps **More info regarding app packaging:** <https://yunohost.org/packaging_apps>

40
README_fr.md
View file

@ -1,10 +1,14 @@
<!--
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.
-->
# Kiwix pour YunoHost # Kiwix pour YunoHost
[![Niveau d'intégration](https://dash.yunohost.org/integration/kiwix.svg)](https://dash.yunohost.org/appci/app/kiwix) ![](https://ci-apps.yunohost.org/ci/badges/kiwix.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/kiwix.maintain.svg) [![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)
[![Installer Kiwix avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=kiwix) [![Installer Kiwix avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=kiwix)
*[Read this readme in english.](./README.md)* *[Read this readme in english.](./README.md)*
*[Lire ce readme en français.](./README_fr.md)*
> *Ce package vous permet d'installer Kiwix rapidement et simplement sur un serveur YunoHost. > *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.* Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.*
@ -29,25 +33,41 @@ Kiwix est un lecteur hors-ligne pour contenus web qui permet en particulier d’
## Captures d'écran ## Captures d'écran
![](./doc/screenshots/screenshot.png) ![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`
## Documentations et ressources ## Documentations et ressources
* Site officiel de l'app : https://www.kiwix.org/ * Site officiel de l'app : <https://www.kiwix.org/>
* Documentation officielle de l'admin : https://wiki.kiwix.org/wiki/Kiwix-serve/ * 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 * 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 * Documentation YunoHost pour cette app : <https://yunohost.org/app_kiwix>
* Signaler un bug : https://github.com/YunoHost-Apps/kiwix_ynh/issues * Signaler un bug : <https://github.com/YunoHost-Apps/kiwix_ynh/issues>
## Informations pour les développeurs ## Informations pour les développeurs
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/kiwix_ynh/tree/testing). Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/kiwix_ynh/tree/testing).
Pour essayer la branche testing, procédez comme suit. Pour essayer la branche testing, procédez comme suit.
```
``` bash
sudo yunohost app install https://github.com/YunoHost-Apps/kiwix_ynh/tree/testing --debug sudo yunohost app install https://github.com/YunoHost-Apps/kiwix_ynh/tree/testing --debug
ou ou
sudo yunohost app upgrade kiwix -u https://github.com/YunoHost-Apps/kiwix_ynh/tree/testing --debug sudo yunohost app upgrade kiwix -u https://github.com/YunoHost-Apps/kiwix_ynh/tree/testing --debug
``` ```
**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps **Plus d'infos sur le packaging d'applications :** <https://yunohost.org/packaging_apps>