diff --git a/ALL_README.md b/ALL_README.md new file mode 100644 index 0000000..a01b345 --- /dev/null +++ b/ALL_README.md @@ -0,0 +1,7 @@ +# All available README files by language + +- [Read the README in English](README.md) +- [Irakurri README euskaraz](README_eu.md) +- [Lire le README en français](README_fr.md) +- [Le o README en galego](README_gl.md) +- [阅读中文（简体）的 README](README_zh_Hans.md) diff --git a/README.md b/README.md index 6f3c973..bd0370f 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ @@ -9,10 +9,10 @@ It shall NOT be edited by hand. [![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)* +*[Read this README in other languages.](./ALL_README.md)* -> *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.* +> *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 @@ -24,84 +24,21 @@ The Pi-hole® is a DNS sinkhole that protects your devices from unwanted content ![Screenshot of Pi-hole](./doc/screenshots/dashboard.png) -## 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*. - -## Limitations - -* Activate DHCP with Pi-hole needs manual configuration of your router. - -## Using Pi-hole as your DHCP server - -> **Be careful, you should considering that playing with your DHCP may break your network. -In case your server is down, you will lose your dns resolution and ip address. -So, you will lose any internet connection and even the connection to your router.** - -> **If you encounter this kind of problem, please see "How to restore my network" at the end of this document.** - -### How to configure Pi-hole - -There're two ways to configure Pi-hole to be used as your DHCP server. -- Either you can choose to use it when you install the app. -- Or you can activate the DHCP server afterwards in the "Settings" tab, "Pi-hole DHCP Server" part. -In this second case, it can be better to set the ip of the server to a static address - -### How to configure my router - -Your personal router or ISP's router has a DHCP server enabled by default. -If you keep this DHCP, along with Pi-hole's one, you will have transparent conflicts between them. -The first DHCP to respond will distribute its own ip and settings. -So you have to turn off the DHCP of your router to let Pi-hole managed your network. - -#### Why should I use only the DHCP of Pi-hole ? - -By using the DHCP of Pi-hole, you allow Pi-hole to give at each of your client its dns configuration. This way every requests will be filtered by Pi-hole. - -Another use case of using Pi-hole's DHCP is if you have hairpinning problems (You can't connect to your server because its IP is your public IP, and your router doesn't allow that). -In this case, using Pi-hole's dns will allow you to connect to your server by its local address instead of its public one. - -### How to restore my network - -> Oh crap ! -Your Pi-hole server is down, and you don't have a DHCP anymore. -Don't panic, We'll get through it. \o/ - -Use your favorite terminal on your desktop computer. -And first, get your main interface (usually `eth0`). -``` bash -sudo ifconfig -``` - -Then, set your ip as a static ip. -``` bash -sudo ifconfig eth0 192.168.1.100 -``` - -Now, you can connect to your router and turn on its DHCP server to use it again. -You can now reset your ip and get a dynamic address. -``` bash -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: -* Official admin documentation: -* Upstream app code repository: -* YunoHost Store: -* Report a bug: +- Official app website: +- Official admin documentation: +- Upstream app code repository: +- YunoHost Store: +- Report a bug: ## Developer info -Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/pihole_ynh/tree/testing). +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. +To try the `testing` branch, please proceed like that: -``` bash +```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 diff --git a/README_eu.md b/README_eu.md new file mode 100644 index 0000000..f7f9879 --- /dev/null +++ b/README_eu.md @@ -0,0 +1,47 @@ + + +# Pi-hole YunoHost-erako + +[![Integrazio maila](https://dash.yunohost.org/integration/pihole.svg)](https://dash.yunohost.org/appci/app/pihole) ![Funtzionamendu egoera](https://ci-apps.yunohost.org/ci/badges/pihole.status.svg) ![Mantentze egoera](https://ci-apps.yunohost.org/ci/badges/pihole.maintain.svg) + +[![Instalatu Pi-hole YunoHost-ekin](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=pihole) + +*[Irakurri README hau beste hizkuntzatan.](./ALL_README.md)* + +> *Pakete honek Pi-hole YunoHost zerbitzari batean azkar eta zailtasunik gabe instalatzea ahalbidetzen dizu.* +> *YunoHost ez baduzu, kontsultatu [gida](https://yunohost.org/install) nola instalatu ikasteko.* + +## Aurreikuspena + +The Pi-hole® is a DNS sinkhole that protects your devices from unwanted content without installing any client-side software. + +**Paketatutako bertsioa:** 5.14.2~ynh4 + +## Pantaila-argazkiak + +![Pi-hole(r)en pantaila-argazkia](./doc/screenshots/dashboard.png) + +## Dokumentazioa eta baliabideak + +- Aplikazioaren webgune ofiziala: +- Administratzaileen dokumentazio ofiziala: +- Jatorrizko aplikazioaren kode-gordailua: +- YunoHost Denda: +- Eman errore baten berri: + +## Garatzaileentzako informazioa + +Bidali `pull request`a [`testing` abarrera](https://github.com/YunoHost-Apps/pihole_ynh/tree/testing). + +`testing` abarra probatzeko, ondorengoa egin: + +```bash +sudo yunohost app install https://github.com/YunoHost-Apps/pihole_ynh/tree/testing --debug +edo +sudo yunohost app upgrade pihole -u https://github.com/YunoHost-Apps/pihole_ynh/tree/testing --debug +``` + +**Informazio gehiago aplikazioaren paketatzeari buruz:** diff --git a/README_fr.md b/README_fr.md index 112f3d5..fe66c8c 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,6 +1,6 @@ # Pi-hole pour YunoHost @@ -9,104 +9,40 @@ It shall NOT be edited by hand. [![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 le README dans d'autres langues.](./ALL_README.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.* +> *Ce package vous permet d’installer Pi-hole rapidement et simplement sur un serveur YunoHost.* +> *Si vous n’avez pas YunoHost, consultez [ce guide](https://yunohost.org/install) pour savoir comment l’installer et en profiter.* ## Vue d’ensemble Pi-hole® est un puits DNS qui protège vos appareils des contenus indésirables sans installer de logiciel côté client. -**Version incluse :** 5.14.2~ynh4 +**Version incluse :** 5.14.2~ynh4 ## Captures d’écran ![Capture d’écran de Pi-hole](./doc/screenshots/dashboard.png) -## 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*. - -## Limitations - -* Activer DHCP avec Pi-hole nécessite une configuration manuelle de votre routeur. - -## Faire de Pi-hole votre serveur DHCP - -> **Attention, vous devez savoir que toucher à votre DHCP pourrait casser votre réseau. -Dans le cas où votre serveur serait inaccessible, vous perdriez votre résolution dns et votre adresse IP. -Ainsi, vous perdriez toute connexion à internet et même la connexion à votre routeur.** - -> **Si vous rencontrez ce genre de problèmes, merci de lire la section "Comment restaurer mon réseau" à la fin de ce document.** - -### Comment configurer Pi-hole - -Il y a 2 manière de configurer Pi-hole pour qu'il soit utilisé comme votre serveur DHCP. -- Soit vous pouvez choisir de l'utiliser lorsque vous installez l'application. -- Soit vous pouvez activer le serveur DHCP par la suite dans l'onglet "Settings", partie "Pi-hole DHCP Server". -Dans ce second cas, il peut être préférable de forcer l'ip du serveur à une adresse statique. - -### Comment configurer mon routeur - -Votre routeur ou celui de votre FAI dispose d'un serveur DHCP activé par défaut. -Si vous gardez ce DHCP, en même temps que celui de Pi-hole, vous allez avoir des conflits transparents entre eux. -Le premier serveur DHCP à répondre va distribuer ses propres ip et paramètres. -Donc vous devez éteindre le serveur DHCP de votre routeur et laisser Pi-hole gérer votre réseau. - -#### Pourquoi je devrais utiliser le DHCP de Pi-hole ? - -En utilisant le DHCP de Pi-hole, vous lui permettez de donner sa configuration dns à chacun de vos clients. De cette manière, chaque requête sera filtrée par Pi-hole. - -Un autre cas d'usage du DHCP de Pi-hole est le cas où vous rencontrez des problèmes de hairpinning (Vous ne pouvez pas vous connecter à votre serveur parce que son ip est votre ip publique, et votre routeur n'autorise pas cela). -Dans ce cas, utilisez le dns de Pi-hole va vous permettre de vous connecter à votre serveur par son adresse locale plutôt que son adresse publique. - -### Comment restaurer mon réseau - -> Oups ! -Votre serveur Pi-hole est tombé, et vous n'avez plus de DHCP. -Ne paniquez pas, on va surmonter ça \o/ - -Utilisez votre terminal favori sur votre ordinateur de bureau. -Et tout d'abord, récupérer votre interface réseau (Le plus souvent `eth0`). -``` bash -sudo ifconfig -``` - -Ensuite, changer votre ip pour une ip statique. -``` bash -sudo ifconfig eth0 192.168.1.100 -``` - -Maintenant, vous pouvez vous connecter à votre routeur et rallumer son serveur DHCP pour l'utiliser à nouveau. -Vous pouvez maintenant retirer votre ip statique et réobtenir une ip dynamique. -``` bash -sudo ifconfig eth0 0.0.0.0 && sudo dhclient eth0 -``` - -> N'oubliez pas d'éteindre le DHCP de votre routeur si votre serveur fonctionne à nouveau. - ## Documentations et ressources -* Site officiel de l’app : -* Documentation officielle de l’admin : -* Dépôt de code officiel de l’app : -* YunoHost Store: -* Signaler un bug : +- Site officiel de l’app : +- Documentation officielle de l’admin : +- Dépôt de code officiel de l’app : +- YunoHost Store : +- 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). +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. +Pour essayer la branche `testing`, procédez comme suit : -``` bash +```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 :** \ No newline at end of file +**Plus d’infos sur le packaging d’applications :** diff --git a/README_gl.md b/README_gl.md new file mode 100644 index 0000000..f8f11c6 --- /dev/null +++ b/README_gl.md @@ -0,0 +1,47 @@ + + +# Pi-hole para YunoHost + +[![Nivel de integración](https://dash.yunohost.org/integration/pihole.svg)](https://dash.yunohost.org/appci/app/pihole) ![Estado de funcionamento](https://ci-apps.yunohost.org/ci/badges/pihole.status.svg) ![Estado de mantemento](https://ci-apps.yunohost.org/ci/badges/pihole.maintain.svg) + +[![Instalar Pi-hole con YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=pihole) + +*[Le este README en outros idiomas.](./ALL_README.md)* + +> *Este paquete permíteche instalar Pi-hole de xeito rápido e doado nun servidor YunoHost.* +> *Se non usas YunoHost, le a [documentación](https://yunohost.org/install) para saber como instalalo.* + +## Vista xeral + +The Pi-hole® is a DNS sinkhole that protects your devices from unwanted content without installing any client-side software. + +**Versión proporcionada:** 5.14.2~ynh4 + +## Capturas de pantalla + +![Captura de pantalla de Pi-hole](./doc/screenshots/dashboard.png) + +## Documentación e recursos + +- Web oficial da app: +- Documentación oficial para admin: +- Repositorio de orixe do código: +- Tenda YunoHost: +- Informar dun problema: + +## Info de desenvolvemento + +Envía a túa colaboración á [rama `testing`](https://github.com/YunoHost-Apps/pihole_ynh/tree/testing). + +Para probar a rama `testing`, procede deste xeito: + +```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 +``` + +**Máis info sobre o empaquetado da app:** diff --git a/README_zh_Hans.md b/README_zh_Hans.md new file mode 100644 index 0000000..f86e419 --- /dev/null +++ b/README_zh_Hans.md @@ -0,0 +1,47 @@ + + +# YunoHost 的 Pi-hole + +[![集成程度](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) + +[![使用 YunoHost 安装 Pi-hole](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=pihole) + +*[阅读此 README 的其它语言版本。](./ALL_README.md)* + +> *通过此软件包，您可以在 YunoHost 服务器上快速、简单地安装 Pi-hole。* +> *如果您还没有 YunoHost，请参阅[指南](https://yunohost.org/install)了解如何安装它。* + +## 概况 + +The Pi-hole® is a DNS sinkhole that protects your devices from unwanted content without installing any client-side software. + +**分发版本：** 5.14.2~ynh4 + +## 截图 + +![Pi-hole 的截图](./doc/screenshots/dashboard.png) + +## 文档与资源 + +- 官方应用网站： +- 官方管理文档： +- 上游应用代码库： +- YunoHost 商店： +- 报告 bug： + +## 开发者信息 + +请向 [`testing` 分支](https://github.com/YunoHost-Apps/pihole_ynh/tree/testing) 发送拉取请求。 + +如要尝试 `testing` 分支，请这样操作： + +```bash +sudo yunohost app install https://github.com/YunoHost-Apps/pihole_ynh/tree/testing --debug +或 +sudo yunohost app upgrade pihole -u https://github.com/YunoHost-Apps/pihole_ynh/tree/testing --debug +``` + +**有关应用打包的更多信息：**