aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
-rw-r--r--Dockerfile3
-rw-r--r--Dockerfile.arm32v73
-rw-r--r--Dockerfile.arm64v83
-rw-r--r--README.md55
-rw-r--r--docs/configuration.md29
-rw-r--r--docs/customservices.md36
-rw-r--r--docs/development.md4
-rw-r--r--docs/tips-and-tricks.md18
-rw-r--r--docs/troubleshooting.md19
-rw-r--r--src/components/services/AdGuardHome.vue54
-rw-r--r--src/components/services/Mealie.vue94
-rw-r--r--src/components/services/OpenWeather.vue135
-rw-r--r--src/components/services/Radarr.vue8
-rw-r--r--src/components/services/Sonarr.vue8
14 files changed, 412 insertions, 57 deletions
diff --git a/Dockerfile b/Dockerfile
index 19d01f8..d7179fc 100644
--- a/Dockerfile
+++ b/Dockerfile
@@ -25,6 +25,9 @@ COPY --from=build-stage --chown=${USER}:${GROUP} /app/dist /www/
25COPY --from=build-stage --chown=${USER}:${GROUP} /app/dist/assets /www/default-assets 25COPY --from=build-stage --chown=${USER}:${GROUP} /app/dist/assets /www/default-assets
26COPY entrypoint.sh /entrypoint.sh 26COPY entrypoint.sh /entrypoint.sh
27 27
28HEALTHCHECK --interval=5s --timeout=5s --retries=3 \
29 CMD wget --no-verbose --tries=1 --spider http://127.0.0.1:${PORT}/ || exit 1
30
28EXPOSE ${PORT} 31EXPOSE ${PORT}
29VOLUME /www/assets 32VOLUME /www/assets
30ENTRYPOINT ["/bin/sh", "/entrypoint.sh"] 33ENTRYPOINT ["/bin/sh", "/entrypoint.sh"]
diff --git a/Dockerfile.arm32v7 b/Dockerfile.arm32v7
index 3efb5aa..1621abb 100644
--- a/Dockerfile.arm32v7
+++ b/Dockerfile.arm32v7
@@ -35,6 +35,9 @@ COPY --from=build-stage --chown=${USER}:${GROUP} /app/dist /www/
35COPY --from=build-stage --chown=${USER}:${GROUP} /app/dist/assets /www/default-assets 35COPY --from=build-stage --chown=${USER}:${GROUP} /app/dist/assets /www/default-assets
36COPY entrypoint.sh /entrypoint.sh 36COPY entrypoint.sh /entrypoint.sh
37 37
38HEALTHCHECK --interval=5s --timeout=5s --retries=3 \
39 CMD wget --no-verbose --tries=1 --spider http://127.0.0.1:${PORT}/ || exit 1
40
38EXPOSE ${PORT} 41EXPOSE ${PORT}
39VOLUME /www/assets 42VOLUME /www/assets
40ENTRYPOINT ["/bin/sh", "/entrypoint.sh"] 43ENTRYPOINT ["/bin/sh", "/entrypoint.sh"]
diff --git a/Dockerfile.arm64v8 b/Dockerfile.arm64v8
index e6d0a51..fe35ede 100644
--- a/Dockerfile.arm64v8
+++ b/Dockerfile.arm64v8
@@ -35,6 +35,9 @@ COPY --from=build-stage --chown=${USER}:${GROUP} /app/dist /www/
35COPY --from=build-stage --chown=${USER}:${GROUP} /app/dist/assets /www/default-assets 35COPY --from=build-stage --chown=${USER}:${GROUP} /app/dist/assets /www/default-assets
36COPY entrypoint.sh /entrypoint.sh 36COPY entrypoint.sh /entrypoint.sh
37 37
38HEALTHCHECK --interval=5s --timeout=5s --retries=3 \
39 CMD wget --no-verbose --tries=1 --spider http://127.0.0.1:${PORT}/ || exit 1
40
38EXPOSE ${PORT} 41EXPOSE ${PORT}
39VOLUME /www/assets 42VOLUME /www/assets
40ENTRYPOINT ["/bin/sh", "/entrypoint.sh"] 43ENTRYPOINT ["/bin/sh", "/entrypoint.sh"]
diff --git a/README.md b/README.md
index 9441798..2dd2b42 100644
--- a/README.md
+++ b/README.md
@@ -1,67 +1,68 @@
1<h1 align="center"> 1<h1 align="center">
2 <img 2 <img
3 width="180" 3 width="180"
4 alt="Homer's donut" 4 alt="Homer's donut"
5 src="https://raw.githubusercontent.com//bastienwirtz/homer/main/public/logo.png"> 5 src="https://raw.githubusercontent.com//bastienwirtz/homer/main/public/logo.png">
6 <br/> 6 <br/>
7 Homer 7 Homer
8</h1> 8</h1>
9 9
10<h4 align="center"> 10<h4 align="center">
11 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. 11 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.
12</h4> 12</h4>
13 13
14<p align="center"> 14<p align="center">
15 <strong> 15 <strong>
16 <a href="https://homer-demo.netlify.app">Demo</a> 16 <a href="https://homer-demo.netlify.app">Demo</a>
17 17
18 <a href="https://gitter.im/homer-dashboard/community">Chat</a> 18 <a href="https://gitter.im/homer-dashboard/community">Chat</a>
19 19
20 <a href="#getting-started">Getting started</a> 20 <a href="#getting-started">Getting started</a>
21 </strong> 21 </strong>
22</p> 22</p>
23<p align="center"> 23<p align="center">
24 <a href="https://opensource.org/licenses/Apache-2.0"><img 24 <a href="https://opensource.org/licenses/Apache-2.0"><img
25 alt="License: Apache 2" 25 alt="License: Apache 2"
26 src="https://img.shields.io/badge/License-Apache%202.0-blue.svg"></a> 26 src="https://img.shields.io/badge/License-Apache%202.0-blue.svg"></a>
27 <a href="https://gitter.im/homer-dashboard/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge"><img 27 <a href="https://gitter.im/homer-dashboard/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge"><img
28 alt="Gitter chat" 28 alt="Gitter chat"
29 src="https://badges.gitter.im/homer-dashboard/community.svg"></a> 29 src="https://badges.gitter.im/homer-dashboard/community.svg"></a>
30 <a href="https://github.com/bastienwirtz/homer/releases/latest/download/homer.zip"><img 30 <a href="https://github.com/bastienwirtz/homer/releases/latest/download/homer.zip"><img
31 alt="Download homer static build" 31 alt="Download homer static build"
32 src="https://img.shields.io/badge/Download-homer.zip-orange"></a> 32 src="https://img.shields.io/badge/Download-homer.zip-orange"></a>
33 <a href="https://github.com/awesome-selfhosted/awesome-selfhosted"><img 33 <a href="https://github.com/awesome-selfhosted/awesome-selfhosted"><img
34 alt="Awesome" 34 alt="Awesome"
35 src="https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg"></a> 35 src="https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg"></a>
36</p> 36</p>
37 37
38<p align="center"> 38<p align="center">
39 <img src="https://raw.github.com/bastienwirtz/homer/main/docs/screenshot.png" width="100%"> 39 <img src="https://raw.github.com/bastienwirtz/homer/main/docs/screenshot.png" width="100%">
40</p> 40</p>
41 41
42## Table of Contents 42## Table of Contents
43
43- [Features](#features) 44- [Features](#features)
44- [Getting started](#getting-started) 45- [Getting started](#getting-started)
45- [Configuration](docs/configuration.md) 46- [Configuration](docs/configuration.md)
46- [Custom services](docs/customservices.md) 47- [Custom services](docs/customservices.md)
47- [Tips & tricks](docs/tips-and-tricks.md) 48- [Tips & tricks](docs/tips-and-tricks.md)
48- [Development](docs/development.md) 49- [Development](docs/development.md)
49 50- [Troubleshooting](docs/troubleshooting.md)
50 51
51## Features 52## Features
53
52- [yaml](http://yaml.org/) file configuration 54- [yaml](http://yaml.org/) file configuration
53- Installable (pwa) 55- Installable (pwa)
54- Search 56- Search
55- Grouping 57- Grouping
56- Theme customization 58- Theme customization
57- Offline heathcheck 59- Offline heath check
58- keyboard shortcuts: 60- keyboard shortcuts:
59 - `/` Start searching. 61 - `/` Start searching.
60 - `Escape` Stop searching. 62 - `Escape` Stop searching.
61 - `Enter` Open the first matching result (respects the bookmark's `_target` property). 63 - `Enter` Open the first matching result (respects the bookmark's `_target` property).
62 - `Alt`/`Option` + `Enter` Open the first matching result in a new tab. 64 - `Alt`/`Option` + `Enter` Open the first matching result in a new tab.
63 65
64
65## Getting started 66## Getting started
66 67
67Homer 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**. 68Homer 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**.
@@ -111,7 +112,7 @@ environment:
111 112
112### Using the release tarball (prebuilt, ready to use) 113### Using the release tarball (prebuilt, ready to use)
113 114
114Download 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. 115Download 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.
115 116
116```sh 117```sh
117wget https://github.com/bastienwirtz/homer/releases/latest/download/homer.zip 118wget https://github.com/bastienwirtz/homer/releases/latest/download/homer.zip
diff --git a/docs/configuration.md b/docs/configuration.md
index a472b41..d90981a 100644
--- a/docs/configuration.md
+++ b/docs/configuration.md
@@ -1,4 +1,4 @@
1## Configuration 1# Configuration
2 2
3Title, 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. 3Title, 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.
4 4
@@ -7,7 +7,7 @@ Title, icons, links, colors, and services can be configured in the `config.yml`
7# Homepage configuration 7# Homepage configuration
8# See https://fontawesome.com/icons for icons options 8# See https://fontawesome.com/icons for icons options
9 9
10# Optional: Use external configuration file. 10# Optional: Use external configuration file.
11# Using this will ignore remaining config in this file 11# Using this will ignore remaining config in this file
12# externalConfig: https://example.com/server-luci/config.yaml 12# externalConfig: https://example.com/server-luci/config.yaml
13 13
@@ -136,6 +136,8 @@ services:
136 # background: red # optional color for card to set color directly without custom stylesheet 136 # background: red # optional color for card to set color directly without custom stylesheet
137``` 137```
138 138
139View [Custom Services](customservices.md) for details about all available custom services (like PiHole) and how to configure them.
140
139If 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)): 141If 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)):
140 142
141```json 143```json
@@ -149,7 +151,7 @@ If you choose to fetch message information from an endpoint, the output format s
149`null` value or missing keys will be ignored and value from the `config.yml` will be used if available. 151`null` value or missing keys will be ignored and value from the `config.yml` will be used if available.
150Empty values (either in `config.yml` or the endpoint data) will hide the element (ex: set `"title": ""` to hide the title bar). 152Empty values (either in `config.yml` or the endpoint data) will hide the element (ex: set `"title": ""` to hide the title bar).
151 153
152### Style Options 154## Style Options
153 155
154Homer 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: 156Homer 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:
155 157
@@ -160,10 +162,29 @@ Homer uses [bulma CSS](https://bulma.io/), which provides a [modifiers syntax](h
160 162
161You can read the [bulma modifiers page](https://bulma.io/documentation/modifiers/syntax/) for other options regarding size, style, or state. 163You can read the [bulma modifiers page](https://bulma.io/documentation/modifiers/syntax/) for other options regarding size, style, or state.
162 164
163### PWA Icons 165## PWA Icons
164 166
165In 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: 167In 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:
166 168
167```bash 169```bash
168npx vue-pwa-asset-generator -a {your_512x512_source_png} -o {your_output_folder} 170npx vue-pwa-asset-generator -a {your_512x512_source_png} -o {your_output_folder}
169``` 171```
172
173## Supported services
174
175Currently 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.
176
177- PiHole
178- AdGuardHome
179- PaperlessNG
180- Mealie
181
182## Additional configuration
183
184### Paperless
185
186For Paperless you need an API-Key which you have to store at the item in the field `apikey`.
187
188### Mealie
189
190First 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.
diff --git a/docs/customservices.md b/docs/customservices.md
index 5778fad..4a023a1 100644
--- a/docs/customservices.md
+++ b/docs/customservices.md
@@ -1,16 +1,18 @@
1# Custom Services 1# Custom Services
2 2
3Some service can use a specific a component that provides some extra features by adding a `type` key to the service yaml 3Some service can use a specific a component that provides some extra features by adding a `type` key to the service yaml
4configuration. Available services are in `src/components/`. Here is an overview of all custom services that are available 4configuration. Available services are in `src/components/`. Here is an overview of all custom services that are available
5within Homer. 5within Homer.
6 6
7If you experiencing any issue, please have a look to the [troubleshooting](troubleshooting.md) page.
8
7## PiHole 9## PiHole
8 10
9Using the PiHole service you can display info about your local PiHole instance right on your Homer dashboard. 11Using the PiHole service you can display info about your local PiHole instance right on your Homer dashboard.
10 12
11The following configuration is available for the PiHole service. 13The following configuration is available for the PiHole service.
12 14
13``` 15```yaml
14 items: 16 items:
15 - name: "Pi-hole" 17 - name: "Pi-hole"
16 logo: "assets/tools/sample.png" 18 logo: "assets/tools/sample.png"
@@ -19,35 +21,55 @@ The following configuration is available for the PiHole service.
19 type: "PiHole" 21 type: "PiHole"
20``` 22```
21 23
24## OpenWeatherMap
25
26Using the OpenWeatherMap service you can display weather information about a given location.
27The following configuration is available for the OpenWeatherMap service:
28
29```yaml
30items:
31 - name: "Weather"
32 location: "Amsterdam" # your location.
33 locationId: "2759794" # Optional: Specify OpenWeatherMap city ID for better accuracy
34 apiKey: "<---insert-api-key-here--->" # insert your own API key here. Request one from https://openweathermap.org/api.
35 units: "metric" # units to display temperature. Can be one of: metric, imperial, kelvin. Defaults to kelvin.
36 background: "square" # choose which type of background you want behind the image. Can be one of: square, cicle, none. Defaults to none.
37 type: "OpenWeather"
38```
39
40**Remarks:**
41If 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).
42
22## Medusa 43## Medusa
23 44
24This service displays News (grey), Warning (orange) or Error (red) notifications bubbles from the Medusa application. 45This service displays News (grey), Warning (orange) or Error (red) notifications bubbles from the Medusa application.
25Two lines are needed in the config.yml : 46Two lines are needed in the config.yml :
26``` 47
48```yaml
27type: "Medusa" 49type: "Medusa"
28apikey: "01234deb70424befb1f4ef6a23456789" 50apikey: "01234deb70424befb1f4ef6a23456789"
29``` 51```
52
30The url must be the root url of Medusa application. 53The url must be the root url of Medusa application.
31The Medusa API key can be found in General configuration > Interface. It is needed to access Medusa API. 54The Medusa API key can be found in General configuration > Interface. It is needed to access Medusa API.
32 55
33
34## Sonarr/Radarr 56## Sonarr/Radarr
35 57
36This service displays Activity (blue), Warning (orange) or Error (red) notifications bubbles from the Radarr/Sonarr application. 58This service displays Activity (blue), Warning (orange) or Error (red) notifications bubbles from the Radarr/Sonarr application.
37Two lines are needed in the config.yml : 59Two lines are needed in the config.yml :
38``` 60
61```yaml
39type: "Radarr" or "Sonarr" 62type: "Radarr" or "Sonarr"
40apikey: "01234deb70424befb1f4ef6a23456789" 63apikey: "01234deb70424befb1f4ef6a23456789"
41``` 64```
65
42The url must be the root url of Radarr/Sonarr application. 66The url must be the root url of Radarr/Sonarr application.
43The Radarr/Sonarr API key can be found in Settings > General. It is needed to access the API. 67The Radarr/Sonarr API key can be found in Settings > General. It is needed to access the API.
44 68
45
46## PaperlessNG 69## PaperlessNG
47 70
48For Paperless you need an API-Key which you have to store at the item in the field `apikey`. 71For Paperless you need an API-Key which you have to store at the item in the field `apikey`.
49 72
50
51## Ping 73## Ping
52 74
53For Ping you need an API-Key which you have to store at the item in the field `apikey`. 75For Ping you need an API-Key which you have to store at the item in the field `apikey`.
diff --git a/docs/development.md b/docs/development.md
index f2e9020..5e432f1 100644
--- a/docs/development.md
+++ b/docs/development.md
@@ -1,4 +1,4 @@
1## Development 1# Development
2 2
3```sh 3```sh
4# Using yarn (recommended) 4# Using yarn (recommended)
@@ -10,7 +10,7 @@ npm install
10npm run serve 10npm run serve
11``` 11```
12 12
13### Themes 13## Themes
14 14
15Themes are meant to be simple customization (written in [scss](https://sass-lang.com/documentation/syntax)). 15Themes are meant to be simple customization (written in [scss](https://sass-lang.com/documentation/syntax)).
16To 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. 16To 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.
diff --git a/docs/tips-and-tricks.md b/docs/tips-and-tricks.md
index 94167fb..17bba9a 100644
--- a/docs/tips-and-tricks.md
+++ b/docs/tips-and-tricks.md
@@ -3,6 +3,7 @@
3Here is a collection of neat tips and tricks that Homer users have come up with! 3Here is a collection of neat tips and tricks that Homer users have come up with!
4 4
5## Use Homer as a custom "new tab" page 5## Use Homer as a custom "new tab" page
6
6#### `by @vosdev` 7#### `by @vosdev`
7 8
8These 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. 9These 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.
@@ -22,11 +23,12 @@ The Firefox extension loads Homer in an iframe on your new tab page, meaning you
22``` 23```
23 24
24## YAML Anchors 25## YAML Anchors
26
25#### `by @JamiePhonic` 27#### `by @JamiePhonic`
26 28
27Since Homer is configured using YAML, it supports all of YAML's helpful features, such as anchoring! 29Since Homer is configured using YAML, it supports all of YAML's helpful features, such as anchoring!
28 30
29For example, you can define tags and tag styles for each "item" in a service. 31For example, you can define tags and tag styles for each "item" in a service.
30Using Anchoring, you can define all your tags and their styles once like this: (for example) 32Using Anchoring, you can define all your tags and their styles once like this: (for example)
31 33
32```yaml 34```yaml
@@ -70,6 +72,7 @@ The end result is that if you want to update the name or style of any particular
70Great if you have a lot of services or a lot of tags! 72Great if you have a lot of services or a lot of tags!
71 73
72## Remotely edit your config with Code Server 74## Remotely edit your config with Code Server
75
73#### `by @JamiePhonic` 76#### `by @JamiePhonic`
74 77
75Homer doesn't yet provide a way to edit your configuration from inside Homer itself, but that doesn't mean it can't be done! 78Homer doesn't yet provide a way to edit your configuration from inside Homer itself, but that doesn't mean it can't be done!
@@ -78,14 +81,17 @@ You can setup and use [Code-Server](https://github.com/cdr/code-server) to edit
78 81
79If you're running Homer in docker, you can setup a Code-Server container and pass your homer config directory into it. 82If you're running Homer in docker, you can setup a Code-Server container and pass your homer config directory into it.
80Simply pass your homer config directory as an extra -v parameter to your code-server container: 83Simply pass your homer config directory as an extra -v parameter to your code-server container:
81``` 84
85```sh
82-v '/your/local/homer/config-dir/':'/config/homer':'rw' 86-v '/your/local/homer/config-dir/':'/config/homer':'rw'
83``` 87```
88
84This will map your homer config directory (For example, /docker/appdata/homer/) into code-server's `/config/` directory, in a sub folder called `homer` 89This will map your homer config directory (For example, /docker/appdata/homer/) into code-server's `/config/` directory, in a sub folder called `homer`
85 90
86As 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! 91As 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!
87 92
88For example: 93For example:
94
89```yml 95```yml
90links: 96links:
91 - name: Edit config 97 - name: Edit config
@@ -93,9 +99,11 @@ links:
93 url: https://vscode.example.net/?folder=/config/homer 99 url: https://vscode.example.net/?folder=/config/homer
94 target: "_blank" # optional html tag target attribute 100 target: "_blank" # optional html tag target attribute
95``` 101```
102
96where the path after `?folder=` is the path to the folder where you mounted your homer config INSIDE the Code-Server container. 103where the path after `?folder=` is the path to the folder where you mounted your homer config INSIDE the Code-Server container.
97 104
98### Example Code-Server docker create command 105### Example Code-Server docker create command
106
99```sh 107```sh
100docker create \ 108docker create \
101 --name=code-server \ 109 --name=code-server \
@@ -111,13 +119,13 @@ docker create \
111 linuxserver/code-server 119 linuxserver/code-server
112``` 120```
113 121
114
115## Get the news headlines in Homer 122## Get the news headlines in Homer
116 123
117### Mapping Fields 124### Mapping Fields
125
118Most times, the url you're getting headlines from follows a different schema than the one expected by Homer. 126Most times, the url you're getting headlines from follows a different schema than the one expected by Homer.
119 127
120For 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: 128For 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:
121 129
122```json 130```json
123{ 131{
@@ -179,6 +187,6 @@ If the URL you specified returns a JSON object that defines a `title` and `conte
179 187
180So, 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! 188So, 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!
181 189
182To 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! 190To 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!
183 191
184So 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! 192So 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!
diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md
new file mode 100644
index 0000000..ed1f85d
--- /dev/null
+++ b/docs/troubleshooting.md
@@ -0,0 +1,19 @@
1# Troubleshooting
2
3## My custom service card doesn't work, nothing appears or offline status is displayed (pi-hole, sonarr, ping, ...)
4
5You might by facing a [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) (Cross Origin Request Sharing) issue.
6It happens when the targeted service is hosted on a different domain or port.
7Web browsers will not allow to fetch information from a different site without explicit permissions (the targeted service
8must include a special `Access-Control-Allow-Origin: *` HTTP headers).
9If this happens your web console (`ctrl+shit+i` or `F12`) will be filled with this kind of errors:
10
11```text
12Access to fetch at 'https://<target-service>' from origin 'https://<homer>' has been blocked by CORS policy: No 'Access-Control-Allow-Origin' header is present on the requested resource. If an opaque response serves your needs, set the request's mode to 'no-cors' to fetch the resource with CORS disabled.
13```
14
15To resolve this, you can either:
16
17* Host all your target service under the same domain & port.
18* Modify the target sever configuration so that the response of the server included following header- `Access-Control-Allow-Origin: *` (<https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#simple_requests>). It might be an option in the targeted service, otherwise depending on how the service is hosted, the proxy or web server can seamlessly add it.
19* Use a cors proxy sever like [`cors-container`](https://github.com/imjacobclark/cors-container), [`cors-anywhere`](https://github.com/Rob--W/cors-anywhere) or many others.
diff --git a/src/components/services/AdGuardHome.vue b/src/components/services/AdGuardHome.vue
index 19a2f7d..61d4bed 100644
--- a/src/components/services/AdGuardHome.vue
+++ b/src/components/services/AdGuardHome.vue
@@ -16,14 +16,17 @@
16 </div> 16 </div>
17 <div class="media-content"> 17 <div class="media-content">
18 <p class="title is-4">{{ item.name }}</p> 18 <p class="title is-4">{{ item.name }}</p>
19 <p class="subtitle is-6">{{ item.subtitle }}</p> 19 <p class="subtitle is-6">
20 <template v-if="item.subtitle">
21 {{ item.subtitle }}
22 </template>
23 <template v-else-if="stats">
24 {{ percentage }}&percnt; blocked
25 </template>
26 </p>
20 </div> 27 </div>
21 <div 28 <div class="status" :class="protection">
22 v-if="status" 29 {{ protection }}
23 class="status"
24 v-bind:class="status.protection_enabled ? 'enabled' : 'disabled'"
25 >
26 {{ status.protection_enabled }}
27 </div> 30 </div>
28 </div> 31 </div>
29 <div class="tag" :class="item.tagstyle" v-if="item.tag"> 32 <div class="tag" :class="item.tagstyle" v-if="item.tag">
@@ -44,16 +47,45 @@ export default {
44 data: () => { 47 data: () => {
45 return { 48 return {
46 status: null, 49 status: null,
50 stats: null,
47 }; 51 };
48 }, 52 },
53 computed: {
54 percentage: function () {
55 if (this.stats) {
56 return (
57 (this.stats.num_blocked_filtering * 100) /
58 this.stats.num_dns_queries
59 ).toFixed(2);
60 }
61 return "";
62 },
63 protection: function () {
64 if (this.status) {
65 return this.status.protection_enabled ? "enabled" : "disabled";
66 } else return "unknown";
67 },
68 },
49 created: function () { 69 created: function () {
50 this.fetchStatus(); 70 this.fetchStatus();
71 if (!this.item.subtitle) {
72 this.fetchStats();
73 }
51 }, 74 },
52 methods: { 75 methods: {
53 fetchStatus: async function () { 76 fetchStatus: async function () {
54 this.status = await fetch(`${this.item.url}/control/status`, { 77 this.status = await fetch(`${this.item.url}/control/status`, {
55 credentials: "include", 78 credentials: "include",
56 }).then((response) => response.json()); 79 })
80 .then((response) => response.json())
81 .catch((e) => console.log(e));
82 },
83 fetchStats: async function () {
84 this.stats = await fetch(`${this.item.url}/control/stats`, {
85 credentials: "include",
86 })
87 .then((response) => response.json())
88 .catch((e) => console.log(e));
57 }, 89 },
58 }, 90 },
59}; 91};
@@ -79,6 +111,12 @@ export default {
79 box-shadow: 0px 0px 4px 1px #c9404d; 111 box-shadow: 0px 0px 4px 1px #c9404d;
80 } 112 }
81 113
114 &.unknown:before {
115 background-color: #c9c740;
116 border-color: #ccc935;
117 box-shadow: 0px 0px 4px 1px #c9c740;
118 }
119
82 &:before { 120 &:before {
83 content: " "; 121 content: " ";
84 display: inline-block; 122 display: inline-block;
diff --git a/src/components/services/Mealie.vue b/src/components/services/Mealie.vue
new file mode 100644
index 0000000..790a9b1
--- /dev/null
+++ b/src/components/services/Mealie.vue
@@ -0,0 +1,94 @@
1<template>
2 <div>
3 <div class="card" :class="item.class">
4 <a :href="item.url" :target="item.target" rel="noreferrer">
5 <div class="card-content">
6 <div class="media">
7 <div v-if="item.logo" class="media-left">
8 <figure class="image is-48x48">
9 <img :src="item.logo" :alt="`${item.name} logo`" />
10 </figure>
11 </div>
12 <div v-if="item.icon" class="media-left">
13 <figure class="image is-48x48">
14 <i style="font-size: 35px" :class="['fa-fw', item.icon]"></i>
15 </figure>
16 </div>
17 <div class="media-content">
18 <p class="title is-4">{{ item.name }}</p>
19 <p class="subtitle is-6">
20 <template v-if="item.subtitle">
21 {{ item.subtitle }}
22 </template>
23 <template v-else-if="meal"> Today: {{ meal.name }} </template>
24 <template v-else-if="stats">
25 happily keeping {{ stats.totalRecipes }} recipes organized
26 </template>
27 </p>
28 </div>
29 </div>
30 <div class="tag" :class="item.tagstyle" v-if="item.tag">
31 <strong class="tag-text">#{{ item.tag }}</strong>
32 </div>
33 </div>
34 </a>
35 </div>
36 </div>
37</template>
38
39<script>
40export default {
41 name: "Mealie",
42 props: {
43 item: Object,
44 },
45 data: () => ({
46 stats: null,
47 meal: null,
48 }),
49 created() {
50 this.fetchStatus();
51 },
52 methods: {
53 fetchStatus: async function () {
54 if (this.item.subtitle != null) return; // omitting unnecessary ajax call as the subtitle is showing
55 this.meal = await fetch(`${this.item.url}/api/meal-plans/today/`, {
56 headers: {
57 Authorization: "Bearer " + this.item.apikey,
58 Accept: "application/json",
59 },
60 })
61 .then(function (response) {
62 if (!response.ok) {
63 throw new Error("Not 2xx response");
64 } else {
65 if (response != null) {
66 return response.json();
67 }
68 }
69 })
70 .catch((e) => console.log(e));
71 this.stats = await fetch(`${this.item.url}/api/debug/statistics/`, {
72 headers: {
73 Authorization: "Bearer " + this.item.apikey,
74 Accept: "application/json",
75 },
76 })
77 .then(function (response) {
78 if (!response.ok) {
79 throw new Error("Not 2xx response");
80 } else {
81 return response.json();
82 }
83 })
84 .catch((e) => console.log(e));
85 },
86 },
87};
88</script>
89
90<style scoped lang="scss">
91.media-left img {
92 max-height: 100%;
93}
94</style>
diff --git a/src/components/services/OpenWeather.vue b/src/components/services/OpenWeather.vue
new file mode 100644
index 0000000..09ff76a
--- /dev/null
+++ b/src/components/services/OpenWeather.vue
@@ -0,0 +1,135 @@
1<template>
2 <div>
3 <div class="card" :class="item.class">
4 <a
5 :href="`https://openweathermap.org/city/${id}`"
6 :target="item.target"
7 rel="noreferrer"
8 >
9 <div class="card-content">
10 <div class="media">
11 <div v-if="icon" class="media-left" :class="item.background">
12 <figure class="image is-48x48">
13 <img
14 :src="`https://openweathermap.org/img/wn/${icon}@2x.png`"
15 :alt="conditions"
16 :title="conditions"
17 />
18 </figure>
19 </div>
20 <div class="media-content">
21 <p v-if="error" class="error">Data could not be retrieved</p>
22 <div v-else>
23 <p class="title is-4">{{ name }}</p>
24 <p class="subtitle is-6">
25 {{ temp | tempSuffix(this.item.units) }}
26 </p>
27 </div>
28 </div>
29 </div>
30 <div class="tag" :class="item.tagstyle" v-if="item.tag">
31 <strong class="tag-text">#{{ item.tag }}</strong>
32 </div>
33 </div>
34 </a>
35 </div>
36 </div>
37</template>
38
39<script>
40export default {
41 name: "OpenWeather",
42 props: {
43 item: Object,
44 },
45 data: () => ({
46 id: null,
47 icon: null,
48 name: null,
49 temp: null,
50 conditions: null,
51 error: false,
52 }),
53 created() {
54 this.fetchWeather();
55 },
56 methods: {
57 fetchWeather: async function () {
58 let locationQuery;
59
60 // Use location ID if specified, otherwise retrieve value from location (name).
61 if (this.item.locationId) {
62 locationQuery = `id=${this.item.locationId}`;
63 } else {
64 locationQuery = `q=${this.item.location}`;
65 }
66
67 const url = `https://api.openweathermap.org/data/2.5/weather?${locationQuery}&appid=${this.item.apiKey}&units=${this.item.units}`;
68 fetch(url)
69 .then((response) => {
70 if (!response.ok) {
71 throw Error(response.statusText);
72 }
73 return response.json();
74 })
75 .then((weather) => {
76 this.id = weather.id;
77 this.name = weather.name;
78 this.temp = parseInt(weather.main.temp).toFixed(1);
79 this.icon = weather.weather[0].icon;
80 this.conditions = weather.weather[0].description;
81 })
82 .catch((e) => {
83 console.log(e);
84 this.error = true;
85 });
86 },
87 },
88 filters: {
89 tempSuffix: function (value, type) {
90 if (!value) return "";
91
92 let unit = "K";
93 if (type === "metric") {
94 unit = "°C";
95 } else if (type === "imperial") {
96 unit = "°F";
97 }
98 return `${value} ${unit}`;
99 },
100 },
101};
102</script>
103
104<style scoped lang="scss">
105// Add a border around the weather image.
106// Otherwise the image is not always distinguishable.
107.media-left {
108 &.circle,
109 &.square {
110 background-color: #e4e4e4;
111 }
112
113 &.circle {
114 border-radius: 90%;
115 }
116
117 img {
118 max-height: 100%;
119 }
120}
121
122.error {
123 color: #de0000;
124}
125
126// Change background color in dark mode.
127.is-dark {
128 .media-left {
129 &.circle,
130 &.square {
131 background-color: #909090;
132 }
133 }
134}
135</style>
diff --git a/src/components/services/Radarr.vue b/src/components/services/Radarr.vue
index 9d38292..a9cdedf 100644
--- a/src/components/services/Radarr.vue
+++ b/src/components/services/Radarr.vue
@@ -70,7 +70,9 @@ export default {
70 }, 70 },
71 methods: { 71 methods: {
72 fetchConfig: function () { 72 fetchConfig: function () {
73 fetch(`${this.item.url}/api/health?apikey=${this.item.apikey}`) 73 fetch(`${this.item.url}/api/health?apikey=${this.item.apikey}`, {
74 credentials: "include",
75 })
74 .then((response) => { 76 .then((response) => {
75 if (response.status != 200) { 77 if (response.status != 200) {
76 throw new Error(response.statusText); 78 throw new Error(response.statusText);
@@ -92,7 +94,9 @@ export default {
92 console.error(e); 94 console.error(e);
93 this.serverError = true; 95 this.serverError = true;
94 }); 96 });
95 fetch(`${this.item.url}/api/queue?apikey=${this.item.apikey}`) 97 fetch(`${this.item.url}/api/queue?apikey=${this.item.apikey}`, {
98 credentials: "include",
99 })
96 .then((response) => { 100 .then((response) => {
97 if (response.status != 200) { 101 if (response.status != 200) {
98 throw new Error(response.statusText); 102 throw new Error(response.statusText);
diff --git a/src/components/services/Sonarr.vue b/src/components/services/Sonarr.vue
index 7851b6b..0270255 100644
--- a/src/components/services/Sonarr.vue
+++ b/src/components/services/Sonarr.vue
@@ -70,7 +70,9 @@ export default {
70 }, 70 },
71 methods: { 71 methods: {
72 fetchConfig: function () { 72 fetchConfig: function () {
73 fetch(`${this.item.url}/api/health?apikey=${this.item.apikey}`) 73 fetch(`${this.item.url}/api/health?apikey=${this.item.apikey}`, {
74 credentials: "include",
75 })
74 .then((response) => { 76 .then((response) => {
75 if (response.status != 200) { 77 if (response.status != 200) {
76 throw new Error(response.statusText); 78 throw new Error(response.statusText);
@@ -92,7 +94,9 @@ export default {
92 console.error(e); 94 console.error(e);
93 this.serverError = true; 95 this.serverError = true;
94 }); 96 });
95 fetch(`${this.item.url}/api/queue?apikey=${this.item.apikey}`) 97 fetch(`${this.item.url}/api/queue?apikey=${this.item.apikey}`, {
98 credentials: "include",
99 })
96 .then((response) => { 100 .then((response) => {
97 if (response.status != 200) { 101 if (response.status != 200) {
98 throw new Error(response.statusText); 102 throw new Error(response.statusText);