From ae7873ac736844c88324b9403c2138bcf7e6831f Mon Sep 17 00:00:00 2001 From: Zeno Jiricek Date: Sat, 25 Nov 2023 07:01:47 +1030 Subject: [PATCH 1/4] docs(readarr): update README.md with clearer instructions about configuration This changes makes it clearer as to where and what can be done with configuration for readarr --- readarr/README.md | 25 +++++++++++++++++-------- 1 file changed, 17 insertions(+), 8 deletions(-) diff --git a/readarr/README.md b/readarr/README.md index 034bda70c..5f82da165 100644 --- a/readarr/README.md +++ b/readarr/README.md @@ -1,4 +1,4 @@ -## ⚠ Open Issue : [🐛 [readarr] Update info page with better information (opened 2023-11-22)](https://github.com/alexbelgium/hassio-addons/issues/1088) by [@airtonix](https://github.com/airtonix) +## ⚠ Open Issue : [🐛 [readarr] config can be done in ui except for .... (opened 2023-11-22)](https://github.com/alexbelgium/hassio-addons/issues/1088) by [@airtonix](https://github.com/airtonix) ## ⚠ Open Issue : [🐛 [readarr] First install, config directory is created in wrong location (opened 2023-11-22)](https://github.com/alexbelgium/hassio-addons/issues/1089) by [@airtonix](https://github.com/airtonix) # Home assistant add-on: readarr @@ -42,16 +42,17 @@ The installation of this add-on is pretty straightforward and not different in c 1. Check the logs of the add-on to see if everything went well. 1. Open the webUI and adapt the software options -## Configuration - ---- +## Usage Webui can be found at or with ingress. + The default username/password : described in the startup log. +## Configuration + Options can be configured through three ways : -- Addon options +### Addon options ```yaml PGID: user @@ -63,11 +64,19 @@ cifsusername: "username" # optional, smb username, same for all smb shares cifspassword: "password" # optional, smb password ``` -- Webui : all normal configuration from the app +### Webui -- Config.yaml (advanced usage) +All normal configuration from within the app -Additional variables can be set as ENV variables by adding them in the config.yaml in the location defined in your addon options according to this guide : https://github.com/alexbelgium/hassio-addons/wiki/Add%E2%80%90ons-feature-:-add-env-variables +### `/config/addons_config/readarr_nas.yml` + +For more control, you can add enviroment variables by defining them as keys in a valid `.yaml` file. + +```yaml +TZ: Europe/Paris +``` + +more info : https://github.com/alexbelgium/hassio-addons/wiki/Add%E2%80%90ons-feature-:-add-env-variables ## Support From 15d0bc0bf00e68e2f09b7dc447d0cecdcffbce10 Mon Sep 17 00:00:00 2001 From: Zeno Jiricek Date: Sat, 25 Nov 2023 07:03:09 +1030 Subject: [PATCH 2/4] Update README.md --- readarr/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/readarr/README.md b/readarr/README.md index 5f82da165..ebd46b592 100644 --- a/readarr/README.md +++ b/readarr/README.md @@ -1,4 +1,4 @@ -## ⚠ Open Issue : [🐛 [readarr] config can be done in ui except for .... (opened 2023-11-22)](https://github.com/alexbelgium/hassio-addons/issues/1088) by [@airtonix](https://github.com/airtonix) +## ⚠ Open Issue : [🐛 [readarr] Update info page with better information (opened 2023-11-22)](https://github.com/alexbelgium/hassio-addons/issues/1088) by [@airtonix](https://github.com/airtonix) ## ⚠ Open Issue : [🐛 [readarr] First install, config directory is created in wrong location (opened 2023-11-22)](https://github.com/alexbelgium/hassio-addons/issues/1089) by [@airtonix](https://github.com/airtonix) # Home assistant add-on: readarr From d2e59143475385c33613d2d3282700477584859c Mon Sep 17 00:00:00 2001 From: Zeno Jiricek Date: Sat, 25 Nov 2023 07:15:31 +1030 Subject: [PATCH 3/4] Update README.md --- readarr/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/readarr/README.md b/readarr/README.md index ebd46b592..4f2a7f727 100644 --- a/readarr/README.md +++ b/readarr/README.md @@ -64,11 +64,11 @@ cifsusername: "username" # optional, smb username, same for all smb shares cifspassword: "password" # optional, smb password ``` -### Webui +### Within readarr itself All normal configuration from within the app -### `/config/addons_config/readarr_nas.yml` +### The ENV override file: `/config/addons_config/readarr_nas.yml` For more control, you can add enviroment variables by defining them as keys in a valid `.yaml` file. From 7b5456c5a518fa867ec983beb96e954f8004e07e Mon Sep 17 00:00:00 2001 From: Zeno Jiricek Date: Sat, 25 Nov 2023 07:16:47 +1030 Subject: [PATCH 4/4] Update README.md --- readarr/README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/readarr/README.md b/readarr/README.md index 4f2a7f727..5c4d6cfba 100644 --- a/readarr/README.md +++ b/readarr/README.md @@ -44,7 +44,8 @@ The installation of this add-on is pretty straightforward and not different in c ## Usage -Webui can be found at or with ingress. +Webui can be found at or with ingress ☝️ by clicking the `Open Web UI` button. + The default username/password : described in the startup log.