diff options
author | Bastien Wirtz <bastien.wirtz@gmail.com> | 2021-07-14 15:48:57 +0200 |
---|---|---|
committer | Bastien Wirtz <bastien.wirtz@gmail.com> | 2021-07-14 15:48:57 +0200 |
commit | 92d899bd4809183f1cd1cec302d66fa32461aac5 (patch) | |
tree | 0ebdcd845d7ea88d61c1893821c1b2a12a280a9b | |
parent | c06c0cdf9bbdc98f71dadb5edcc015926ba878e4 (diff) | |
download | homer-92d899bd4809183f1cd1cec302d66fa32461aac5.tar.gz homer-92d899bd4809183f1cd1cec302d66fa32461aac5.tar.zst homer-92d899bd4809183f1cd1cec302d66fa32461aac5.zip |
regroup service documentation
-rw-r--r-- | README.md | 8 | ||||
-rw-r--r-- | docs/configuration.md | 13 | ||||
-rw-r--r-- | docs/customservices.md | 14 |
3 files changed, 14 insertions, 21 deletions
@@ -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 | ||
136 | Then your dashboard is ready to use in the `/dist` directory. | 136 | Then 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 |
168 | npx vue-pwa-asset-generator -a {your_512x512_source_png} -o {your_output_folder} | 168 | npx vue-pwa-asset-generator -a {your_512x512_source_png} -o {your_output_folder} |
169 | ``` | 169 | ``` |
170 | |||
171 | ### Supported services | ||
172 | |||
173 | 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. | ||
174 | |||
175 | - PiHole | ||
176 | - AdGuardHome | ||
177 | - PaperlessNG | ||
178 | |||
179 | ### Additional configuration | ||
180 | |||
181 | #### Paperless | ||
182 | For 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 | ||
3 | Here is an overview of all custom services that are available within Homer. | 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. | ||
4 | 6 | ||
5 | ## PiHole | 7 | ## PiHole |
6 | 8 | ||
@@ -39,3 +41,13 @@ apikey: "01234deb70424befb1f4ef6a23456789" | |||
39 | ``` | 41 | ``` |
40 | The url must be the root url of Radarr/Sonarr application. | 42 | The url must be the root url of Radarr/Sonarr application. |
41 | The Radarr/Sonarr API key can be found in Settings > General. It is needed to access the API. | 43 | The Radarr/Sonarr API key can be found in Settings > General. It is needed to access the API. |
44 | |||
45 | |||
46 | ## PaperlessNG | ||
47 | |||
48 | For Paperless you need an API-Key which you have to store at the item in the field `apikey`. | ||
49 | |||
50 | |||
51 | ## Ping | ||
52 | |||
53 | For Paperless you need an API-Key which you have to store at the item in the field `apikey`. | ||