From cc16bee4f0d2666e44de3b3f5c2c484f8705e0ab Mon Sep 17 00:00:00 2001 From: grenagit <46225780+grenagit@users.noreply.github.com> Date: Sun, 29 May 2022 20:46:25 +0200 Subject: [PATCH 1/2] Apply official template for comments --- conf/pihole-FTL.conf | 33 ++++++++++++++++++--------------- 1 file changed, 18 insertions(+), 15 deletions(-) diff --git a/conf/pihole-FTL.conf b/conf/pihole-FTL.conf index 473ca7f..31f2444 100644 --- a/conf/pihole-FTL.conf +++ b/conf/pihole-FTL.conf @@ -1,34 +1,37 @@ -; Listen only for local socket connections or permit all connections -; localonly|all +#; Pi-hole FTL config file +#; Comments should start with #; to avoid issues with PHP and bash reading this file + +#; Listen only for local socket connections or permit all connections +#; localonly|all SOCKET_LISTENING=localonly -; On which port should FTL be listening? +#; On which port should FTL be listening? FTLPORT=__PORT__ -; Display all queries? Set to no to hide query display -; yes|no +#; Display all queries? Set to no to hide query display +#; yes|no QUERY_DISPLAY=yes -; Allow FTL to analyze AAAA queries from pihole.log? -; yes|no +#; Allow FTL to analyze AAAA queries from pihole.log? +#; yes|no AAAA_QUERY_ANALYSIS=yes -; How long should queries be stored in the database? Setting this to 0 disables the database altogether +#; How long should queries be stored in the database? Setting this to 0 disables the database altogether MAXDBDAYS=365 -; Should FTL try to resolve IPv6 addresses to host names? -; yes|no +#; Should FTL try to resolve IPv6 addresses to host names? +#; yes|no RESOLVE_IPV6=yes -; Should FTL try to resolve IPv4 addresses to host names? -; yes|no +#; Should FTL try to resolve IPv4 addresses to host names? +#; yes|no RESOLVE_IPV4=yes -; How often do we store queries in FTL's database [minutes]? +#; How often do we store queries in FTL's database [minutes]? DBINTERVAL=1.0 -; Specify path and filename of FTL's SQLite long-term database. Setting this to DBFILE= disables the database altogether +#; Specify path and filename of FTL's SQLite long-term database. Setting this to DBFILE= disables the database altogether DBFILE=/etc/pihole/pihole-FTL.db -; Up to how many hours of queries should be imported from the database and logs? Maximum is 744 (31 days) +#; Up to how many hours of queries should be imported from the database and logs? Maximum is 744 (31 days) MAXLOGAGE=24.0 From 548d81bdad5c6b9640601b53aab5b26dae45f886 Mon Sep 17 00:00:00 2001 From: yunohost-bot Date: Sat, 16 Jul 2022 06:13:59 +0000 Subject: [PATCH 2/2] Auto-update README --- README.md | 21 ++++++++++----------- README_fr.md | 27 +++++++++++++++------------ 2 files changed, 25 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 7318da4..334f055 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ It shall NOT be edited by hand. # 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) +[![Integration level](https://dash.yunohost.org/integration/pihole.svg)](https://dash.yunohost.org/appci/app/pihole) ![Working status](https://ci-apps.yunohost.org/ci/badges/pihole.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/pihole.maintain.svg) [![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)* @@ -19,11 +19,9 @@ The Pi-hole® is a DNS sinkhole that protects your devices from unwanted content **Shipped version:** 5.10~ynh1 - - ## Screenshots -![](./doc/screenshots/dashboard.png) +![Screenshot of Pi-hole](./doc/screenshots/dashboard.png) ## Disclaimers / important information @@ -90,21 +88,22 @@ sudo ifconfig eth0 0.0.0.0 && sudo dhclient eth0 > Don't forget to turn off the DHCP of your router if your server is working again. ## Documentation and resources -* 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 +* Official app website: +* Official admin documentation: +* Upstream app code repository: +* YunoHost documentation for this app: +* Report a bug: ## Developer info Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/pihole_ynh/tree/testing). To try the testing branch, please proceed like that. -``` + +``` bash 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 +**More info regarding app packaging:** diff --git a/README_fr.md b/README_fr.md index d3d3820..c699862 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,10 +1,14 @@ + + # 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) +[![Niveau d'intégration](https://dash.yunohost.org/integration/pihole.svg)](https://dash.yunohost.org/appci/app/pihole) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/pihole.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/pihole.maintain.svg) [![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, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.* @@ -15,11 +19,9 @@ The Pi-hole® is a DNS sinkhole that protects your devices from unwanted content **Version incluse :** 5.10~ynh1 - - ## Captures d'écran -![](./doc/screenshots/dashboard.png) +![Capture d'écran de Pi-hole](./doc/screenshots/dashboard.png) ## Avertissements / informations importantes @@ -87,21 +89,22 @@ sudo ifconfig eth0 0.0.0.0 && sudo dhclient eth0 ## Documentations et ressources -* 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 +* Site officiel de l'app : +* Documentation officielle de l'admin : +* Dépôt de code officiel de l'app : +* Documentation YunoHost pour cette app : +* Signaler un bug : ## 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 essayer la branche testing, procédez comme suit. -``` + +``` bash 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 +**Plus d'infos sur le packaging d'applications :**