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