doc: add doc for AdGuard Home

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

diff --git a/docs/customservices.md b/docs/customservices.md
index 548af9627b4b694ff39170133e20da9460df554c..ab2b015a274d044bd43dbe37df550f8f88ef9fa9 100644 (file)
--- a/docs/customservices.md
+++ b/docs/customservices.md
@@ -6,15 +6,16 @@ within Homer.
 
 If you experiencing any issue, please have a look to the [troubleshooting](troubleshooting.md) page.
 
+
 ## Common options
 
 ```yaml
-- name: 'My Service'
-  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.
+- name: "My Service"
+  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>'
+  type: "<type>"
 ```
 
 ⚠️🚧 `endpoint` & `useCredentials` new options are not yet supported by all custom services (but will be very soon).
@@ -42,7 +43,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"
@@ -79,7 +80,14 @@ The Radarr/Sonarr API key can be found in Settings > General. It is needed to ac
 
 ## 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
 
@@ -89,8 +97,9 @@ 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
@@ -104,3 +113,24 @@ For Prometheus you need to set the type to Prometheus and provide a url.
   url: "http://192.168.0.151/"
   # subtitle: "Monitor data server"
 ```
+
+## AdGuard Home
+For AdGuard Home you need to set the type to AdGuard, if you have somes issues as 403 responses on requests you need to provide authentification in headers for locations needed as below.
+In `config.yml`
+```yaml
+- name: "Adguard"
+  logo: "assets/tools/adguardhome.png"
+  url: "https://adguard.exemple.com"
+  target: "_blank"
+  type: "AdGuardHome"
+```
+In your conf files for your AdGuard Home instance
+```
+location /control/stats {
+  proxy_set_header Authorization "Basic [admin:password in Base64]";
+}
+
+location /control/status {
+  proxy_set_header Authorization "Basic [admin:password in Base64]";
+}
+```
\ No newline at end of file