diff options
Diffstat (limited to 'docs/customservices.md')
-rw-r--r-- | docs/customservices.md | 47 |
1 files changed, 39 insertions, 8 deletions
diff --git a/docs/customservices.md b/docs/customservices.md index 43f45f4..f79428f 100644 --- a/docs/customservices.md +++ b/docs/customservices.md | |||
@@ -1,16 +1,18 @@ | |||
1 | # Custom Services | 1 | # Custom Services |
2 | 2 | ||
3 | Some service can use a specific a component that provides some extra features by adding a `type` key to the service yaml | 3 | Some service can use a specific a component that provides some extra features by adding a `type` key to the service yaml |
4 | configuration. Available services are in `src/components/`. Here is an overview of all custom services that are available | 4 | configuration. Available services are in `src/components/`. Here is an overview of all custom services that are available |
5 | within Homer. | 5 | within Homer. |
6 | 6 | ||
7 | If you experiencing any issue, please have a look to the [troubleshooting](troubleshooting.md) page. | ||
8 | |||
7 | ## PiHole | 9 | ## PiHole |
8 | 10 | ||
9 | Using the PiHole service you can display info about your local PiHole instance right on your Homer dashboard. | 11 | Using the PiHole service you can display info about your local PiHole instance right on your Homer dashboard. |
10 | 12 | ||
11 | The following configuration is available for the PiHole service. | 13 | The following configuration is available for the PiHole service. |
12 | 14 | ||
13 | ``` | 15 | ```yaml |
14 | items: | 16 | items: |
15 | - name: "Pi-hole" | 17 | - name: "Pi-hole" |
16 | logo: "assets/tools/sample.png" | 18 | logo: "assets/tools/sample.png" |
@@ -19,35 +21,64 @@ The following configuration is available for the PiHole service. | |||
19 | type: "PiHole" | 21 | type: "PiHole" |
20 | ``` | 22 | ``` |
21 | 23 | ||
24 | ## OpenWeatherMap | ||
25 | |||
26 | Using the OpenWeatherMap service you can display weather information about a given location. | ||
27 | The following configuration is available for the OpenWeatherMap service: | ||
28 | |||
29 | ```yaml | ||
30 | items: | ||
31 | - name: "Weather" | ||
32 | location: "Amsterdam" # your location. | ||
33 | locationId: "2759794" # Optional: Specify OpenWeatherMap city ID for better accuracy | ||
34 | apiKey: "<---insert-api-key-here--->" # insert your own API key here. Request one from https://openweathermap.org/api. | ||
35 | units: "metric" # units to display temperature. Can be one of: metric, imperial, kelvin. Defaults to kelvin. | ||
36 | background: "square" # choose which type of background you want behind the image. Can be one of: square, cicle, none. Defaults to none. | ||
37 | type: "OpenWeather" | ||
38 | ``` | ||
39 | |||
40 | **Remarks:** | ||
41 | If for some reason your city can't be found by entering the name in the `location` property, you could also try to configure the OWM city ID in the `locationId` property. To retrieve your specific City ID, go to the [OWM website](https://openweathermap.org), search for your city and retrieve the ID from the URL (for example, the City ID of Amsterdam is 2759794). | ||
42 | |||
22 | ## Medusa | 43 | ## Medusa |
23 | 44 | ||
24 | This service displays News (grey), Warning (orange) or Error (red) notifications bubbles from the Medusa application. | 45 | This service displays News (grey), Warning (orange) or Error (red) notifications bubbles from the Medusa application. |
25 | Two lines are needed in the config.yml : | 46 | Two lines are needed in the config.yml : |
26 | ``` | 47 | |
48 | ```yaml | ||
27 | type: "Medusa" | 49 | type: "Medusa" |
28 | apikey: "01234deb70424befb1f4ef6a23456789" | 50 | apikey: "01234deb70424befb1f4ef6a23456789" |
29 | ``` | 51 | ``` |
52 | |||
30 | The url must be the root url of Medusa application. | 53 | The url must be the root url of Medusa application. |
31 | The Medusa API key can be found in General configuration > Interface. It is needed to access Medusa API. | 54 | The Medusa API key can be found in General configuration > Interface. It is needed to access Medusa API. |
32 | 55 | ||
33 | |||
34 | ## Sonarr/Radarr | 56 | ## Sonarr/Radarr |
35 | 57 | ||
36 | This service displays Activity (blue), Warning (orange) or Error (red) notifications bubbles from the Radarr/Sonarr application. | 58 | This service displays Activity (blue), Warning (orange) or Error (red) notifications bubbles from the Radarr/Sonarr application. |
37 | Two lines are needed in the config.yml : | 59 | Two lines are needed in the config.yml : |
38 | ``` | 60 | |
61 | ```yaml | ||
39 | type: "Radarr" or "Sonarr" | 62 | type: "Radarr" or "Sonarr" |
40 | apikey: "01234deb70424befb1f4ef6a23456789" | 63 | apikey: "01234deb70424befb1f4ef6a23456789" |
41 | ``` | 64 | ``` |
65 | |||
42 | The url must be the root url of Radarr/Sonarr application. | 66 | The url must be the root url of Radarr/Sonarr application. |
43 | The Radarr/Sonarr API key can be found in Settings > General. It is needed to access the API. | 67 | The Radarr/Sonarr API key can be found in Settings > General. It is needed to access the API. |
44 | 68 | ||
45 | |||
46 | ## PaperlessNG | 69 | ## PaperlessNG |
47 | 70 | ||
48 | For Paperless you need an API-Key which you have to store at the item in the field `apikey`. | 71 | For Paperless you need an API-Key which you have to store at the item in the field `apikey`. |
49 | 72 | ||
50 | |||
51 | ## Ping | 73 | ## Ping |
52 | 74 | ||
53 | For Paperless you need an API-Key which you have to store at the item in the field `apikey`. | 75 | For Ping you need to set the type to Ping and provide a url. |
76 | |||
77 | ```yaml | ||
78 | items: | ||
79 | - name: "Awesome app" | ||
80 | type: Ping | ||
81 | logo: "assets/tools/sample.png" | ||
82 | subtitle: "Bookmark example" tag: "app" | ||
83 | url: "https://www.reddit.com/r/selfhosted/" | ||
84 | ``` | ||