pihole_ynh/README.md

Pi-hole for YunoHost

Lire ce readme en français.

This package allow you to install Pi-hole quickly and easily on a YunoHost server.
If you don't have YunoHost, please see here to learn how to install and enjoy it.

Overview

Network-wide ad blocking via your own Linux hardware

Shipped version: 3.3.1 or 5.3.1

Screenshots

Demo

No demo available.

Configuration

Use the admin panel of your Pi-hole to configure this app. You may also need to follow the post-install guide to setup Pi-hole either as a DNS server or a DHCP server.

Documentation

• Official documentation: https://docs.pi-hole.net/
• Pi-hole as a DHCP server: dhcp.md
• YunoHost documentation: There is no other documentation. Feel free to contribute!

YunoHost specific features

• Private access to the admin panel.

Multi-users support

Supported architectures

• x86-64b -
• ARMv8-A -
• Buster x86-64b -

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.

Additionnal informations

Links

• Report a bug: https://github.com/YunoHost-Apps/pihole_ynh/issues
• Pi-hole website: https://pi-hole.net/
• Pi-hole repository: https://github.com/pi-hole/pi-hole/
• YunoHost website: https://yunohost.org/

---

Developers infos

Please do your pull request to the testing branch.

To try the testing branch, please do the following:

sudo yunohost app install https://github.com/YunoHost-Apps/pihole_ynh/tree/testing --force --debug
or
sudo yunohost app upgrade pihole -u https://github.com/YunoHost-Apps/pihole_ynh/tree/testing --debug