]> git.immae.eu Git - github/bastienwirtz/homer.git/commitdiff
updated Ping docs to include how to use new method property
authorIsaac Suttell <isaac@isaacsuttell.com>
Sun, 10 Jul 2022 20:10:09 +0000 (13:10 -0700)
committerBastien Wirtz <bastien.wirtz@gmail.com>
Sat, 8 Oct 2022 09:53:26 +0000 (11:53 +0200)
docs/customservices.md

index c9ce093a3aabd82d41e8fefea510331ef74fd10c..8877ecee70f735191a640b3038307477615a753d 100644 (file)
@@ -93,7 +93,7 @@ Two lines are needed in the config.yml :
 
 The url must be the root url of Lidarr, Prowlarr, Radarr or Sonarr application.
 The Lidarr, Prowlarr, Radarr or 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, Prowlarr, Radarr or Sonarr application.
 The Lidarr, Prowlarr, 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: 
+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"
 
 ```yaml
 - name: "Radarr"
@@ -117,7 +117,7 @@ API key can be generated in Settings > Administration > Auth Tokens
 
 ## Ping
 
 
 ## Ping
 
-For Ping you need to set the type to Ping and provide a url.
+For Ping you need to set the type to Ping and provide a url. By default the HEAD method is used but it can be configured to use GET using the optional `method` property.
 
 ```yaml
 - name: "Awesome app"
 
 ```yaml
 - name: "Awesome app"
@@ -126,6 +126,7 @@ For Ping you need to set the type to Ping and provide a url.
   subtitle: "Bookmark example"
   tag: "app"
   url: "https://www.reddit.com/r/selfhosted/"
   subtitle: "Bookmark example"
   tag: "app"
   url: "https://www.reddit.com/r/selfhosted/"
+  method: "head"
 ```
 
 ## Prometheus
 ```
 
 ## Prometheus