diff --git a/sonarr/README.md b/sonarr/README.md index 55c3c8d58..f799357a4 100644 --- a/sonarr/README.md +++ b/sonarr/README.md @@ -45,23 +45,50 @@ The installation of this add-on is pretty straightforward and not different in c ## Configuration ---- +Webui can be found at or through the sidebar using Ingress. +Configurations can be done through the app webUI, except for the following options. -Webui can be found at . -The default username/password : described in the startup log. -Configurations can be done through the app webUI, except for the following options +### Options + +| Option | Type | Default | Description | +|--------|------|---------|-------------| +| `PGID` | int | `0` | Group ID for file permissions | +| `PUID` | int | `0` | User ID for file permissions | +| `TZ` | str | | Timezone (e.g., `Europe/London`) | +| `connection_mode` | list | `ingress_noauth` | Connection mode (ingress_noauth/noingress_auth/ingress_auth) | +| `localdisks` | str | | Local drives to mount (e.g., `sda1,sdb1,MYNAS`) | +| `networkdisks` | str | | SMB shares to mount (e.g., `//SERVER/SHARE`) | +| `cifsusername` | str | | SMB username for network shares | +| `cifspassword` | str | | SMB password for network shares | +| `cifsdomain` | str | | SMB domain for network shares | + +### Connection Modes + +- `ingress_noauth` - Default, disables authentication for seamless ingress integration +- `noingress_auth` - Disables ingress for external URL, enables authentication +- `ingress_auth` - Enables both ingress and authentication + +### Example Configuration ```yaml -PGID: user -GPID: user -TZ: timezone -localdisks: sda1 #put the hardware name of your drive to mount separated by commas, or its label. ex. sda1, sdb1, MYNAS... -networkdisks: "//SERVER/SHARE" # optional, list of smb servers to mount, separated by commas -cifsusername: "username" # optional, smb username, same for all smb shares -cifspassword: "password" # optional, smb password -connection_mode: ingress_noauth (default, disables authentification to allow a seamless ingress integration), noingress_auth (disables ingress to allow a simpler external url, enables authentification), ingress_auth (enables both ingress and authentification) +PGID: 0 +PUID: 0 +TZ: "Europe/London" +connection_mode: "ingress_noauth" +localdisks: "sda1,sdb1" +networkdisks: "//192.168.1.100/downloads,//nas.local/tv" +cifsusername: "mediauser" +cifspassword: "password123" +cifsdomain: "workgroup" ``` +### Mounting Drives + +This addon supports mounting both local drives and remote SMB shares: + +- **Local drives**: See [Mounting Local Drives in Addons](https://github.com/alexbelgium/hassio-addons/wiki/Mounting-Local-Drives-in-Addons) +- **Remote shares**: See [Mounting Remote Shares in Addons](https://github.com/alexbelgium/hassio-addons/wiki/Mounting-remote-shares-in-Addons) + ## Support Create an issue on github