mirror of
https://github.com/YunoHost-Apps/pihole_ynh.git
synced 2024-09-03 20:05:58 +02:00
111 lines
No EOL
4.3 KiB
Markdown
111 lines
No EOL
4.3 KiB
Markdown
<!--
|
|
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.
|
|
-->
|
|
|
|
# Pi-hole for YunoHost
|
|
|
|
[](https://dash.yunohost.org/appci/app/pihole)  
|
|
[](https://install-app.yunohost.org/?app=pihole)
|
|
|
|
*[Lire ce readme en français.](./README_fr.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.*
|
|
|
|
## Overview
|
|
|
|
Network-wide ad blocking via your own DNS server
|
|
|
|
|
|
**Shipped version:** 5.9~ynh1
|
|
|
|
|
|
|
|
## Screenshots
|
|
|
|
|
|
|
|
## 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: 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
|
|
|
|
## 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.
|
|
```
|
|
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 |