|
|
@@ -1,53 +1,44 @@
|
|
|
<!--
|
|
|
-N.B.: This README was automatically generated by <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>
|
|
|
+N.B.: This README was automatically generated by <https://github.com/YunoHost/apps_tools/blob/main/readme_generator>
|
|
|
It shall NOT be edited by hand.
|
|
|
-->
|
|
|
|
|
|
-# Pi-hole for YunoHost
|
|
|
+<h1>
|
|
|
+ <img src="https://raw.githubusercontent.com/YunoHost/apps/main/logos/pihole.png" width="32px" alt="Logo of Pi-hole">
|
|
|
+ Pi-hole, packaged for YunoHost
|
|
|
+</h1>
|
|
|
|
|
|
-[](https://ci-apps.yunohost.org/ci/apps/pihole/)
|
|
|
-
|
|
|
-
|
|
|
+Network-wide ad blocking via your own DNS server
|
|
|
|
|
|
-[](https://install-app.yunohost.org/?app=pihole)
|
|
|
+[](https://pi-hole.net/)
|
|
|
+[?style=for-the-badge)](https://ci-apps.yunohost.org/ci/apps/pihole/)
|
|
|
|
|
|
-*[Read this README in other languages.](./ALL_README.md)*
|
|
|
+<div align="center">
|
|
|
+<a href="https://apps.yunohost.org/app/pihole"><img height="100px" src="https://github.com/YunoHost/yunohost-artwork/raw/refs/heads/main/badges/neopossum-badges/badge_more_info_on_the_appstore.svg"/></a>
|
|
|
+<a href="https://github.com/YunoHost-Apps/pihole_ynh/issues"><img height="100px" src="https://github.com/YunoHost/yunohost-artwork/raw/refs/heads/main/badges/neopossum-badges/badge_report_an_issue.svg"/></a>
|
|
|
+</div>
|
|
|
|
|
|
-> *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.18.4~ynh1
|
|
|
|
|
|
## Screenshots
|
|
|
-
|
|
|

|
|
|
|
|
|
-## :red_circle: Antifeatures
|
|
|
+## 📦 Developer info
|
|
|
|
|
|
-- **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.
|
|
|
+[](https://ci-apps.yunohost.org/ci/apps/pihole/)
|
|
|
|
|
|
-## Documentation and resources
|
|
|
+🛠️ Upstream Pi-hole repository: <https://github.com/pi-hole/pi-hole>
|
|
|
|
|
|
-- 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>
|
|
|
+Pull request are welcome and should target the [`testing` branch](https://github.com/YunoHost-Apps/pihole_ynh/tree/testing).
|
|
|
|
|
|
-## 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:
|
|
|
+The `testing` branch can be tested using:
|
|
|
+```
|
|
|
+# fresh install:
|
|
|
+sudo yunohost app install https://github.com/YunoHost-Apps/pihole_ynh/tree/testing
|
|
|
|
|
|
-```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
|
|
|
+# upgrade an existing install:
|
|
|
+sudo yunohost app upgrade pihole -u https://github.com/YunoHost-Apps/pihole_ynh/tree/testing
|
|
|
```
|
|
|
|
|
|
-**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
|
|
|
+### 📚 App packaging documentation
|
|
|
+
|
|
|
+Please see <https://doc.yunohost.org/packaging_apps> for more information.
|