<h1 align="center">
- width="180"
- alt="Homer's donut"
- src="https://raw.githubusercontent.com//bastienwirtz/homer/main/public/logo.png">
+ <img
+ width="180"
+ alt="Homer's donut"
+ src="https://raw.githubusercontent.com//bastienwirtz/homer/main/public/logo.png">
<br/>
Homer
</h1>
<h4 align="center">
- A dead simple static <strong>HOM</strong>epage for your serv<strong>ER</strong> to keep your services on hand, from a simple <code>yaml</code> configuration file.
+ A dead simple static <strong>HOM</strong>epage for your serv<strong>ER</strong> to keep your services on hand, from a simple <code>yaml</code> configuration file.
</h4>
<p align="center">
- <strong>
-
<a href="https://homer-demo.netlify.app">Demo</a>
- •
-
<a href="https://gitter.im/homer-dashboard/community">Chat</a>
- •
-
<a href="#getting-started">Getting started</a>
- </strong>
+ <strong>
+ <a href="https://homer-demo.netlify.app">Demo</a>
+ •
+ <a href="https://gitter.im/homer-dashboard/community">Chat</a>
+ •
+ <a href="#getting-started">Getting started</a>
+ </strong>
</p>
<p align="center">
-
<a href="https://opensource.org/licenses/Apache-2.0"><img
- alt="License: Apache 2"
- src="https://img.shields.io/badge/License-Apache%202.0-blue.svg"></a>
+ <a href="https://opensource.org/licenses/Apache-2.0"><img
+ alt="License: Apache 2"
+ src="https://img.shields.io/badge/License-Apache%202.0-blue.svg"></a>
<a href="https://gitter.im/homer-dashboard/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge"><img
- alt="Gitter chat"
- src="https://badges.gitter.im/homer-dashboard/community.svg"></a>
+ alt="Gitter chat"
+ src="https://badges.gitter.im/homer-dashboard/community.svg"></a>
<a href="https://github.com/bastienwirtz/homer/releases/latest/download/homer.zip"><img
- alt="Download homer static build"
- src="https://img.shields.io/badge/Download-homer.zip-orange"></a>
-
<a href="https://github.com/awesome-selfhosted/awesome-selfhosted"><img
- alt="Awesome"
- src="https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg"></a>
+ alt="Download homer static build"
+ src="https://img.shields.io/badge/Download-homer.zip-orange"></a>
+ <a href="https://github.com/awesome-selfhosted/awesome-selfhosted"><img
+ alt="Awesome"
+ src="https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg"></a>
</p>
<p align="center">
-
<img src="https://raw.github.com/bastienwirtz/homer/main/docs/screenshot.png" width="100%">
+ <img src="https://raw.github.com/bastienwirtz/homer/main/docs/screenshot.png" width="100%">
</p>
## Table of Contents
+
- [Features](#features)
- [Getting started](#getting-started)
- [Configuration](docs/configuration.md)
## Features
+
- [yaml](http://yaml.org/) file configuration
- Installable (pwa)
- Search
- Grouping
- Theme customization
-- Offline heathcheck
+- Offline heath check
- 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.
-
## Getting started
Homer is a full static html/js dashboard, generated from the source in `/src` using webpack. It's meant to be served by an HTTP server, **it will not work if you open dist/index.html directly over file:// protocol**.
### Using the release tarball (prebuilt, ready to use)
-Download and extract the latest release (`homer.zip`) from the [release page](https://github.com/bastienwirtz/homer/releases), rename the `assets/config.yml.dist` file to `assets/config.yml`, and put it behind a webserver.
+Download and extract the latest release (`homer.zip`) from the [release page](https://github.com/bastienwirtz/homer/releases), rename the `assets/config.yml.dist` file to `assets/config.yml`, and put it behind a web server.
```sh
wget https://github.com/bastienwirtz/homer/releases/latest/download/homer.zip
-## Configuration
+# Configuration
Title, icons, links, colors, and services can be configured in the `config.yml` file (located in `/assets` directory once built, or in the `public/assets` directory in development mode), using [yaml](http://yaml.org/) format.
# background: red # optional color for card to set color directly without custom stylesheet
```
-
View [Custom Services](customservices.md) for details about all available custom services (like PiHole) and how to configure them.
If you choose to fetch message information from an endpoint, the output format should be as follows (or you can [custom map fields as shown in tips-and-tricks](./tips-and-tricks.md#mapping-fields)):
`null` value or missing keys will be ignored and value from the `config.yml` will be used if available.
Empty values (either in `config.yml` or the endpoint data) will hide the element (ex: set `"title": ""` to hide the title bar).
-### Style Options
+## Style Options
Homer uses [bulma CSS](https://bulma.io/), which provides a [modifiers syntax](https://bulma.io/documentation/modifiers/syntax/). You'll notice in the config there is a `tagstyle` option. It can be set to any of the bulma modifiers. You'll probably want to use one of these 4 main colors:
You can read the [bulma modifiers page](https://bulma.io/documentation/modifiers/syntax/) for other options regarding size, style, or state.
-### PWA Icons
+## PWA Icons
In order to easily generate all required icon preset for the PWA to work, a tool like [vue-pwa-asset-generator](https://www.npmjs.com/package/vue-pwa-asset-generator) can be used:
npx vue-pwa-asset-generator -a {your_512x512_source_png} -o {your_output_folder}
```
-### Supported services
+## Supported services
Currently the following services are supported for showing quick infos on the card. They can be used by setting the type to one of the following values at the item.
- PaperlessNG
- Mealie
-### Additional configuration
+## Additional configuration
+
+### Paperless
-#### Paperless
For Paperless you need an API-Key which you have to store at the item in the field `apikey`.
-#### Mealie
+### Mealie
+
First off make sure to remove an existing `subtitle` as it will take precedence if set. Setting `type: "Mealie"` will then show the number of recipes Mealie is keeping organized or the planned meal for today if one is planned. You will have to set an API key in the field `apikey` which can be created in your Mealie installation.
# Custom Services
Some service can use a specific a component that provides some extra features by adding a `type` key to the service yaml
-configuration. Available services are in `src/components/`. Here is an overview of all custom services that are available
+configuration. Available services are in `src/components/`. Here is an overview of all custom services that are available
within Homer.
## PiHole
The following configuration is available for the PiHole service.
-```
+```yaml
items:
- name: "Pi-hole"
logo: "assets/tools/sample.png"
type: "PiHole"
```
-
## OpenWeatherMap
Using the OpenWeatherMap service you can display weather information about a given location.
The following configuration is available for the OpenWeatherMap service:
-```
+```yaml
items:
- name: "Weather"
location: "Amsterdam" # your location.
**Remarks:**
If for some reason your city can't be found by entering the name in the `location` property, you could also try to configure the OWM city ID in the `locationId` property. To retrieve your specific City ID, go to the [OWM website](https://openweathermap.org), search for your city and retrieve the ID from the URL (for example, the City ID of Amsterdam is 2759794).
-
## Medusa
This service displays News (grey), Warning (orange) or Error (red) notifications bubbles from the Medusa application.
Two lines are needed in the config.yml :
-```
+
+```yaml
type: "Medusa"
apikey: "01234deb70424befb1f4ef6a23456789"
```
+
The url must be the root url of Medusa application.
The Medusa API key can be found in General configuration > Interface. It is needed to access Medusa API.
-
## Sonarr/Radarr
This service displays Activity (blue), Warning (orange) or Error (red) notifications bubbles from the Radarr/Sonarr application.
Two lines are needed in the config.yml :
-```
+
+```yaml
type: "Radarr" or "Sonarr"
apikey: "01234deb70424befb1f4ef6a23456789"
```
+
The url must be the root url of Radarr/Sonarr application.
The Radarr/Sonarr API key can be found in Settings > General. It is needed to access the API.
-
## PaperlessNG
For Paperless you need an API-Key which you have to store at the item in the field `apikey`.
-
## Ping
For Ping you need an API-Key which you have to store at the item in the field `apikey`.
-## Development
+# Development
```sh
# Using yarn (recommended)
npm run serve
```
-### Themes
+## Themes
Themes are meant to be simple customization (written in [scss](https://sass-lang.com/documentation/syntax)).
To add a new theme, just add a file in the theme directory, and put all style in the `body #app.theme-<name>` scope. Then import it in the main style file.
Here is a collection of neat tips and tricks that Homer users have come up with!
## Use Homer as a custom "new tab" page
+
#### `by @vosdev`
These extensions for [Firefox](https://addons.mozilla.org/firefox/addon/custom-new-tab-page) and [Chrome & Friends](https://chrome.google.com/webstore/detail/new-tab-changer/occbjkhimchkolibngmcefpjlbknggfh) allow you to have your homer dashboard in your new tab page, while leaving focus on the address bar meaning you can still type right away if you want to search or go to a page that is not on your homer dash.
```
## YAML Anchors
+
#### `by @JamiePhonic`
Since Homer is configured using YAML, it supports all of YAML's helpful features, such as anchoring!
-For example, you can define tags and tag styles for each "item" in a service.
+For example, you can define tags and tag styles for each "item" in a service.
Using Anchoring, you can define all your tags and their styles once like this: (for example)
```yaml
Great if you have a lot of services or a lot of tags!
## Remotely edit your config with Code Server
+
#### `by @JamiePhonic`
Homer doesn't yet provide a way to edit your configuration from inside Homer itself, but that doesn't mean it can't be done!
If you're running Homer in docker, you can setup a Code-Server container and pass your homer config directory into it.
Simply pass your homer config directory as an extra -v parameter to your code-server container:
-```
+
+```sh
-v '/your/local/homer/config-dir/':'/config/homer':'rw'
```
+
This will map your homer config directory (For example, /docker/appdata/homer/) into code-server's `/config/` directory, in a sub folder called `homer`
As a bonus, Code-Server puts the "current folder" as a parameter in the URL bar, so you could add a `links:` entry in Homer that points to your code-server instance with the directory pre-filled for essentially 1 click editing!
For example:
+
```yml
links:
- name: Edit config
url: https://vscode.example.net/?folder=/config/homer
target: "_blank" # optional html tag target attribute
```
+
where the path after `?folder=` is the path to the folder where you mounted your homer config INSIDE the Code-Server container.
### Example Code-Server docker create command
+
```sh
docker create \
--name=code-server \
linuxserver/code-server
```
-
## Get the news headlines in Homer
### Mapping Fields
+
Most times, the url you're getting headlines from follows a different schema than the one expected by Homer.
-For example, if you would like to show jokes from ChuckNorris.io, you'll find that the url https://api.chucknorris.io/jokes/random is giving you info like this:
+For example, if you would like to show jokes from ChuckNorris.io, you'll find that the url <https://api.chucknorris.io/jokes/random> is giving you info like this:
```json
{
So, using [Node-Red](https://nodered.org/docs/getting-started/) and a quick flow, you can process an RSS feed to replace the message with a news item!
-To get started, simply import [this flow](https://flows.nodered.org/flow/4b6406c9a684c26ace0430dd1826e95d) into your Node-Red instance and change the RSS feed in the "Get News RSS Feed" node to one of your choosing!
+To get started, simply import [this flow](https://flows.nodered.org/flow/4b6406c9a684c26ace0430dd1826e95d) into your Node-Red instance and change the RSS feed in the "Get News RSS Feed" node to one of your choosing!
So far, the flow has been tested with BBC News and Sky News, however it should be easy to modify the flow to work with other RSS feeds if they don't work out of the box!
<template v-if="item.subtitle">
{{ item.subtitle }}
</template>
- <template v-else-if="meal">
- Today: {{ meal.name }}
- </template>
+ <template v-else-if="meal"> Today: {{ meal.name }} </template>
<template v-else-if="stats">
happily keeping {{ stats.totalRecipes }} recipes organized
</template>
methods: {
fetchStatus: async function () {
if (this.item.subtitle != null) return; // omitting unnecessary ajax call as the subtitle is showing
- var apikey = this.item.apikey;
this.meal = await fetch(`${this.item.url}/api/meal-plans/today/`, {
headers: {
- "Authorization": "Bearer " + this.item.apikey,
- "Accept": "application/json"
- }
+ Authorization: "Bearer " + this.item.apikey,
+ Accept: "application/json",
+ },
})
- .then(function(response) {
- if (!response.ok) {
- throw new Error("Not 2xx response")
- } else {
- if (response != null) {
- return response.json();
+ .then(function (response) {
+ if (!response.ok) {
+ throw new Error("Not 2xx response");
+ } else {
+ if (response != null) {
+ return response.json();
+ }
}
- }
- })
- .catch((e) => console.log(e));
+ })
+ .catch((e) => console.log(e));
this.stats = await fetch(`${this.item.url}/api/debug/statistics/`, {
headers: {
- "Authorization": "Bearer " + this.item.apikey,
- "Accept": "application/json"
- }
+ Authorization: "Bearer " + this.item.apikey,
+ Accept: "application/json",
+ },
})
- .then(function(response) {
- if (!response.ok) {
- throw new Error("Not 2xx response")
- } else {
- return response.json();
- }
- })
- .catch((e) => console.log(e));
+ .then(function (response) {
+ if (!response.ok) {
+ throw new Error("Not 2xx response");
+ } else {
+ return response.json();
+ }
+ })
+ .catch((e) => console.log(e));
},
},
};
projects / github / bastienwirtz / homer.git / commitdiff
