aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/customservices.md
diff options
context:
space:
mode:
authorBastien Wirtz <bastien.wirtz@gmail.com>2022-11-27 18:41:12 +0100
committerGitHub <noreply@github.com>2022-11-27 09:41:12 -0800
commit70f583c3e1d7c4bc1cca6b9c1cec6ca2e1f9e7b3 (patch)
tree4a81ec8383a9d6ee6b58138d2a5fd429c9161799 /docs/customservices.md
parent98fe0a393970070fa04b5f37dbbb7a4c3ef82beb (diff)
downloadhomer-70f583c3e1d7c4bc1cca6b9c1cec6ca2e1f9e7b3.tar.gz
homer-70f583c3e1d7c4bc1cca6b9c1cec6ca2e1f9e7b3.tar.zst
homer-70f583c3e1d7c4bc1cca6b9c1cec6ca2e1f9e7b3.zip
Octoprint service (#324) (#560)v22.11.2
Add Octoprint service.
Diffstat (limited to 'docs/customservices.md')
-rw-r--r--docs/customservices.md32
1 files changed, 23 insertions, 9 deletions
diff --git a/docs/customservices.md b/docs/customservices.md
index 5bb08ff..88e4e2f 100644
--- a/docs/customservices.md
+++ b/docs/customservices.md
@@ -31,6 +31,7 @@ within Homer:
31 - [Speedtest Tracker](#SpeedtestTracker) 31 - [Speedtest Tracker](#SpeedtestTracker)
32 - [What's Up Docker](#whats-up-docker) 32 - [What's Up Docker](#whats-up-docker)
33 - [SABnzbd](#sabnzbd) 33 - [SABnzbd](#sabnzbd)
34 - [OctoPrint](#sabnzbd)
34 35
35If you experiencing any issue, please have a look to the [troubleshooting](troubleshooting.md) page. 36If you experiencing any issue, please have a look to the [troubleshooting](troubleshooting.md) page.
36 37
@@ -84,7 +85,7 @@ Two lines are needed in the config.yml :
84 85
85```yaml 86```yaml
86 type: "Medusa" 87 type: "Medusa"
87 apikey: "01234deb70424befb1f4ef6a23456789" 88 apikey: "<---insert-api-key-here--->"
88``` 89```
89 90
90The url must be the root url of Medusa application. 91The url must be the root url of Medusa application.
@@ -97,7 +98,7 @@ Two lines are needed in the config.yml :
97 98
98```yaml 99```yaml
99 type: "Lidarr", "Prowlarr", "Radarr" or "Sonarr" 100 type: "Lidarr", "Prowlarr", "Radarr" or "Sonarr"
100 apikey: "01234deb70424befb1f4ef6a23456789" 101 apikey: "<---insert-api-key-here--->"
101``` 102```
102 103
103The url must be the root url of Lidarr, Prowlarr, Radarr or Sonarr application. 104The url must be the root url of Lidarr, Prowlarr, Radarr or Sonarr application.
@@ -108,7 +109,7 @@ If you are using an older version of Radarr or Sonarr which don't support the ne
108- name: "Radarr" 109- name: "Radarr"
109 type: "Radarr" 110 type: "Radarr"
110 url: "http://localhost:7878/" 111 url: "http://localhost:7878/"
111 apikey: "MY-SUPER-SECRET-API-KEY" 112 apikey: "<---insert-api-key-here--->"
112 target: "_blank" 113 target: "_blank"
113 legacyApi: true 114 legacyApi: true
114``` 115```
@@ -119,7 +120,7 @@ This service displays total number of documents stored. Two lines are required:
119 120
120```yaml 121```yaml
121 type: "PaperlessNG" 122 type: "PaperlessNG"
122 apikey: "0123456789abcdef123456789abcdef" 123 apikey: "<---insert-api-key-here--->"
123``` 124```
124 125
125API key can be generated in Settings > Administration > Auth Tokens 126API key can be generated in Settings > Administration > Auth Tokens
@@ -175,7 +176,7 @@ See https://docs.portainer.io/v/ce-2.11/user/account-settings#access-tokens
175 logo: "assets/tools/sample.png" 176 logo: "assets/tools/sample.png"
176 url: "http://192.168.0.151/" 177 url: "http://192.168.0.151/"
177 type: "Portainer" 178 type: "Portainer"
178 apikey: "MY-SUPER-SECRET-API-KEY" 179 apikey: "<---insert-api-key-here--->"
179 # environments: 180 # environments:
180 # - "raspberry" 181 # - "raspberry"
181 # - "local" 182 # - "local"
@@ -190,7 +191,7 @@ You need to set the type to Emby, provide an api key and choose which stats to s
190 logo: "assets/tools/sample.png" 191 logo: "assets/tools/sample.png"
191 url: "http://192.168.0.151/" 192 url: "http://192.168.0.151/"
192 type: "Emby" 193 type: "Emby"
193 apikey: "MY-SUPER-SECRET-API-KEY" 194 apikey: "<---insert-api-key-here--->"
194 libraryType: "music" #Choose which stats to show. Can be one of: music, series or movies. 195 libraryType: "music" #Choose which stats to show. Can be one of: music, series or movies.
195``` 196```
196 197
@@ -220,7 +221,7 @@ the "Web Interface" section of settings on the Tautulli web UI.
220 logo: "assets/tools/sample.png" 221 logo: "assets/tools/sample.png"
221 url: "http://192.168.0.151:8181" 222 url: "http://192.168.0.151:8181"
222 type: "Tautulli" 223 type: "Tautulli"
223 apikey: "MY-SUPER-SECRET-API-KEY" 224 apikey: "<---insert-api-key-here--->"
224``` 225```
225 226
226Because the service type and link don't necessarily have to match, you could 227Because the service type and link don't necessarily have to match, you could
@@ -233,7 +234,7 @@ endpoint pointing to Tautulli!
233 url: "http://192.168.0.151:32400/web" # Plex 234 url: "http://192.168.0.151:32400/web" # Plex
234 endpoint: "http://192.168.0.151:8181" # Tautulli 235 endpoint: "http://192.168.0.151:8181" # Tautulli
235 type: "Tautulli" 236 type: "Tautulli"
236 apikey: "MY-SUPER-SECRET-API-KEY" 237 apikey: "<---insert-api-key-here--->"
237``` 238```
238 239
239## Mealie 240## Mealie
@@ -248,7 +249,7 @@ Two lines are needed in the config.yml :
248 249
249```yaml 250```yaml
250 type: "Healthchecks" 251 type: "Healthchecks"
251 apikey: "01234deb70424befb1f4ef6a23456789" 252 apikey: "<---insert-api-key-here--->"
252``` 253```
253 254
254The url must be the root url of the Healthchecks application. 255The url must be the root url of the Healthchecks application.
@@ -377,3 +378,16 @@ the "Config" > "General" section of the SABnzbd config in the SABnzbd web UI.
377 apikey: "MY-SUPER-SECRET-API-KEY" 378 apikey: "MY-SUPER-SECRET-API-KEY"
378 downloadInterval: 5000 # (Optional) Interval (in ms) for updating the download count 379 downloadInterval: 5000 # (Optional) Interval (in ms) for updating the download count
379``` 380```
381
382## OctoPrint
383
384The OctoPrint service only needs an `apikey` & `url` and optionally a `display` option.
385
386```yaml
387- name: "Octoprint"
388 logo: "https://cdn-icons-png.flaticon.com/512/3112/3112529.png"
389 apikey: "xxxxxxxxxxxx" # insert your own API key here. Request one from https://openweathermap.org/api.
390 url: "http://192.168.0.151:8080"
391 display: "text" # 'text' or 'bar'. Default to `text`.
392 type: "OctoPrint"
393``` \ No newline at end of file