From fbebb724ac3d3afdfb390e6e7f1b605d2c4a875b Mon Sep 17 00:00:00 2001 From: Alexandre Date: Fri, 1 Aug 2025 22:02:35 +0200 Subject: [PATCH] Claudify --- bazarr/README.md | 41 +++++++++++++++++++++++++++++++---------- jackett/README.md | 40 ++++++++++++++++++++++++++++++++-------- nzbget/README.md | 43 +++++++++++++++++++++++++++++++++---------- portainer/README.md | 31 +++++++++++++++++++++++-------- sabnzbd/README.md | 43 +++++++++++++++++++++++++++++++++---------- 5 files changed, 152 insertions(+), 46 deletions(-) diff --git a/bazarr/README.md b/bazarr/README.md index 816bc7e90..5f33d61f2 100644 --- a/bazarr/README.md +++ b/bazarr/README.md @@ -29,21 +29,42 @@ This addon is based on the docker image https://github.com/linuxserver/docker-ba ## 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 . -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`) | +| `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 | + +### 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 +PGID: 0 +PUID: 0 +TZ: "Europe/London" +localdisks: "sda1,sdb1" +networkdisks: "//192.168.1.100/media,//nas.local/subtitles" +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) + ## Installation --- diff --git a/jackett/README.md b/jackett/README.md index adde2cde5..6ec2161c9 100644 --- a/jackett/README.md +++ b/jackett/README.md @@ -28,18 +28,42 @@ This addon is based on the [docker image](https://github.com/linuxserver/docker- ## Configuration -Configurations can be done through the app webUI, except for the following options : +Webui can be found at the configured port or through the sidebar using Ingress. +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`) | +| `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 | + +### 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 +PGID: 0 +PUID: 0 +TZ: "Europe/London" +localdisks: "sda1,sdb1" +networkdisks: "//192.168.1.100/downloads" +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) + ## Installation The installation of this add-on is pretty straightforward and not different in diff --git a/nzbget/README.md b/nzbget/README.md index 4765aee62..7a02f0505 100644 --- a/nzbget/README.md +++ b/nzbget/README.md @@ -27,20 +27,43 @@ This addon is based on the docker image https://github.com/linuxserver/docker-nz ## Configuration -Webui can be found at . -The default username/password : login:nzbget, password:tegbzn6789 -Configurations can be done through the app webUI, except for the following options +Webui can be found at or through the sidebar using Ingress. +The default username/password: login:`nzbget`, password:`tegbzn6789` +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`) | +| `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 | + +### 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 +PGID: 0 +PUID: 0 +TZ: "Europe/London" +localdisks: "sda1,sdb1" +networkdisks: "//192.168.1.100/downloads,//nas.local/usenet" +cifsusername: "downloader" +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) + ## Installation The installation of this add-on is pretty straightforward and not different in comparison to installing any other add-on. diff --git a/portainer/README.md b/portainer/README.md index a36eec219..bbf4c53d7 100644 --- a/portainer/README.md +++ b/portainer/README.md @@ -63,19 +63,34 @@ The installation of this add-on is pretty straightforward and not different in c ## Configuration ---- +Webui can be found at or in your sidebar using Ingress. +The default username is "admin" and the password is described in the startup log. -Webui can be found at , or in your sidebar using Ingress. -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 | +|--------|------|---------|-------------| +| `ssl` | bool | `false` | Enable HTTPS for web interface | +| `certfile` | str | `fullchain.pem` | SSL certificate file (in `/ssl/`) | +| `keyfile` | str | `privkey.pem` | SSL private key file (in `/ssl/`) | +| `password` | str | `homeassistant` | Admin password (min 12 characters, leave blank to restore backup) | + +### Example Configuration ```yaml -ssl: true/false -certfile: fullchain.pem #ssl certificate, must be located in /ssl -keyfile: privkey.pem #sslkeyfile, must be located in /ssl -password: define admin password. If kept blank, will allow manual restore of previous backup. At least 12 characters. +ssl: true +certfile: "fullchain.pem" +keyfile: "privkey.pem" +password: "your-secure-password-123" ``` +### Custom Scripts and Environment Variables + +This addon supports custom scripts and environment variables through the `addon_config` mapping: + +- **Custom scripts**: See [Running Custom Scripts in Addons](https://github.com/alexbelgium/hassio-addons/wiki/Running-custom-scripts-in-Addons) +- **Environment variables**: See [Add Environment Variables to your Addon](https://github.com/alexbelgium/hassio-addons/wiki/Add-Environment-variables-to-your-Addon) + ## Support Create an issue on github diff --git a/sabnzbd/README.md b/sabnzbd/README.md index 1e7d6808b..f78f6e92d 100644 --- a/sabnzbd/README.md +++ b/sabnzbd/README.md @@ -27,20 +27,43 @@ This addon is based on the docker image https://github.com/linuxserver/docker-sa ## Configuration -Webui can be found at . -The default username/password : login:sabnzbd, password:tegbzn6789 -Configurations can be done through the app webUI, except for the following options +Webui can be found at or through the sidebar using Ingress. +The default username/password: login:`sabnzbd`, password:`tegbzn6789` +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`) | +| `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 | + +### 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 +PGID: 0 +PUID: 0 +TZ: "Europe/London" +localdisks: "sda1,sdb1" +networkdisks: "//192.168.1.100/downloads,//nas.local/usenet" +cifsusername: "downloader" +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) + ## Installation The installation of this add-on is pretty straightforward and not different in comparison to installing any other add-on.