diff --git a/.claude/settings.local.json b/.claude/settings.local.json index 861ea1e7f..9b665235b 100644 --- a/.claude/settings.local.json +++ b/.claude/settings.local.json @@ -2,7 +2,8 @@ "permissions": { "allow": [ "Bash(mkdir:*)", - "Bash(cp:*)" + "Bash(cp:*)", + "Bash(find:*)" ], "deny": [] } diff --git a/emby/README.md b/emby/README.md index 33b7fe449..2e301cbf6 100644 --- a/emby/README.md +++ b/emby/README.md @@ -31,18 +31,42 @@ Inital addon version : https://github.com/petersendev/hassio-addons Webui can be found at `:8096`, or within Home Assistant through Ingress. +### 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 | +| `smbv1` | bool | `false` | Enable SMB v1 protocol | +| `silent` | bool | `false` | Suppress debug messages | + +### 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 -cifsdomain: "domain" # optional, allow setting the domain for the smb share -silent: true #suppresses debug messages +PGID: 0 +PUID: 0 +TZ: "Europe/London" +localdisks: "sda1,sdb1" +networkdisks: "//192.168.1.100/media,//nas.local/movies" +cifsusername: "mediauser" +cifspassword: "password123" +cifsdomain: "workgroup" +silent: false ``` +### 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/filebrowser/README.md b/filebrowser/README.md index c29d3c6b9..f0ed8a52c 100644 --- a/filebrowser/README.md +++ b/filebrowser/README.md @@ -27,24 +27,57 @@ This addon is based on the [docker image](https://hub.docker.com/r/filebrowser/f ## Configuration -Webui can be found at at the port that you map to 8080 in the addon's options. +Webui can be found at or through the sidebar using Ingress. Default username: "admin" and password: "admin" Network disk is mounted to `/share/storagecifs`. +### 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/`) | +| `NoAuth` | bool | `true` | Disable authentication (resets database when changed) | +| `disable_thumbnails` | bool | `true` | Disable thumbnail generation for speed | +| `base_folder` | str | `/` | Root folder for file browser | +| `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 -ssl: true/false -certfile: fullchain.pem #ssl certificate -keyfile: privkey.pem #sslkeyfile -NoAuth: true/false #Remove password. Resets database when changed. -disable_thumbnails : true/false (set disable_thumbnails to true or false ; default true for speed) -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 smbv2/3 servers to mount, separated by commas -cifsusername: "username" # optional, smb username, same for all smb shares -cifspassword: "password" # optional, smb password, same for all smb shares) -base_folder: root folder # optional, default is / +ssl: true +certfile: "fullchain.pem" +keyfile: "privkey.pem" +NoAuth: false +disable_thumbnails: false +base_folder: "/share" +localdisks: "sda1,sdb1" +networkdisks: "//192.168.1.100/files,//nas.local/documents" +cifsusername: "fileuser" +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) + +### 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) + ## Installation The installation of this add-on is pretty straightforward and not different in diff --git a/immich/README.md b/immich/README.md index 7b166866d..84a36ac20 100644 --- a/immich/README.md +++ b/immich/README.md @@ -30,26 +30,55 @@ This addon is based on the [docker image](https://github.com/imagegenius/docker- ## Configuration -Postgresql can be either internal or external +Webui can be found at `:8080`. PostgreSQL/MySQL can be either internal or external. + +### Options + +| Option | Type | Default | Description | +|--------|------|---------|-------------| +| `data_location` | str | `/share/immich` | Path where Immich data is stored | +| `library_location` | str | | Path to photo/video library | +| `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 | +| `DB_HOSTNAME` | str | `localhost` | Database hostname | +| `DB_USERNAME` | str | `immich` | Database username | +| `DB_PASSWORD` | str | | Database password | +| `DB_DATABASE_NAME` | str | `immich` | Database name | +| `DB_PORT` | int | `5432` | Database port | +| `DB_ROOT_PASSWORD` | str | | Database root password | +| `JWT_SECRET` | str | | JWT secret for authentication | +| `DISABLE_MACHINE_LEARNING` | bool | `false` | Disable ML features | +| `MACHINE_LEARNING_WORKERS` | int | `1` | Number of ML workers | +| `MACHINE_LEARNING_WORKER_TIMEOUT` | int | `120` | ML worker timeout (seconds) | + +### Example Configuration ```yaml - "PGID": "int", - "PUID": "int", - "TZ": "str?", - "cifsdomain": "str?", - "cifspassword": "str?", - "cifsusername": "str?", - "data_location": "str", - "localdisks": "str?", - "networkdisks": "str?", - "DB_HOSTNAME": "str?", - "DB_USERNAME": "str?", - "DB_PORT": "int?", - "DB_PASSWORD": "str?", - "DB_DATABASE_NAME": "str?", - "JWT_SECRET": "str?" +data_location: "/share/immich" +library_location: "/media/photos" +TZ: "Europe/London" +localdisks: "sda1,sdb1" +networkdisks: "//192.168.1.100/photos" +cifsusername: "photouser" +cifspassword: "password123" +DB_HOSTNAME: "core-mariadb" +DB_USERNAME: "immich" +DB_PASSWORD: "secure_password" +DB_DATABASE_NAME: "immich" +JWT_SECRET: "your-secret-key-here" ``` +### 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/jellyfin/README.md b/jellyfin/README.md index 32c673631..ef374621b 100644 --- a/jellyfin/README.md +++ b/jellyfin/README.md @@ -28,22 +28,61 @@ This addon is based on the [docker image](https://github.com/linuxserver/docker- ## Configuration -### Addon config +Webui can be found at `:8096` or through the sidebar using Ingress. -Webui can be found at `:8096`. +### 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`) | +| `data_location` | str | `/share/jellyfin` | Path where Jellyfin data is stored | +| `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 | +| `DOCKER_MODS` | list | | Additional Docker mods for hardware acceleration | + +### 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 -cifsdomain: "domain" # optional, allow setting the domain for the smb share -DOCKER_MODS: linuxserver/mods:jellyfin-opencl-intel|linuxserver/mods:jellyfin-amd|linuxserver/mods:jellyfin-rffmpeg # Install graphic drivers +PGID: 0 +PUID: 0 +TZ: "Europe/London" +data_location: "/share/jellyfin" +localdisks: "sda1,sdb1" +networkdisks: "//192.168.1.100/media,//nas.local/movies" +cifsusername: "mediauser" +cifspassword: "password123" +cifsdomain: "workgroup" +DOCKER_MODS: + - "linuxserver/mods:jellyfin-opencl-intel" + - "linuxserver/mods:jellyfin-amd" ``` +### Hardware Acceleration + +Available Docker mods for hardware acceleration: +- `linuxserver/mods:jellyfin-opencl-intel` - Intel OpenCL support +- `linuxserver/mods:jellyfin-amd` - AMD hardware acceleration +- `linuxserver/mods:jellyfin-rffmpeg` - Custom FFmpeg build + +### 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) + +### 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) + ### Enable ssl #### Creating the PFX certificate file first 1. This part assumes you already have SSL certs in PEM format using the Let's Encrypt add on diff --git a/nextcloud/README.md b/nextcloud/README.md index eed4fcfc6..a720ced99 100644 --- a/nextcloud/README.md +++ b/nextcloud/README.md @@ -31,57 +31,93 @@ This addon is based on the [docker image](https://github.com/linuxserver/docker- ## Configuration -### Custom scripts +Webui can be found at `:port`. + +### Options + +| Option | Type | Default | Description | +|--------|------|---------|-------------| +| `PGID` | int | `1000` | Group ID for file permissions | +| `PUID` | int | `1000` | User ID for file permissions | +| `TZ` | str | | Timezone (e.g., `Europe/London`) | +| `additional_apps` | str | | Additional APK packages to install (comma-separated) | +| `trusted_domains` | str | | Trusted domains for Nextcloud access | +| `use_own_certs` | bool | `false` | Use custom SSL certificates | +| `certfile` | str | `fullchain.pem` | SSL certificate file (in `/ssl/`) | +| `keyfile` | str | `privkey.pem` | SSL private key file (in `/ssl/`) | +| `OCR` | bool | `false` | Enable Tesseract OCR capability | +| `OCRLANG` | str | | OCR languages (e.g., `fra,eng`) | +| `Full_Text_Search` | bool | `false` | Enable full-text search with Elasticsearch | +| `elasticsearch_server` | str | | Elasticsearch server address (ip:port) | +| `enable_thumbnails` | bool | `true` | Enable thumbnail generation | +| `default_phone_region` | str | | Default phone region (ISO 3166-1 alpha-2) | +| `disable_updates` | bool | `false` | Prevent automatic app updates | +| `env_memory_limit` | str | `512M` | PHP memory limit | +| `env_post_max_size` | str | `512M` | Maximum POST size | +| `env_upload_max_filesize` | str | `512M` | Maximum upload file size | +| `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 | +| `skip_permissions_check` | bool | `false` | Skip file permissions checking | + +### Example Configuration + +```yaml +PGID: 1000 +PUID: 1000 +TZ: "Europe/London" +additional_apps: "vim,curl" +trusted_domains: "nextcloud.example.com,192.168.1.100" +use_own_certs: true +certfile: "fullchain.pem" +keyfile: "privkey.pem" +OCR: true +OCRLANG: "eng,fra,deu" +enable_thumbnails: true +env_memory_limit: "1024M" +localdisks: "sda1,sdb1" +networkdisks: "//192.168.1.100/nextcloud" +cifsusername: "nextcloud_user" +cifspassword: "password123" +``` + +### 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) + +### 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) + +### Custom Script Example + +Create `/config/addons_autoscripts/nextcloud-ocr.sh` for custom initialization: -/config/addons_autoscripts/nextcloud-ocr.sh will be executed at boot. -To run custom commands at boot you can try a code such as : ```bash #!/usr/bin/with-contenv bashio # shellcheck shell=bash -################# -# CODE INJECTOR # -################# +# Custom script executed at addon start +# Runs only after initialization is done -# Any commands written in this bash script will be executed at addon start -# See guide here : https://github.com/alexbelgium/hassio-addons/wiki/Add%E2%80%90ons-feature-:-customisation - -# Runs only after initialization done -# shellcheck disable=SC2128 mkdir -p /scripts -if [ ! -f /app/www/public/occ ]; then cp /config/addons_autoscripts/"$(basename "${BASH_SOURCE}")" /scripts/ && exit 0; fi +if [ ! -f /app/www/public/occ ]; then + cp /config/addons_autoscripts/"$(basename "${BASH_SOURCE}")" /scripts/ && exit 0 +fi echo "Scanning files" sudo -u abc php /app/www/public/occ files:scan --all -echo "This is done !" +echo "File scan completed!" ``` -### Addon options - -```yaml -default_phone_region: EN # Define the default phone region according to https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements -disable_updates: prevent automatic apps updating along addon -additional_apps: vim,nextcloud #specify additional apk files to install ; separated by commas -PGID/PUID: 1000 #allows setting user. -trusted_domains: your-domain.com #allows to select the trusted domains. Domains not in this lis will be removed, except for the first one used in the initial configuration. -OCR: false #set to true to install tesseract-ocr capability. -OCRLANG: fra,eng #Any language can be set from this page (always three letters) [here](https://tesseract-ocr.github.io/tessdoc/Data-Files#data-files-for-version-400-november-29-2016). -data_directory: path for the main data directory. Defaults to `/config/data`. Only used to set permissions and prefill the initial installation template. Once initial installation is done it can't be changed -enable_thumbnails: true/false # enable generations of thumbnails for media file (to disable for older systems) -use_own_certs: true/false #if true, use the certfile and keyfile specified -certfile: fullchain.pem #ssl certificate, must be located in /ssl -keyfile: privkey.pem #sslkeyfile, must be located in /ssl -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 smbv2/3 servers to mount, separated by commas -cifsusername: "username" # optional, smb username, same for all smb shares -cifspassword: "password" # optional, smb password, same for all smb shares) -env_memory_limit: nextcloud usable memory limit (default is 512M) -env_post_max_size: nextcloud post size (default is 512M) -env_upload_max_filesize; nextcloud upload size (default is 512M) -``` - -Webui can be found at `:port`. - ### Change the temp folder to avoid bloating emmc on HA systems (thanks @senna1992) See ; https://github.com/alexbelgium/hassio-addons/discussions/1370 @@ -134,3 +170,4 @@ See this component : https://www.home-assistant.io/integrations/nextcloud/ [repository]: https://github.com/alexbelgium/hassio-addons [elasticsearch-shield]: https://img.shields.io/badge/Elasticsearch-optional-blue.svg?logo=elasticsearch +continu \ No newline at end of file diff --git a/plex/README.md b/plex/README.md index d42cd08e0..32f2a6ed6 100644 --- a/plex/README.md +++ b/plex/README.md @@ -37,18 +37,43 @@ This addon is based on the [docker image](https://github.com/linuxserver/docker- Webui can be found at `:32400`. +### 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`) | +| `claim` | str | | Plex claim token from https://plex.tv/claim | +| `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 | +| `smbv1` | bool | `false` | Enable SMB v1 protocol | +| `skip_permissions_check` | bool | `false` | Skip file permissions checking | + +### Example Configuration + ```yaml -PGID: user -GPID: user -TZ: timezone -claim: claim code for plex server # see https://github.com/linuxserver/docker-plex -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 -cifsdomain: "domain" # optional, allow setting the domain for the smb share +PGID: 0 +PUID: 0 +TZ: "Europe/London" +claim: "Get_from_https://www.plex.tv/claim" +localdisks: "sda1,sdb1" +networkdisks: "//192.168.1.100/media,//nas.local/movies" +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/qbittorrent/README.md b/qbittorrent/README.md index 7da5036c4..87ee8c76f 100644 --- a/qbittorrent/README.md +++ b/qbittorrent/README.md @@ -42,37 +42,74 @@ This addons has several configurable options : --- 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 +The default username/password is described in the startup log. -Network disk is mounted to /mnt/share name +Network disk is mounted to `/mnt/`. You need to map the exposed port in your router for best speed and connectivity. -You need to map the exposed port in your router if you want the best speed and connectivity. +### 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`) | +| `Username` | str | `admin` | Admin username for web interface | +| `SavePath` | str | `/share/qBittorrent` | Default download directory | +| `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/`) | +| `whitelist` | str | `localhost,127.0.0.1,...` | IP subnets that don't need password | +| `customUI` | list | `vuetorrent` | Alternative web UI (default/vuetorrent/qbit-matUI/qb-web/custom) | +| `DNS_server` | str | `8.8.8.8,1.1.1.1` | Custom DNS servers | +| `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 | +| `openvpn_enabled` | bool | `false` | Enable OpenVPN connection | +| `openvpn_config` | str | | OpenVPN config file name (in `/config/openvpn/`) | +| `openvpn_username` | str | | OpenVPN username | +| `openvpn_password` | str | | OpenVPN password | +| `openvpn_alt_mode` | bool | `false` | Bind at container level instead of app level | +| `qbit_manage` | bool | `false` | Enable qBit Manage integration | +| `run_duration` | str | | Run duration (e.g., `12h`, `5d`) | +| `silent` | bool | `false` | Suppress debug messages | + +### Example Configuration ```yaml -PGID: user -GPID: user -ssl: true/false -certfile: fullchain.pem #ssl certificate, must be located in /ssl -keyfile: privkey.pem #sslkeyfile, must be located in /ssl -whitelist: "localhost,192.168.0.0/16" # Type `null` to disable. List ip subnets that won't need a password (optional) -customUI: selection from list # alternative webUI can be set here. Latest version set at each addon start. Select 'custom' to fill it yourself in the webui -DNS_servers: 8.8.8.8,1.1.1.1 # Keep blank to use router’s DNS, or set custom DNS to avoid spamming in case of local DNS ad-remover -SavePath: "/share/qbittorrent" # Define the download directory -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 -cifsdomain: "domain" # optional, allow setting the domain for the smb share -openvpn_enabled: true/false # is openvpn required to start qbittorrent -openvpn_config": For example "config.ovpn" # name of the file located in /config/openvpn. If empty, a random one will be used -openvpn_username": USERNAME -openvpn_password: YOURPASSWORD -openvpn_alt_mode: bind at container level and not app level -run_duration: 12h #for how long should the addon run. Must be formatted as number + time unit (ex : 5s, or 2m, or 12h, or 5d...) -silent: true #suppresses debug messages +PGID: 0 +PUID: 0 +TZ: "Europe/London" +Username: "admin" +SavePath: "/share/qBittorrent" +ssl: true +certfile: "fullchain.pem" +keyfile: "privkey.pem" +whitelist: "localhost,192.168.0.0/16" +customUI: "vuetorrent" +DNS_server: "8.8.8.8,1.1.1.1" +localdisks: "sda1,sdb1" +networkdisks: "//192.168.1.100/downloads" +cifsusername: "username" +cifspassword: "password" +openvpn_enabled: false ``` +### 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) + +### 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) + ## Installation --- diff --git a/radarr/README.md b/radarr/README.md index c355d871c..65de172df 100644 --- a/radarr/README.md +++ b/radarr/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/movies" +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