]>
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 | ||
3acfb01d BW |
9 | |
10 | ## Common options | |
11 | ||
12 | ```yaml | |
13 | - name: "My Service" | |
14 | logo: "assets/tools/sample.png" | |
15 | url: "http://my-service-link" | |
16 | endpoint: "http://my-service-endpoint" # Optional: alternative base URL used to fetch service data is necessary. | |
17 | type: "<type>" | |
18 | ``` | |
19 | ||
fd12de9e DW |
20 | ## PiHole |
21 | ||
22 | Using the PiHole service you can display info about your local PiHole instance right on your Homer dashboard. | |
23 | ||
24 | The following configuration is available for the PiHole service. | |
25 | ||
1d3287dc | 26 | ```yaml |
3acfb01d BW |
27 | - name: "Pi-hole" |
28 | logo: "assets/tools/sample.png" | |
29 | # subtitle: "Network-wide Ad Blocking" # optional, if no subtitle is defined, PiHole statistics will be shown | |
30 | url: "http://192.168.0.151/admin" | |
31 | type: "PiHole" | |
fd12de9e DW |
32 | ``` |
33 | ||
34 | ## OpenWeatherMap | |
35 | ||
36 | Using the OpenWeatherMap service you can display weather information about a given location. | |
f11b1c9d | 37 | The following configuration is available for the OpenWeatherMap service: |
fd12de9e | 38 | |
1d3287dc | 39 | ```yaml |
3acfb01d BW |
40 | - name: "Weather" |
41 | location: "Amsterdam" # your location. | |
42 | locationId: "2759794" # Optional: Specify OpenWeatherMap city ID for better accuracy | |
43 | apiKey: "<---insert-api-key-here--->" # insert your own API key here. Request one from https://openweathermap.org/api. | |
44 | units: "metric" # units to display temperature. Can be one of: metric, imperial, kelvin. Defaults to kelvin. | |
45 | background: "square" # choose which type of background you want behind the image. Can be one of: square, cicle, none. Defaults to none. | |
46 | type: "OpenWeather" | |
fd12de9e | 47 | ``` |
97f0c43c DW |
48 | |
49 | **Remarks:** | |
92d5b8d4 BW |
50 | 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). |
51 | ||
4399f5fa | 52 | ## Medusa |
53 | ||
54 | This service displays News (grey), Warning (orange) or Error (red) notifications bubbles from the Medusa application. | |
55 | Two lines are needed in the config.yml : | |
1d3287dc BW |
56 | |
57 | ```yaml | |
3acfb01d BW |
58 | type: "Medusa" |
59 | apikey: "01234deb70424befb1f4ef6a23456789" | |
4399f5fa | 60 | ``` |
1d3287dc | 61 | |
4399f5fa | 62 | The url must be the root url of Medusa application. |
63 | The Medusa API key can be found in General configuration > Interface. It is needed to access Medusa API. | |
64 | ||
4399f5fa | 65 | ## Sonarr/Radarr |
66 | ||
67 | This service displays Activity (blue), Warning (orange) or Error (red) notifications bubbles from the Radarr/Sonarr application. | |
68 | Two lines are needed in the config.yml : | |
1d3287dc BW |
69 | |
70 | ```yaml | |
3acfb01d BW |
71 | type: "Radarr" or "Sonarr" |
72 | apikey: "01234deb70424befb1f4ef6a23456789" | |
4399f5fa | 73 | ``` |
1d3287dc | 74 | |
4399f5fa | 75 | The url must be the root url of Radarr/Sonarr application. |
76 | The Radarr/Sonarr API key can be found in Settings > General. It is needed to access the API. | |
92d899bd | 77 | |
92d899bd BW |
78 | ## PaperlessNG |
79 | ||
80 | For Paperless you need an API-Key which you have to store at the item in the field `apikey`. | |
81 | ||
92d899bd BW |
82 | ## Ping |
83 | ||
b2f6da03 SK |
84 | For Ping you need to set the type to Ping and provide a url. |
85 | ||
e58461ff | 86 | ```yaml |
3acfb01d BW |
87 | - name: "Awesome app" |
88 | type: Ping | |
89 | logo: "assets/tools/sample.png" | |
90 | subtitle: "Bookmark example" tag: "app" | |
91 | url: "https://www.reddit.com/r/selfhosted/" | |
e58461ff | 92 | ``` |