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