diff options
author | Isaac Suttell <isaac@isaacsuttell.com> | 2022-07-10 13:10:09 -0700 |
---|---|---|
committer | Bastien Wirtz <bastien.wirtz@gmail.com> | 2022-10-08 11:53:26 +0200 |
commit | db2814237443bb68c11c728d5206679d3cc38e94 (patch) | |
tree | 988a8b0d93c359bd8054565d29528f2bacab8aab | |
parent | 6c083d6a361c0359ffa597021c28154e60c285c1 (diff) | |
download | homer-db2814237443bb68c11c728d5206679d3cc38e94.tar.gz homer-db2814237443bb68c11c728d5206679d3cc38e94.tar.zst homer-db2814237443bb68c11c728d5206679d3cc38e94.zip |
updated Ping docs to include how to use new method property
-rw-r--r-- | docs/customservices.md | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/docs/customservices.md b/docs/customservices.md index c9ce093..8877ece 100644 --- a/docs/customservices.md +++ b/docs/customservices.md | |||
@@ -93,7 +93,7 @@ Two lines are needed in the config.yml : | |||
93 | 93 | ||
94 | The url must be the root url of Lidarr, Prowlarr, Radarr or Sonarr application. | 94 | The url must be the root url of Lidarr, Prowlarr, Radarr or Sonarr application. |
95 | The Lidarr, Prowlarr, Radarr or Sonarr API key can be found in Settings > General. It is needed to access the API. | 95 | The Lidarr, Prowlarr, Radarr or Sonarr API key can be found in Settings > General. It is needed to access the API. |
96 | 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: | 96 | 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: |
97 | 97 | ||
98 | ```yaml | 98 | ```yaml |
99 | - name: "Radarr" | 99 | - name: "Radarr" |
@@ -117,7 +117,7 @@ API key can be generated in Settings > Administration > Auth Tokens | |||
117 | 117 | ||
118 | ## Ping | 118 | ## Ping |
119 | 119 | ||
120 | For Ping you need to set the type to Ping and provide a url. | 120 | 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. |
121 | 121 | ||
122 | ```yaml | 122 | ```yaml |
123 | - name: "Awesome app" | 123 | - name: "Awesome app" |
@@ -126,6 +126,7 @@ For Ping you need to set the type to Ping and provide a url. | |||
126 | subtitle: "Bookmark example" | 126 | subtitle: "Bookmark example" |
127 | tag: "app" | 127 | tag: "app" |
128 | url: "https://www.reddit.com/r/selfhosted/" | 128 | url: "https://www.reddit.com/r/selfhosted/" |
129 | method: "head" | ||
129 | ``` | 130 | ``` |
130 | 131 | ||
131 | ## Prometheus | 132 | ## Prometheus |