YunoHost-Apps/pihole_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/pihole_ynh.git synced 2024-09-03 20:05:58 +02:00
Code Issues Activity Actions

Auto-update README

Browse source
This commit is contained in:
yunohost-bot 2024-03-29 07:18:33 +01:00
parent 5cc0fe9d75
commit b2003bd3e9
5 changed files with 253 additions and 27 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
ALL_README.md Normal file
View file

@ -0,0 +1,6 @@
# All available README files by language
- [Read the README in English](README.md)
- [Lire le README en français](README_fr.md)
- [Le o README en galego](README_gl.md)
- [Leggi il “README” in italiano](README_it.md)

24
README.md
View file

@ -1,5 +1,5 @@
<!-- <!--
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator 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. It shall NOT be edited by hand.
--> -->
@ -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) [![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 is other languages.](./ALL_README.md)*
> *This package allows you to install Pi-hole quickly and simply on a YunoHost server. > *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.* > *If you don't have YunoHost, please consult [the guide](https://yunohost.org/install) to learn how to install it.*
## Overview ## Overview
@ -89,19 +89,19 @@ 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. > Don't forget to turn off the DHCP of your router if your server is working again.
## Documentation and resources ## Documentation and resources
* Official app website: <https://pi-hole.net/> - Official app website: <https://pi-hole.net/>
* Official admin documentation: <https://docs.pi-hole.net> - Official admin documentation: <https://docs.pi-hole.net>
* Upstream app code repository: <https://github.com/pi-hole/pi-hole> - Upstream app code repository: <https://github.com/pi-hole/pi-hole>
* YunoHost Store: <https://apps.yunohost.org/app/pihole> - YunoHost Store: <https://apps.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>
## Developer info ## 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 sudo yunohost app install https://github.com/YunoHost-Apps/pihole_ynh/tree/testing --debug
or or
sudo yunohost app upgrade pihole -u 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

30
README_fr.md
View file

@ -1,6 +1,6 @@
<!-- <!--
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator Nota bene : ce README est automatiquement généré par <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>
It shall NOT be edited by hand. Il NE doit PAS être modifié à la main.
--> -->
# Pi-hole pour YunoHost # Pi-hole pour YunoHost
@ -9,17 +9,17 @@ 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) [![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. > *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.* > *Si vous n’avez pas YunoHost, consultez [ce guide](https://yunohost.org/install) pour savoir comment l’installer et en profiter.*
## Vue d’ensemble ## 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. 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 ## Captures d’écran
@ -91,22 +91,22 @@ sudo ifconfig eth0 0.0.0.0 && sudo dhclient eth0
## Documentations et ressources ## Documentations et ressources
* Site officiel de l’app : <https://pi-hole.net/> - Site officiel de l’app : <https://pi-hole.net/>
* Documentation officielle de l’admin : <https://docs.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> - Dépôt de code officiel de l’app : <https://github.com/pi-hole/pi-hole>
* YunoHost Store: <https://apps.yunohost.org/app/pihole> - YunoHost Store : <https://apps.yunohost.org/app/pihole>
* Signaler un bug : <https://github.com/YunoHost-Apps/pihole_ynh/issues> - Signaler un bug : <https://github.com/YunoHost-Apps/pihole_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/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 sudo yunohost app install https://github.com/YunoHost-Apps/pihole_ynh/tree/testing --debug
ou ou
sudo yunohost app upgrade pihole -u 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
``` ```
**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>

110
README_gl.md Normal file
View file

@ -0,0 +1,110 @@
<!--
NOTA: Este README foi creado automáticamente por <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>
NON debe editarse manualmente.
-->
# 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)
## Avisos / información importante
## 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.
## Documentación e recursos
- Web oficial da app: <https://pi-hole.net/>
- Documentación oficial para admin: <https://docs.pi-hole.net>
- Repositorio de orixe do código: <https://github.com/pi-hole/pi-hole>
- Tenda YunoHost: <https://apps.yunohost.org/app/pihole>
- Informar dun problema: <https://github.com/YunoHost-Apps/pihole_ynh/issues>
## 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:** <https://yunohost.org/packaging_apps>

110
README_it.md Normal file
View file

@ -0,0 +1,110 @@
<!--
N.B.: Questo README è stato automaticamente generato da <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>
NON DEVE essere modificato manualmente.
-->
# Pi-hole per YunoHost
[![Livello di integrazione](https://dash.yunohost.org/integration/pihole.svg)](https://dash.yunohost.org/appci/app/pihole) ![Stato di funzionamento](https://ci-apps.yunohost.org/ci/badges/pihole.status.svg) ![Stato di manutenzione](https://ci-apps.yunohost.org/ci/badges/pihole.maintain.svg)
[![Installa Pi-hole con YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=pihole)
*[Leggi questo README in altre lingue.](./ALL_README.md)*
> *Questo pacchetto ti permette di installare Pi-hole su un server YunoHost in modo semplice e veloce.*
> *Se non hai YunoHost, consulta [la guida](https://yunohost.org/install) per imparare a installarlo.*
## Panoramica
The Pi-hole® is a DNS sinkhole that protects your devices from unwanted content without installing any client-side software.
**Versione pubblicata:** 5.14.2~ynh4
## Screenshot
![Screenshot di Pi-hole](./doc/screenshots/dashboard.png)
## Attenzione/informazioni importanti
## 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.
## Documentazione e risorse
- Sito web ufficiale dell’app: <https://pi-hole.net/>
- Documentazione ufficiale per gli amministratori: <https://docs.pi-hole.net>
- Repository upstream del codice dell’app: <https://github.com/pi-hole/pi-hole>
- Store di YunoHost: <https://apps.yunohost.org/app/pihole>
- Segnala un problema: <https://github.com/YunoHost-Apps/pihole_ynh/issues>
## Informazioni per sviluppatori
Si prega di inviare la tua pull request alla [branch di `testing`](https://github.com/YunoHost-Apps/pihole_ynh/tree/testing).
Per provare la branch di `testing`, si prega di procedere in questo modo:
```bash
sudo yunohost app install https://github.com/YunoHost-Apps/pihole_ynh/tree/testing --debug
o
sudo yunohost app upgrade pihole -u https://github.com/YunoHost-Apps/pihole_ynh/tree/testing --debug
```
**Maggiori informazioni riguardo il pacchetto di quest’app:** <https://yunohost.org/packaging_apps>