aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/configuration.md8
-rw-r--r--docs/customservices.md73
-rw-r--r--docs/tips-and-tricks.md2
-rw-r--r--docs/troubleshooting.md6
4 files changed, 74 insertions, 15 deletions
diff --git a/docs/configuration.md b/docs/configuration.md
index e2b5506..84a7ea7 100644
--- a/docs/configuration.md
+++ b/docs/configuration.md
@@ -5,7 +5,7 @@ Title, icons, links, colors, and services can be configured in the `config.yml`
5```yaml 5```yaml
6--- 6---
7# Homepage configuration 7# Homepage configuration
8# See https://fontawesome.com/icons for icons options 8# See https://fontawesome.com/v5/search 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
@@ -29,9 +29,13 @@ connectivityCheck: true # whether you want to display a message when the apps ar
29 29
30# Optional: Proxy / hosting option 30# Optional: Proxy / hosting option
31proxy: 31proxy:
32 # NOT All custom services implements this new option YET. Support will be extended very soon.
33 useCredentials: false # send cookies & authorization headers when fetching service specific data. Set to `true` if you use an authentication proxy. Can be overrided on service level. 32 useCredentials: false # send cookies & authorization headers when fetching service specific data. Set to `true` if you use an authentication proxy. Can be overrided on service level.
34 33
34# Set the default layout and color scheme
35defaults:
36 layout: columns # Either 'columns', or 'list'
37 colorTheme: auto # One of 'auto', 'light', or 'dark'
38
35# Optional theming 39# Optional theming
36theme: default # 'default' or one of the themes available in 'src/assets/themes'. 40theme: default # 'default' or one of the themes available in 'src/assets/themes'.
37 41
diff --git a/docs/customservices.md b/docs/customservices.md
index 3fbd695..509278f 100644
--- a/docs/customservices.md
+++ b/docs/customservices.md
@@ -1,8 +1,22 @@
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 and, where applicable, an apikey. Note that config.yml is exposed at /assets/config.yml via HTTP and any
5within Homer. 5apikey included in the configuration file is exposed to anyone who can access the homer instance. Only include an apikey
6if your homer instance is secured behind some form of authentication or access restriction.
7
8Available services are in `src/components/`. Here is an overview of all custom services that are available
9within Homer:
10+ [PiHole](#pihole)
11+ [OpenWeatherMap](#openweathermap)
12+ [Medusa](#medusa)
13+ [Lidarr, Prowlarr, Sonarr and Radarr](#lidarr-prowlarr-sonarr-and-radarr)
14+ [PaperlessNG](#paperlessng)
15+ [Ping](#ping)
16+ [Prometheus](#prometheus)
17+ [AdGuard Home](#adguard-home)
18+ [Portainer](#portainer)
19+ [Emby](#emby)
6 20
7If you experiencing any issue, please have a look to the [troubleshooting](troubleshooting.md) page. 21If you experiencing any issue, please have a look to the [troubleshooting](troubleshooting.md) page.
8 22
@@ -18,8 +32,6 @@ If you experiencing any issue, please have a look to the [troubleshooting](troub
18 type: "<type>" 32 type: "<type>"
19``` 33```
20 34
21⚠️🚧 `endpoint` & `useCredentials` new options are not yet supported by all custom services (but will be very soon).
22
23## PiHole 35## PiHole
24 36
25Using the PiHole service you can display info about your local PiHole instance right on your Homer dashboard. 37Using the PiHole service you can display info about your local PiHole instance right on your Homer dashboard.
@@ -65,18 +77,28 @@ Two lines are needed in the config.yml :
65The url must be the root url of Medusa application. 77The url must be the root url of Medusa application.
66The Medusa API key can be found in General configuration > Interface. It is needed to access Medusa API. 78The Medusa API key can be found in General configuration > Interface. It is needed to access Medusa API.
67 79
68## Sonarr/Radarr 80## Lidarr, Prowlarr, Sonarr and Radarr
69 81
70This service displays Activity (blue), Warning (orange) or Error (red) notifications bubbles from the Radarr/Sonarr application. 82This service displays Activity (blue), Warning (orange) or Error (red) notifications bubbles from the Lidarr, Radarr or Sonarr application.
71Two lines are needed in the config.yml : 83Two lines are needed in the config.yml :
72 84
73```yaml 85```yaml
74 type: "Radarr" or "Sonarr" 86 type: "Lidarr", "Prowlarr", "Radarr" or "Sonarr"
75 apikey: "01234deb70424befb1f4ef6a23456789" 87 apikey: "01234deb70424befb1f4ef6a23456789"
76``` 88```
77 89
78The url must be the root url of Radarr/Sonarr application. 90The url must be the root url of Lidarr, Prowlarr, Radarr or Sonarr application.
79The Radarr/Sonarr API key can be found in Settings > General. It is needed to access the API. 91The Lidarr, Prowlarr, Radarr or Sonarr API key can be found in Settings > General. It is needed to access the API.
92If you are using an older version of Radarr or Sonarr which don't support the new V3 api endpoints, add the following line to your service config "legacyApi: true", example:
93
94```yaml
95- name: "Radarr"
96 type: "Radarr"
97 url: "http://localhost:7878/"
98 apikey: "MY-SUPER-SECRET-API-KEY"
99 target: "_blank"
100 legacyApi: true
101```
80 102
81## PaperlessNG 103## PaperlessNG
82 104
@@ -124,3 +146,36 @@ For AdGuard Home you need to set the type to AdGuard, if you have somes issues a
124 target: "_blank" 146 target: "_blank"
125 type: "AdGuardHome" 147 type: "AdGuardHome"
126``` 148```
149
150## Portainer
151
152This service displays info about the total number of containers managed by your Portainer instance.
153In order to use it, you must be using Portainer version 1.11 or later. Generate an access token from the UI and pass
154it to the apikey field.
155By default, every connected environments will be checked. To select specific ones,add an "environments" entry which can be a simple string or an array containing all the selected environments name.
156
157See https://docs.portainer.io/v/ce-2.11/user/account-settings#access-tokens
158
159```yaml
160- name: "Portainer"
161 logo: "assets/tools/sample.png"
162 url: "http://192.168.0.151/"
163 type: "Portainer"
164 apikey: "MY-SUPER-SECRET-API-KEY"
165 # environments:
166 # - "raspberry"
167 # - "local"
168```
169
170## Emby
171
172You need to set the type to Emby, provide an api key and choose which stats to show if the subtitle is disabled.
173
174```yaml
175- name: "Emby"
176 logo: "assets/tools/sample.png"
177 url: "http://192.168.0.151/"
178 type: "Emby"
179 apikey: "MY-SUPER-SECRET-API-KEY"
180 libraryType: "music" #Choose which stats to show. Can be one of: music, series or movies.
181```
diff --git a/docs/tips-and-tricks.md b/docs/tips-and-tricks.md
index 17bba9a..6f1b995 100644
--- a/docs/tips-and-tricks.md
+++ b/docs/tips-and-tricks.md
@@ -51,7 +51,7 @@ and then simply reference these pre-defined (anchored) tags in each item like so
51- name: "VS Code" 51- name: "VS Code"
52 logo: "/assets/vscode.png" 52 logo: "/assets/vscode.png"
53 subtitle: "Develop Code Anywhere, On Anything!" 53 subtitle: "Develop Code Anywhere, On Anything!"
54 <<: *App # Reference to the predefined "App" Tag 54 <<: *Apps # Reference to the predefined "App" Tag
55 url: "https://vscode.example.com/" 55 url: "https://vscode.example.com/"
56 target: "_blank" # optional html tag target attribute 56 target: "_blank" # optional html tag target attribute
57```` 57````
diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md
index ed1f85d..649e5a6 100644
--- a/docs/troubleshooting.md
+++ b/docs/troubleshooting.md
@@ -6,7 +6,7 @@ You might by facing a [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/C
6It happens when the targeted service is hosted on a different domain or port. 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 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). 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: 9If this happens your web console (`ctrl+shift+i` or `F12`) will be filled with this kind of errors:
10 10
11```text 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. 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.
@@ -15,5 +15,5 @@ Access to fetch at 'https://<target-service>' from origin 'https://<homer>' has
15To resolve this, you can either: 15To resolve this, you can either:
16 16
17* Host all your target service under the same domain & port. 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. 18* Modify the target server 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. 19* Use a cors proxy server like [`cors-container`](https://github.com/imjacobclark/cors-container), [`cors-anywhere`](https://github.com/Rob--W/cors-anywhere) or many others.