]>
Commit | Line | Data |
---|---|---|
dfb0b146 | 1 | # Custom Services |
fd12de9e | 2 | |
92d899bd | 3 | Some service can use a specific a component that provides some extra features by adding a `type` key to the service yaml |
1d3287dc | 4 | configuration. Available services are in `src/components/`. Here is an overview of all custom services that are available |
92d899bd | 5 | within Homer. |
fd12de9e | 6 | |
7129af3b BW |
7 | If you experiencing any issue, please have a look to the [troubleshooting](troubleshooting.md) page. |
8 | ||
fd12de9e DW |
9 | ## PiHole |
10 | ||
11 | Using the PiHole service you can display info about your local PiHole instance right on your Homer dashboard. | |
12 | ||
13 | The following configuration is available for the PiHole service. | |
14 | ||
1d3287dc | 15 | ```yaml |
fd12de9e DW |
16 | items: |
17 | - name: "Pi-hole" | |
18 | logo: "assets/tools/sample.png" | |
19 | # subtitle: "Network-wide Ad Blocking" # optional, if no subtitle is defined, PiHole statistics will be shown | |
20 | url: "http://192.168.0.151/admin" | |
21 | type: "PiHole" | |
22 | ``` | |
23 | ||
24 | ## OpenWeatherMap | |
25 | ||
26 | Using the OpenWeatherMap service you can display weather information about a given location. | |
f11b1c9d | 27 | The following configuration is available for the OpenWeatherMap service: |
fd12de9e | 28 | |
1d3287dc | 29 | ```yaml |
fd12de9e | 30 | items: |
dfb0b146 | 31 | - name: "Weather" |
dfb0b146 | 32 | location: "Amsterdam" # your location. |
f11b1c9d | 33 | locationId: "2759794" # Optional: Specify OpenWeatherMap city ID for better accuracy |
dfb0b146 DW |
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. | |
fb158d47 | 36 | background: "square" # choose which type of background you want behind the image. Can be one of: square, cicle, none. Defaults to none. |
dfb0b146 | 37 | type: "OpenWeather" |
fd12de9e | 38 | ``` |
97f0c43c DW |
39 | |
40 | **Remarks:** | |
92d5b8d4 BW |
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 | ||
4399f5fa | 43 | ## Medusa |
44 | ||
45 | This service displays News (grey), Warning (orange) or Error (red) notifications bubbles from the Medusa application. | |
46 | Two lines are needed in the config.yml : | |
1d3287dc BW |
47 | |
48 | ```yaml | |
4399f5fa | 49 | type: "Medusa" |
50 | apikey: "01234deb70424befb1f4ef6a23456789" | |
51 | ``` | |
1d3287dc | 52 | |
4399f5fa | 53 | The url must be the root url of Medusa application. |
54 | The Medusa API key can be found in General configuration > Interface. It is needed to access Medusa API. | |
55 | ||
4399f5fa | 56 | ## Sonarr/Radarr |
57 | ||
58 | This service displays Activity (blue), Warning (orange) or Error (red) notifications bubbles from the Radarr/Sonarr application. | |
59 | Two lines are needed in the config.yml : | |
1d3287dc BW |
60 | |
61 | ```yaml | |
4399f5fa | 62 | type: "Radarr" or "Sonarr" |
63 | apikey: "01234deb70424befb1f4ef6a23456789" | |
64 | ``` | |
1d3287dc | 65 | |
4399f5fa | 66 | The url must be the root url of Radarr/Sonarr application. |
67 | The Radarr/Sonarr API key can be found in Settings > General. It is needed to access the API. | |
92d899bd | 68 | |
92d899bd BW |
69 | ## PaperlessNG |
70 | ||
71 | For Paperless you need an API-Key which you have to store at the item in the field `apikey`. | |
72 | ||
92d899bd BW |
73 | ## Ping |
74 | ||
b2f6da03 SK |
75 | For Ping you need to set the type to Ping and provide a url. |
76 | ||
e58461ff SK |
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 | ``` |