aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/customservices.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/customservices.md')
-rw-r--r--docs/customservices.md60
1 files changed, 48 insertions, 12 deletions
diff --git a/docs/customservices.md b/docs/customservices.md
index 7a151d1..cb68e1d 100644
--- a/docs/customservices.md
+++ b/docs/customservices.md
@@ -1,7 +1,11 @@
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
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
5within Homer. 9within Homer.
6 10
7If you experiencing any issue, please have a look to the [troubleshooting](troubleshooting.md) page. 11If you experiencing any issue, please have a look to the [troubleshooting](troubleshooting.md) page.
@@ -18,8 +22,6 @@ If you experiencing any issue, please have a look to the [troubleshooting](troub
18 type: "<type>" 22 type: "<type>"
19``` 23```
20 24
21⚠️🚧 `endpoint` & `useCredentials` new options are not yet supported by all custom services (but will be very soon).
22
23## PiHole 25## PiHole
24 26
25Using the PiHole service you can display info about your local PiHole instance right on your Homer dashboard. 27Using the PiHole service you can display info about your local PiHole instance right on your Homer dashboard.
@@ -43,7 +45,7 @@ The following configuration is available for the OpenWeatherMap service:
43- name: "Weather" 45- name: "Weather"
44 location: "Amsterdam" # your location. 46 location: "Amsterdam" # your location.
45 locationId: "2759794" # Optional: Specify OpenWeatherMap city ID for better accuracy 47 locationId: "2759794" # Optional: Specify OpenWeatherMap city ID for better accuracy
46 apiKey: "<---insert-api-key-here--->" # insert your own API key here. Request one from https://openweathermap.org/api. 48 apikey: "<---insert-api-key-here--->" # insert your own API key here. Request one from https://openweathermap.org/api.
47 units: "metric" # units to display temperature. Can be one of: metric, imperial, kelvin. Defaults to kelvin. 49 units: "metric" # units to display temperature. Can be one of: metric, imperial, kelvin. Defaults to kelvin.
48 background: "square" # choose which type of background you want behind the image. Can be one of: square, cicle, none. Defaults to none. 50 background: "square" # choose which type of background you want behind the image. Can be one of: square, cicle, none. Defaults to none.
49 type: "OpenWeather" 51 type: "OpenWeather"
@@ -65,22 +67,39 @@ Two lines are needed in the config.yml :
65The url must be the root url of Medusa application. 67The 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. 68The Medusa API key can be found in General configuration > Interface. It is needed to access Medusa API.
67 69
68## Sonarr/Radarr 70## Lidarr, Prowlarr, Sonarr and Radarr
69 71
70This service displays Activity (blue), Warning (orange) or Error (red) notifications bubbles from the Radarr/Sonarr application. 72This 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 : 73Two lines are needed in the config.yml :
72 74
73```yaml 75```yaml
74 type: "Radarr" or "Sonarr" 76 type: "Lidarr", "Prowlarr", "Radarr" or "Sonarr"
75 apikey: "01234deb70424befb1f4ef6a23456789" 77 apikey: "01234deb70424befb1f4ef6a23456789"
76``` 78```
77 79
78The url must be the root url of Radarr/Sonarr application. 80The 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. 81The Lidarr, Prowlarr, Radarr or Sonarr API key can be found in Settings > General. It is needed to access the API.
82If 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:
83
84```yaml
85- name: "Radarr"
86 type: "Radarr"
87 url: "http://localhost:7878/"
88 apikey: "MY-SUPER-SECRET-API-KEY"
89 target: "_blank"
90 legacyApi: true
91```
80 92
81## PaperlessNG 93## PaperlessNG
82 94
83For Paperless you need an API-Key which you have to store at the item in the field `apikey`. 95This service displays total number of documents stored. Two lines are required:
96
97```yaml
98 type: "PaperlessNG"
99 apikey: "0123456789abcdef123456789abcdef"
100```
101
102API key can be generated in Settings > Administration > Auth Tokens
84 103
85## Ping 104## Ping
86 105
@@ -90,8 +109,9 @@ For Ping you need to set the type to Ping and provide a url.
90- name: "Awesome app" 109- name: "Awesome app"
91 type: Ping 110 type: Ping
92 logo: "assets/tools/sample.png" 111 logo: "assets/tools/sample.png"
93 subtitle: "Bookmark example" tag: "app" 112 subtitle: "Bookmark example"
94 url: "https://www.reddit.com/r/selfhosted/" 113 tag: "app"
114 url: "https://www.reddit.com/r/selfhosted/"
95``` 115```
96 116
97## Prometheus 117## Prometheus
@@ -105,3 +125,19 @@ For Prometheus you need to set the type to Prometheus and provide a url.
105 url: "http://192.168.0.151/" 125 url: "http://192.168.0.151/"
106 # subtitle: "Monitor data server" 126 # subtitle: "Monitor data server"
107``` 127```
128
129## Portainer
130
131This service displays info about the total number of containers managed by your Portainer instance.
132In order to use it, you must be using Portainer version 1.11 or later. Generate an access token from the UI and pass
133it to the apikey field.
134
135See https://docs.portainer.io/v/ce-2.11/user/account-settings#access-tokens
136
137```yaml
138- name: "Portainer"
139 logo: "assets/tools/sample.png"
140 url: "http://192.168.0.151/"
141 type: "Portainer"
142 apikey: "MY-SUPER-SECRET-API-KEY"
143```