1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/pihole_ynh.git synced 2024-09-03 20:05:58 +02:00
pihole_ynh/README.md
2024-05-03 20:09:19 +00:00

47 lines
1.9 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
[![Integration level](https://dash.yunohost.org/integration/pihole.svg)](https://dash.yunohost.org/appci/app/pihole) ![Working status](https://ci-apps.yunohost.org/ci/badges/pihole.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/pihole.maintain.svg)
[![Install Pi-hole with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=pihole)
*[Read this README in other languages.](./ALL_README.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
The Pi-hole® is a DNS sinkhole that protects your devices from unwanted content without installing any client-side software.
**Shipped version:** 5.14.2~ynh4
## Screenshots
![Screenshot of Pi-hole](./doc/screenshots/dashboard.png)
## 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 Store: <https://apps.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:
```bash
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>