aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
-rw-r--r--README.md8
-rw-r--r--docs/configuration.md13
-rw-r--r--docs/customservices.md14
3 files changed, 14 insertions, 21 deletions
diff --git a/README.md b/README.md
index 945fa1f..9441798 100644
--- a/README.md
+++ b/README.md
@@ -43,8 +43,8 @@
43- [Features](#features) 43- [Features](#features)
44- [Getting started](#getting-started) 44- [Getting started](#getting-started)
45- [Configuration](docs/configuration.md) 45- [Configuration](docs/configuration.md)
46- [Custom services](docs/customservices.md)
46- [Tips & tricks](docs/tips-and-tricks.md) 47- [Tips & tricks](docs/tips-and-tricks.md)
47- [Roadmap](#roadmap)
48- [Development](docs/development.md) 48- [Development](docs/development.md)
49 49
50 50
@@ -134,9 +134,3 @@ npm run build
134``` 134```
135 135
136Then your dashboard is ready to use in the `/dist` directory. 136Then your dashboard is ready to use in the `/dist` directory.
137
138
139## Roadmap
140
141- [ ] Add new themes.
142- [ ] Add support for custom service card (add custom feature to some service / app link)
diff --git a/docs/configuration.md b/docs/configuration.md
index ce36c51..a472b41 100644
--- a/docs/configuration.md
+++ b/docs/configuration.md
@@ -167,16 +167,3 @@ In order to easily generate all required icon preset for the PWA to work, a tool
167```bash 167```bash
168npx vue-pwa-asset-generator -a {your_512x512_source_png} -o {your_output_folder} 168npx vue-pwa-asset-generator -a {your_512x512_source_png} -o {your_output_folder}
169``` 169```
170
171### Supported services
172
173Currently 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.
174
175- PiHole
176- AdGuardHome
177- PaperlessNG
178
179### Additional configuration
180
181#### Paperless
182For Paperless you need an API-Key which you have to store at the item in the field `apikey`. \ No newline at end of file
diff --git a/docs/customservices.md b/docs/customservices.md
index d2deff4..43f45f4 100644
--- a/docs/customservices.md
+++ b/docs/customservices.md
@@ -1,6 +1,8 @@
1# Custom Services 1# Custom Services
2 2
3Here is an overview of all custom services that are available within Homer. 3Some service can use a specific a component that provides some extra features by adding a `type` key to the service yaml
4configuration. Available services are in `src/components/`. Here is an overview of all custom services that are available
5within Homer.
4 6
5## PiHole 7## PiHole
6 8
@@ -39,3 +41,13 @@ apikey: "01234deb70424befb1f4ef6a23456789"
39``` 41```
40The url must be the root url of Radarr/Sonarr application. 42The url must be the root url of Radarr/Sonarr application.
41The Radarr/Sonarr API key can be found in Settings > General. It is needed to access the API. 43The Radarr/Sonarr API key can be found in Settings > General. It is needed to access the API.
44
45
46## PaperlessNG
47
48For Paperless you need an API-Key which you have to store at the item in the field `apikey`.
49
50
51## Ping
52
53For Paperless you need an API-Key which you have to store at the item in the field `apikey`.