From 92d899bd4809183f1cd1cec302d66fa32461aac5 Mon Sep 17 00:00:00 2001 From: Bastien Wirtz Date: Wed, 14 Jul 2021 15:48:57 +0200 Subject: regroup service documentation --- docs/configuration.md | 13 ------------- docs/customservices.md | 14 +++++++++++++- 2 files changed, 13 insertions(+), 14 deletions(-) (limited to 'docs') diff --git a/docs/configuration.md b/docs/configuration.md index ce36c51..a472b41 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -167,16 +167,3 @@ In order to easily generate all required icon preset for the PWA to work, a tool ```bash npx vue-pwa-asset-generator -a {your_512x512_source_png} -o {your_output_folder} ``` - -### Supported services - -Currently the following services are supported for showing quick infos on the card. They can be used by setting the type to one of the following values at the item. - -- PiHole -- AdGuardHome -- PaperlessNG - -### Additional configuration - -#### Paperless -For Paperless you need an API-Key which you have to store at the item in the field `apikey`. \ No newline at end of file diff --git a/docs/customservices.md b/docs/customservices.md index d2deff4..43f45f4 100644 --- a/docs/customservices.md +++ b/docs/customservices.md @@ -1,6 +1,8 @@ # Custom Services -Here is an overview of all custom services that are available within Homer. +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 +within Homer. ## PiHole @@ -39,3 +41,13 @@ 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. + + +## PaperlessNG + +For Paperless you need an API-Key which you have to store at the item in the field `apikey`. + + +## Ping + +For Paperless you need an API-Key which you have to store at the item in the field `apikey`. -- cgit v1.2.3