|
@@ -1,63 +1,41 @@
|
|
|
<!--
|
|
<!--
|
|
|
-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.
|
|
It shall NOT be edited by hand.
|
|
|
-->
|
|
-->
|
|
|
|
|
|
|
|
-# Homarr for YunoHost
|
|
|
|
|
|
|
+<h1>
|
|
|
|
|
+ <img src="https://raw.githubusercontent.com/YunoHost/apps/main/logos/homarr.png" width="32px" alt="Logo of Homarr">
|
|
|
|
|
+ Homarr, packaged for YunoHost
|
|
|
|
|
+</h1>
|
|
|
|
|
|
|
|
-[](https://ci-apps.yunohost.org/ci/apps/homarr/)
|
|
|
|
|
-
|
|
|
|
|
-
|
|
|
|
|
|
|
+Customizable browser's home page to interact with your homeserver's Docker containers
|
|
|
|
|
|
|
|
-[](https://install-app.yunohost.org/?app=homarr)
|
|
|
|
|
|
|
+[](https://homarr.dev/)
|
|
|
|
|
+[](https://homarr.ajnart.fr/fr)
|
|
|
|
|
+[?style=for-the-badge)](https://ci-apps.yunohost.org/ci/apps/homarr/)
|
|
|
|
|
|
|
|
-*[Read this README in other languages.](./ALL_README.md)*
|
|
|
|
|
|
|
+<div align="center">
|
|
|
|
|
+<a href="https://apps.yunohost.org/app/homarr"><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/homarr_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 Homarr 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.*
|
|
|
|
|
|
|
+## 📦 Developer info
|
|
|
|
|
|
|
|
-## Overview
|
|
|
|
|
|
|
+[](https://ci-apps.yunohost.org/ci/apps/homarr/)
|
|
|
|
|
|
|
|
-Homarr is a simple and lightweight homepage for your server, that helps you easily access all of your services in one place.
|
|
|
|
|
-It integrates with the services you use to display information on the homepage (E.g. Show upcoming Sonarr/Radarr releases).
|
|
|
|
|
|
|
+🛠️ Upstream Homarr repository: <https://github.com/homarr-labs/homarr>
|
|
|
|
|
|
|
|
-### Features
|
|
|
|
|
|
|
+Pull request are welcome and should target the [`testing` branch](https://github.com/YunoHost-Apps/homarr_ynh/tree/testing).
|
|
|
|
|
|
|
|
-- Integrates with services you use.
|
|
|
|
|
-- Search the web directly from your homepage.
|
|
|
|
|
-- Real-time status indicator for every service.
|
|
|
|
|
-- Automatically finds icons while you type the name of a service.
|
|
|
|
|
-- Widgets that can display all types of information.
|
|
|
|
|
-- Very light-weight and fast.
|
|
|
|
|
-
|
|
|
|
|
-
|
|
|
|
|
-**Shipped version:** 1.8.0~ynh1
|
|
|
|
|
-
|
|
|
|
|
-**Demo:** <https://homarr.ajnart.fr/fr>
|
|
|
|
|
-
|
|
|
|
|
-## Screenshots
|
|
|
|
|
-
|
|
|
|
|
-
|
|
|
|
|
-
|
|
|
|
|
-## Documentation and resources
|
|
|
|
|
-
|
|
|
|
|
-- Official app website: <https://homarr.dev/>
|
|
|
|
|
-- Official user documentation: <https://homarr.dev/docs/about>
|
|
|
|
|
-- Official admin documentation: <https://homarr.dev/docs/about>
|
|
|
|
|
-- Upstream app code repository: <https://github.com/homarr-labs/homarr>
|
|
|
|
|
-- YunoHost Store: <https://apps.yunohost.org/app/homarr>
|
|
|
|
|
-- Report a bug: <https://github.com/YunoHost-Apps/homarr_ynh/issues>
|
|
|
|
|
-
|
|
|
|
|
-## Developer info
|
|
|
|
|
-
|
|
|
|
|
-Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/homarr_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/homarr_ynh/tree/testing
|
|
|
|
|
|
|
|
-```bash
|
|
|
|
|
-sudo yunohost app install https://github.com/YunoHost-Apps/homarr_ynh/tree/testing --debug
|
|
|
|
|
-or
|
|
|
|
|
-sudo yunohost app upgrade homarr -u https://github.com/YunoHost-Apps/homarr_ynh/tree/testing --debug
|
|
|
|
|
|
|
+# upgrade an existing install:
|
|
|
|
|
+sudo yunohost app upgrade homarr -u https://github.com/YunoHost-Apps/homarr_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.
|