Added Tdarr service (#573)

[github/bastienwirtz/homer.git] / docs / customservices.md

diff --git a/docs/customservices.md b/docs/customservices.md
index 82114c2f0eb8f8903447400dd8c04e8f8825625c..b28f39919582dd60231233ed887b9d2b3a276c8f 100644 (file)
--- a/docs/customservices.md
+++ b/docs/customservices.md
@@ -32,6 +32,7 @@ within Homer:
   - [What's Up Docker](#whats-up-docker)
   - [SABnzbd](#sabnzbd)
   - [OctoPrint](#sabnzbd)
+  - [Tdarr](#tdarr)
 
 If you experiencing any issue, please have a look to the [troubleshooting](troubleshooting.md) page.
 
@@ -390,4 +391,17 @@ The OctoPrint service only needs an `apikey` & `url` and optionally a `display`
   url: "http://192.168.0.151:8080"
   display: "text" # 'text' or 'bar'. Default to `text`.
   type: "OctoPrint"
-```
\ No newline at end of file
+```
+
+## Tdarr
+
+The Tdarr service can allow you to show the number of currently queued items
+for transcoding on your Tdarr instance as well as the number of errored items.
+
+```yaml
+- name: "Tdarr"
+  logo: "assets/tools/sample.png"
+  url: "http://192.168.0.151:8265"
+  type: "Tdarr"
+  checkInterval: 5000 # (Optional) Interval (in ms) for updating the queue & error counts
+```