mirror of
https://github.com/bastienwirtz/homer.git
synced 2024-12-25 16:19:04 +01:00
regroup service documentation
This commit is contained in:
parent
c06c0cdf9b
commit
92d899bd48
@ -43,8 +43,8 @@
|
||||
- [Features](#features)
|
||||
- [Getting started](#getting-started)
|
||||
- [Configuration](docs/configuration.md)
|
||||
- [Custom services](docs/customservices.md)
|
||||
- [Tips & tricks](docs/tips-and-tricks.md)
|
||||
- [Roadmap](#roadmap)
|
||||
- [Development](docs/development.md)
|
||||
|
||||
|
||||
@ -134,9 +134,3 @@ npm run build
|
||||
```
|
||||
|
||||
Then your dashboard is ready to use in the `/dist` directory.
|
||||
|
||||
|
||||
## Roadmap
|
||||
|
||||
- [ ] Add new themes.
|
||||
- [ ] Add support for custom service card (add custom feature to some service / app link)
|
||||
|
@ -167,16 +167,3 @@ In order to easily generate all required icon preset for the PWA to work, a tool
|
||||
```bash
|
||||
npx vue-pwa-asset-generator -a {your_512x512_source_png} -o {your_output_folder}
|
||||
```
|
||||
|
||||
### Supported services
|
||||
|
||||
Currently the following services are supported for showing quick infos on the card. They can be used by setting the type to one of the following values at the item.
|
||||
|
||||
- PiHole
|
||||
- AdGuardHome
|
||||
- PaperlessNG
|
||||
|
||||
### Additional configuration
|
||||
|
||||
#### Paperless
|
||||
For Paperless you need an API-Key which you have to store at the item in the field `apikey`.
|
@ -1,6 +1,8 @@
|
||||
# Custom Services
|
||||
|
||||
Here is an overview of all custom services that are available within Homer.
|
||||
Some service can use a specific a component that provides some extra features by adding a `type` key to the service yaml
|
||||
configuration. Available services are in `src/components/`. Here is an overview of all custom services that are available
|
||||
within Homer.
|
||||
|
||||
## PiHole
|
||||
|
||||
@ -39,3 +41,13 @@ apikey: "01234deb70424befb1f4ef6a23456789"
|
||||
```
|
||||
The url must be the root url of Radarr/Sonarr application.
|
||||
The Radarr/Sonarr API key can be found in Settings > General. It is needed to access the API.
|
||||
|
||||
|
||||
## PaperlessNG
|
||||
|
||||
For Paperless you need an API-Key which you have to store at the item in the field `apikey`.
|
||||
|
||||
|
||||
## Ping
|
||||
|
||||
For Paperless you need an API-Key which you have to store at the item in the field `apikey`.
|
||||
|
Loading…
Reference in New Issue
Block a user