mirror of
https://github.com/YunoHost-Apps/pihole_ynh.git
synced 2024-09-03 20:05:58 +02:00
115a240a1b
The post-install step is important for the app to be functional and the DNS server option should be mentioned as an alternative to the DHCP server option.
71 lines
2.5 KiB
Markdown
71 lines
2.5 KiB
Markdown
# 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 allow you to install Pi-hole quickly and simply on a YunoHost server.
|
|
If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.*
|
|
|
|
## Overview
|
|
Network-wide ad blocking via your own Linux hardware
|
|
|
|
**Shipped version:** 3.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](https://docs.pi-hole.net/main/post-install/) 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](./dhcp.md)
|
|
* YunoHost documentation: There no other documentations, feel free to contribute.
|
|
|
|
## YunoHost specific features
|
|
|
|
* Private access to the admin panel.
|
|
|
|
#### Multi-users support
|
|
|
|
#### Supported architectures
|
|
|
|
* x86-64b - [](https://ci-apps.yunohost.org/ci/apps/pihole/)
|
|
* ARMv8-A - [](https://ci-apps-arm.yunohost.org/ci/apps/pihole/)
|
|
* Jessie x86-64b - [](https://ci-stretch.nohost.me/ci/apps/pihole/)
|
|
|
|
## Limitations
|
|
|
|
* Activate DHCP with Pi-hole need a manuel configuration of your router.
|
|
* Pi-Hole can't be updated beyond the version 3.3.1, because higher versions use an integrated version of dnsmasq. This would forces to disable 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/
|
|
* YunoHost website: https://yunohost.org/
|
|
|
|
---
|
|
|
|
Developers infos
|
|
----------------
|
|
|
|
Please do 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
|
|
```
|