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