mirror of
https://github.com/YunoHost-Apps/pihole_ynh.git
synced 2024-09-03 20:05:58 +02:00
51 lines
2.2 KiB
Markdown
51 lines
2.2 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)
|
|
|
|
*[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
|
|
|
|
|
|
|
|
## :red_circle: Antifeatures
|
|
|
|
- **Package not maintained**: This YunoHost package is not actively maintained and needs adoption. This means that minimal maintenance is made by volunteers who don't use the app, so you should expect the app to lose reliability over time. You can [learn how to package](https://yunohost.org/packaging_apps_intro) if you'd like to adopt it.
|
|
|
|
## 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>
|