]>
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 | ||
80ba98cf | 9 | |
3acfb01d BW |
10 | ## Common options |
11 | ||
12 | ```yaml | |
80ba98cf AB |
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. | |
66a434e7 | 17 | useCredentials: false # Optional: Override global proxy.useCredentials configuration. |
80ba98cf | 18 | type: "<type>" |
3acfb01d BW |
19 | ``` |
20 | ||
fd12de9e DW |
21 | ## PiHole |
22 | ||
23 | Using the PiHole service you can display info about your local PiHole instance right on your Homer dashboard. | |
24 | ||
25 | The following configuration is available for the PiHole service. | |
26 | ||
1d3287dc | 27 | ```yaml |
3acfb01d BW |
28 | - name: "Pi-hole" |
29 | logo: "assets/tools/sample.png" | |
30 | # subtitle: "Network-wide Ad Blocking" # optional, if no subtitle is defined, PiHole statistics will be shown | |
31 | url: "http://192.168.0.151/admin" | |
32 | type: "PiHole" | |
fd12de9e DW |
33 | ``` |
34 | ||
35 | ## OpenWeatherMap | |
36 | ||
37 | Using the OpenWeatherMap service you can display weather information about a given location. | |
f11b1c9d | 38 | The following configuration is available for the OpenWeatherMap service: |
fd12de9e | 39 | |
1d3287dc | 40 | ```yaml |
3acfb01d BW |
41 | - name: "Weather" |
42 | location: "Amsterdam" # your location. | |
43 | locationId: "2759794" # Optional: Specify OpenWeatherMap city ID for better accuracy | |
487f954a | 44 | apikey: "<---insert-api-key-here--->" # insert your own API key here. Request one from https://openweathermap.org/api. |
3acfb01d BW |
45 | units: "metric" # units to display temperature. Can be one of: metric, imperial, kelvin. Defaults to kelvin. |
46 | background: "square" # choose which type of background you want behind the image. Can be one of: square, cicle, none. Defaults to none. | |
47 | type: "OpenWeather" | |
fd12de9e | 48 | ``` |
97f0c43c DW |
49 | |
50 | **Remarks:** | |
92d5b8d4 BW |
51 | 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). |
52 | ||
4399f5fa | 53 | ## Medusa |
54 | ||
55 | This service displays News (grey), Warning (orange) or Error (red) notifications bubbles from the Medusa application. | |
56 | Two lines are needed in the config.yml : | |
1d3287dc BW |
57 | |
58 | ```yaml | |
3acfb01d BW |
59 | type: "Medusa" |
60 | apikey: "01234deb70424befb1f4ef6a23456789" | |
4399f5fa | 61 | ``` |
1d3287dc | 62 | |
4399f5fa | 63 | The url must be the root url of Medusa application. |
64 | The Medusa API key can be found in General configuration > Interface. It is needed to access Medusa API. | |
65 | ||
0121fa80 | 66 | ## Lidarr, Sonarr and Radarr |
4399f5fa | 67 | |
0121fa80 | 68 | This service displays Activity (blue), Warning (orange) or Error (red) notifications bubbles from the Lidarr, Radarr or Sonarr application. |
4399f5fa | 69 | Two lines are needed in the config.yml : |
1d3287dc BW |
70 | |
71 | ```yaml | |
0121fa80 | 72 | type: "Lidarr", "Radarr" or "Sonarr" |
3acfb01d | 73 | apikey: "01234deb70424befb1f4ef6a23456789" |
4399f5fa | 74 | ``` |
1d3287dc | 75 | |
0121fa80 PH |
76 | The url must be the root url of Lidarr, Radarr or Sonarr application. |
77 | The Lidarr, Radarr or Sonarr API key can be found in Settings > General. It is needed to access the API. | |
92d899bd | 78 | |
92d899bd BW |
79 | ## PaperlessNG |
80 | ||
168f157c A |
81 | This service displays total number of documents stored. Two lines are required: |
82 | ||
83 | ```yaml | |
84 | type: "PaperlessNG" | |
85 | apikey: "0123456789abcdef123456789abcdef" | |
86 | ``` | |
87 | ||
88 | API key can be generated in Settings > Administration > Auth Tokens | |
92d899bd | 89 | |
92d899bd BW |
90 | ## Ping |
91 | ||
b2f6da03 SK |
92 | For Ping you need to set the type to Ping and provide a url. |
93 | ||
e58461ff | 94 | ```yaml |
3acfb01d BW |
95 | - name: "Awesome app" |
96 | type: Ping | |
97 | logo: "assets/tools/sample.png" | |
400cdb8f H |
98 | subtitle: "Bookmark example" |
99 | tag: "app" | |
100 | url: "https://www.reddit.com/r/selfhosted/" | |
e58461ff | 101 | ``` |
277dafaf AB |
102 | |
103 | ## Prometheus | |
104 | ||
105 | For Prometheus you need to set the type to Prometheus and provide a url. | |
106 | ||
107 | ```yaml | |
108 | - name: "Prometheus" | |
109 | type: Prometheus | |
110 | logo: "assets/tools/sample.png" | |
111 | url: "http://192.168.0.151/" | |
112 | # subtitle: "Monitor data server" | |
113 | ``` |