An open API service indexing awesome lists of open source software.

https://github.com/yunohost-apps/homer_ynh

Homer package for YunoHost
https://github.com/yunohost-apps/homer_ynh

homer yunohost yunohost-apps

Last synced: 3 months ago
JSON representation

Homer package for YunoHost

Awesome Lists containing this project

README

          

# Homer for YunoHost

[![Integration level](https://dash.yunohost.org/integration/homer.svg)](https://dash.yunohost.org/appci/app/homer) ![](https://ci-apps.yunohost.org/ci/badges/homer.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/homer.maintain.svg)
[![Install Homer with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=homer)

*[Lire ce readme en français.](./README_fr.md)*

> *This package allows you to install Homer 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

A very simple static homepage for your server.

### Features

- yaml file configuration
- Search
- Grouping
- Theme customization
- Offline heathcheck
- keyboard shortcuts:
- `/` Start searching.
- `Escape` Stop searching.
- `Enter` Open the first matching result (respects the bookmark's _target property).
- `Alt`/`Option` + `Enter` Open the first matching result in a new tab.

**Shipped version:** 21.09.2~ynh1

**Demo:** https://homer-demo.netlify.app/

## Screenshots

![](./doc/screenshots/homer.webp)

## Disclaimers / important information

* Every user has the same dashboard, there's no per-user configuration

## Documentation and resources

* Official app website: https://github.com/bastienwirtz/homer
* Official user documentation: https://github.com/bastienwirtz/homer/blob/main/docs/configuration.md
* Official admin documentation: https://github.com/bastienwirtz/homer/blob/main/docs/configuration.md
* Upstream app code repository: https://github.com/bastienwirtz/homer
* YunoHost documentation for this app: https://yunohost.org/app_homer
* Report a bug: https://github.com/YunoHost-Apps/homer_ynh/issues

## Developer info

Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/homer_ynh/tree/testing).

To try the testing branch, please proceed like that.
```
sudo yunohost app install https://github.com/YunoHost-Apps/homer_ynh/tree/testing --debug
or
sudo yunohost app upgrade homer -u https://github.com/YunoHost-Apps/homer_ynh/tree/testing --debug
```

**More info regarding app packaging:** https://yunohost.org/packaging_apps