2022-12-28 22:35:57 +01:00
|
|
|
<!--
|
|
|
|
|
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.
|
|
|
|
|
-->
|
|
|
|
|
|
2022-12-28 22:36:02 +01:00
|
|
|
# Homarr for YunoHost
|
2022-12-28 22:35:57 +01:00
|
|
|
|
2023-02-15 09:26:05 +01:00
|
|
|
[](https://dash.yunohost.org/appci/app/homarr)  
|
|
|
|
|
|
2022-12-28 22:36:02 +01:00
|
|
|
[](https://install-app.yunohost.org/?app=homarr)
|
2022-12-28 22:35:57 +01:00
|
|
|
|
|
|
|
|
*[Lire ce readme en français.](./README_fr.md)*
|
|
|
|
|
|
2022-12-28 22:36:02 +01:00
|
|
|
> *This package allows you to install Homarr quickly and simply on a YunoHost server.
|
2022-12-28 22:35:57 +01:00
|
|
|
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
|
|
|
|
|
|
|
|
|
|
## Overview
|
|
|
|
|
|
2022-12-28 22:40:36 +01:00
|
|
|
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).
|
2022-12-28 22:35:57 +01:00
|
|
|
|
2022-12-29 17:12:10 +01:00
|
|
|
### Features
|
2022-12-28 22:35:57 +01:00
|
|
|
|
2022-12-28 22:45:58 +01:00
|
|
|
- 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.
|
2022-12-28 22:35:57 +01:00
|
|
|
|
|
|
|
|
|
2023-09-09 06:16:20 +02:00
|
|
|
**Shipped version:** 0.13.4~ynh1
|
2022-12-28 22:35:57 +01:00
|
|
|
|
2022-12-28 22:45:58 +01:00
|
|
|
**Demo:** https://homarr.ajnart.fr/fr
|
2022-12-28 22:35:57 +01:00
|
|
|
|
|
|
|
|
## Screenshots
|
|
|
|
|
|
2022-12-28 22:40:36 +01:00
|
|
|
|
2022-12-28 22:35:57 +01:00
|
|
|
|
|
|
|
|
## Documentation and resources
|
|
|
|
|
|
2022-12-28 22:36:02 +01:00
|
|
|
* Official app website: <https://homarr.dev/>
|
2022-12-28 22:45:58 +01:00
|
|
|
* Official user documentation: <https://homarr.dev/docs/about>
|
|
|
|
|
* Official admin documentation: <https://homarr.dev/docs/about>
|
2022-12-28 22:36:02 +01:00
|
|
|
* Upstream app code repository: <https://github.com/ajnart/homarr>
|
2023-10-31 15:15:08 +01:00
|
|
|
* YunoHost Store: <https://apps.yunohost.org/app/homarr>
|
2022-12-28 22:36:02 +01:00
|
|
|
* Report a bug: <https://github.com/YunoHost-Apps/homarr_ynh/issues>
|
2022-12-28 22:35:57 +01:00
|
|
|
|
|
|
|
|
## Developer info
|
|
|
|
|
|
2022-12-28 22:36:02 +01:00
|
|
|
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/homarr_ynh/tree/testing).
|
2022-12-28 22:35:57 +01:00
|
|
|
|
|
|
|
|
To try the testing branch, please proceed like that.
|
|
|
|
|
|
|
|
|
|
``` bash
|
2022-12-28 22:36:02 +01:00
|
|
|
sudo yunohost app install https://github.com/YunoHost-Apps/homarr_ynh/tree/testing --debug
|
2022-12-28 22:35:57 +01:00
|
|
|
or
|
2022-12-28 22:36:02 +01:00
|
|
|
sudo yunohost app upgrade homarr -u https://github.com/YunoHost-Apps/homarr_ynh/tree/testing --debug
|
2022-12-28 22:35:57 +01:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
|
