mirror of
https://github.com/YunoHost-Apps/pihole_ynh.git
synced 2024-09-03 20:05:58 +02:00
58 lines
No EOL
2.3 KiB
Markdown
58 lines
No EOL
2.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.3.1~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.
|
|
* 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.
|
|
|
|
## 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 |