From db787452c23863602f21c030eb297f85839c9688 Mon Sep 17 00:00:00 2001 From: Yunohost-Bot <> Date: Tue, 10 Aug 2021 07:47:35 +0000 Subject: [PATCH] Auto-update README --- README.md | 68 +++++++++++++++++++++------------------------------- README_fr.md | 63 +++++++++++++++++------------------------------- 2 files changed, 49 insertions(+), 82 deletions(-) diff --git a/README.md b/README.md index bb33777..4eedd45 100644 --- a/README.md +++ b/README.md @@ -1,72 +1,58 @@ + + # Pi-hole for YunoHost [![Integration level](https://dash.yunohost.org/integration/pihole.svg)](https://dash.yunohost.org/appci/app/pihole) ![](https://ci-apps.yunohost.org/ci/badges/pihole.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/pihole.maintain.svg) -[![Install Pi-hole with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=pihole) +[![Install Pi-hole with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=pihole) *[Lire ce readme en français.](./README_fr.md)* -> *This package allow you to install Pi-hole quickly and easily on a YunoHost server. -If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to learn how to install and enjoy it.* +> *This package allows you to install Pi-hole quickly and simply on a YunoHost server. +If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.* ## Overview -Network-wide ad blocking via your own Linux hardware -**Shipped version:** 3.3.1 or 5.3.1 +Network-wide ad blocking via your own DNS server. + +**Shipped version:** 5.3.1~ynh1 + + ## Screenshots -![](https://i0.wp.com/pi-hole.net/wp-content/uploads/2016/12/dashboard212.png) +![](./doc/screenshots/dashboard.png) -## Demo - -No demo available. +## Disclaimers / important information ## Configuration Use the admin panel of your Pi-hole to configure this app. You may also need to follow the [post-install guide](https://docs.pi-hole.net/main/post-install/) to setup Pi-hole either as a *DNS server* or a *DHCP server*. -## Documentation - -* Official documentation: https://docs.pi-hole.net/ -* Pi-hole as a DHCP server: [dhcp.md](./dhcp.md) -* YunoHost documentation: There is no other documentation. Feel free to contribute! - -## YunoHost specific features - -* Private access to the admin panel. - -#### Multi-users support - -#### Supported architectures - -* x86-64b - [![](https://ci-apps.yunohost.org/ci/logs/pihole%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/pihole/) -* ARMv8-A - [![](https://ci-apps-arm.yunohost.org/ci/logs/pihole%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/pihole/) -* Buster x86-64b - [![](https://ci-buster.nohost.me/ci/logs/pihole%20%28Apps%29.svg)](https://ci-buster.nohost.me/ci/apps/pihole/) - ## Limitations * Activate DHCP with Pi-hole needs manual configuration of your router. * Pi-Hole can't be updated beyond version 3.3.1, because higher versions use an integrated version of dnsmasq. This would require disabling the version of dnsmasq used by YunoHost. -## Additionnal informations +## Documentation and resources -## Links +* Official app website: https://pi-hole.net/ +* Official admin documentation: https://docs.pi-hole.net +* Upstream app code repository: https://github.com/pi-hole/pi-hole/ +* YunoHost documentation for this app: https://yunohost.org/app_pihole +* Report a bug: https://github.com/YunoHost-Apps/pihole_ynh/issues - * Report a bug: https://github.com/YunoHost-Apps/pihole_ynh/issues - * Pi-hole website: https://pi-hole.net/ - * Pi-hole repository: https://github.com/pi-hole/pi-hole/ - * YunoHost website: https://yunohost.org/ +## Developer info ---- +Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/pihole_ynh/tree/testing). -Developers infos ----------------- - -Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/pihole_ynh/tree/testing). - -To try the testing branch, please do the following: +To try the testing branch, please proceed like that. ``` -sudo yunohost app install https://github.com/YunoHost-Apps/pihole_ynh/tree/testing --force --debug +sudo yunohost app install https://github.com/YunoHost-Apps/pihole_ynh/tree/testing --debug or sudo yunohost app upgrade pihole -u https://github.com/YunoHost-Apps/pihole_ynh/tree/testing --debug ``` + +**More info regarding app packaging:** https://yunohost.org/packaging_apps \ No newline at end of file diff --git a/README_fr.md b/README_fr.md index 23c754c..c0cdccc 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,73 +1,54 @@ # Pi-hole pour YunoHost [![Niveau d'intégration](https://dash.yunohost.org/integration/pihole.svg)](https://dash.yunohost.org/appci/app/pihole) ![](https://ci-apps.yunohost.org/ci/badges/pihole.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/pihole.maintain.svg) -[![Installer Pi-hole avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=pihole) +[![Installer Pi-hole avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=pihole) *[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* -> *Ce package vous permet d'installer Pi-hole rapidement et simplement sur un serveur YunoHost. -Si vous n'avez pas YunoHost, merci de regarder [ici](https://yunohost.org/#/install_fr) pour savoir comment l'installer et en profiter.* +> *Ce package vous permet d'installer Pi-hole 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.* -## Résumé -Blocage des publicités sur l'ensemble du réseau via votre propre matériel Linux +## Vue d'ensemble + +Filtrage publicitaire sur l'ensemble du réseau via votre propre serveur DNS. + +**Version incluse :** 5.3.1~ynh1 -**Version embarquée:** 3.3.1 ou 5.3.1 ## Captures d'écran -![](https://i0.wp.com/pi-hole.net/wp-content/uploads/2016/12/dashboard212.png) +![](./doc/screenshots/dashboard.png) -## Démo - -Aucune démo pour cette application. +## Avertissements / informations importantes ## Configuration Utiliser le panneau d'administration de votre Pi-hole pour configurer cette application. Vous devrez peut-être aussi suivre le [guide de post-installation] (https://docs.pi-hole.net/main/post-install/) pour configurer Pi-hole en tant que *serveur DNS* ou *serveur DHCP*. -## Documentation - -* Documentation officielle: https://docs.pi-hole.net/ -* Pi-hole en tant que serveur DHCP: [dhcp.md](./dhcp.md) -* Documentation YunoHost: Il n'y a pas d'autre documentation, n'hésitez pas à contribuer. - -## Fonctionnalités spécifiques à YunoHost - -* Accès privé au panneau d'administration. - -#### Support multi-utilisateurs - -#### Architectures supportées. - -* x86-64b - [![](https://ci-apps.yunohost.org/ci/logs/pihole%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/pihole/) -* ARMv8-A - [![](https://ci-apps-arm.yunohost.org/ci/logs/pihole%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/pihole/) -* Buster x86-64b - [![](https://ci-buster.nohost.me/ci/logs/pihole%20%28Apps%29.svg)](https://ci-buster.nohost.me/ci/apps/pihole/) - ## Limitations * Activer DHCP avec Pi-hole nécessite une configuration manuelle de votre routeur. * Pi-Hole ne peut pas être mis à jour au-delà de la version 3.3.1, car les versions supérieures utilisent une version intégrée de dnsmasq. Ce qui oblige a désactiver la version de dnsmasq utilisée par YunoHost. -## Informations additionnelles +## Documentations et ressources -## Liens +* Site officiel de l'app : https://pi-hole.net/ +* Documentation officielle de l'admin : https://docs.pi-hole.net +* Dépôt de code officiel de l'app : https://github.com/pi-hole/pi-hole/ +* Documentation YunoHost pour cette app : https://yunohost.org/app_pihole +* Signaler un bug : https://github.com/YunoHost-Apps/pihole_ynh/issues - * Reporter un bug: https://github.com/YunoHost-Apps/pihole_ynh/issues - * Site de Pi-hole: https://pi-hole.net/ - * Dépôt de Pi-hole: https://github.com/pi-hole/pi-hole/ - * Site de YunoHost: https://yunohost.org/ - ---- - -Informations à l'intention des développeurs ----------------- +## Informations pour les développeurs Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/pihole_ynh/tree/testing). -Pour tester la branche testing, merci de procéder ainsi. +Pour essayer la branche testing, procédez comme suit. ``` -sudo yunohost app install https://github.com/YunoHost-Apps/pihole_ynh/tree/testing --force --debug +sudo yunohost app install https://github.com/YunoHost-Apps/pihole_ynh/tree/testing --debug ou sudo yunohost app upgrade pihole -u https://github.com/YunoHost-Apps/pihole_ynh/tree/testing --debug ``` + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file