Radarr and Sonarr V3 api support optional

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

diff --git a/docs/customservices.md b/docs/customservices.md
index 8ea28ee7b353c3ba5cc26f198b8dd37e54f3f752..91c4051e9d83154eee52ce406a49403bd1a9285b 100644 (file)
--- a/docs/customservices.md
+++ b/docs/customservices.md
@@ -1,7 +1,11 @@
 # Custom Services
 
 Some service can use a specific a component that provides some extra features by adding a `type` key to the service yaml
-configuration. Available services are in `src/components/`. Here is an overview of all custom services that are available
+configuration and, where applicable, an apikey. Note that config.yml is exposed at /assets/config.yml via HTTP and any
+apikey included in the configuration file is exposed to anyone who can access the homer instance. Only include an apikey
+if your homer instance is secured behind some form of authentication or access restriction.
+
+Available services are in `src/components/`. Here is an overview of all custom services that are available
 within Homer.
 
 If you experiencing any issue, please have a look to the [troubleshooting](troubleshooting.md) page.
@@ -14,6 +18,7 @@ If you experiencing any issue, please have a look to the [troubleshooting](troub
   logo: "assets/tools/sample.png"
   url: "http://my-service-link"
   endpoint: "http://my-service-endpoint" # Optional: alternative base URL used to fetch service data is necessary.
+  useCredentials: false # Optional: Override global proxy.useCredentials configuration.
   type: "<type>"
 ```
 
@@ -40,7 +45,7 @@ The following configuration is available for the OpenWeatherMap service:
 - name: "Weather"
   location: "Amsterdam" # your location.
   locationId: "2759794" # Optional: Specify OpenWeatherMap city ID for better accuracy
-  apiKey: "<---insert-api-key-here--->" # insert your own API key here. Request one from https://openweathermap.org/api.
+  apikey: "<---insert-api-key-here--->" # insert your own API key here. Request one from https://openweathermap.org/api.
   units: "metric" # units to display temperature. Can be one of: metric, imperial, kelvin. Defaults to kelvin.
   background: "square" # choose which type of background you want behind the image. Can be one of: square, cicle, none. Defaults to none.
   type: "OpenWeather"
@@ -62,22 +67,39 @@ Two lines are needed in the config.yml :
 The url must be the root url of Medusa application.
 The Medusa API key can be found in General configuration > Interface. It is needed to access Medusa API.
 
-## Sonarr/Radarr
+## Lidarr, Sonarr and Radarr
 
-This service displays Activity (blue), Warning (orange) or Error (red) notifications bubbles from the Radarr/Sonarr application.
+This service displays Activity (blue), Warning (orange) or Error (red) notifications bubbles from the Lidarr, Radarr or Sonarr application.
 Two lines are needed in the config.yml :
 
 ```yaml
-  type: "Radarr" or "Sonarr"
+  type: "Lidarr", "Radarr" or "Sonarr"
   apikey: "01234deb70424befb1f4ef6a23456789"
 ```
 
-The url must be the root url of Radarr/Sonarr application.
-The Radarr/Sonarr API key can be found in Settings > General. It is needed to access the API.
+The url must be the root url of Lidarr, Radarr or Sonarr application.
+The Lidarr, Radarr or Sonarr API key can be found in Settings > General. It is needed to access the API.
+If 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: 
+
+```yaml
+- name: "Radarr"
+  type: "Radarr"
+  url: "http://localhost:8989/"
+  apikey: "MY-SUPER-SECRET-API-KEY"
+  target: "_blank" # optional html tag target attribute
+  legacyApi: true
+```
 
 ## PaperlessNG
 
-For Paperless you need an API-Key which you have to store at the item in the field `apikey`.
+This service displays total number of documents stored. Two lines are required:
+
+```yaml
+  type: "PaperlessNG"
+  apikey: "0123456789abcdef123456789abcdef"
+```
+
+API key can be generated in Settings > Administration > Auth Tokens
 
 ## Ping
 
@@ -87,6 +109,19 @@ For Ping you need to set the type to Ping and provide a url.
 - name: "Awesome app"
   type: Ping
   logo: "assets/tools/sample.png"
-  subtitle: "Bookmark example" tag: "app" 
-  url: "https://www.reddit.com/r/selfhosted/" 
+  subtitle: "Bookmark example"
+  tag: "app"
+  url: "https://www.reddit.com/r/selfhosted/"
+```
+
+## Prometheus
+
+For Prometheus you need to set the type to Prometheus and provide a url.
+
+```yaml
+- name: "Prometheus"
+  type: Prometheus
+  logo: "assets/tools/sample.png"
+  url: "http://192.168.0.151/"
+  # subtitle: "Monitor data server"
 ```