diff --git a/changedetection.io/README.md b/changedetection.io/README.md index db5534f5d..80c154cb4 100644 --- a/changedetection.io/README.md +++ b/changedetection.io/README.md @@ -40,13 +40,24 @@ You can add a shortcut pointing to your Changedetection.io instance with the fol 3. Select the Webpage option, and paste the Web UI URL you got from the add-on page. 4. Fill in the title for the sidebar item, an icon (suggestion: `mdi:vector-difference`), and a **relative URL** for that panel (e.g. `change-detection`). Lastly, confirm it. -### Configurable 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`) | +| `BASE_URL` | str | | Full URL when running behind reverse proxy | +| `TIMEOUT` | int | `60000` | Request timeout in milliseconds | + +### Example Configuration ```yaml -PGID: user -GPID: user -TZ: Etc/UTC specify a timezone to use, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List -BASE_URL: Specify the full URL (including protocol) when running behind a reverse proxy +PGID: 0 +PUID: 0 +TZ: "Europe/London" +BASE_URL: "https://changedetection.mydomain.com" +TIMEOUT: 60000 ``` ### Connect to browserless Chrome (from @RhysMcW) diff --git a/fireflyiii/README.md b/fireflyiii/README.md index 84714cbf7..dcb28404c 100644 --- a/fireflyiii/README.md +++ b/fireflyiii/README.md @@ -28,30 +28,46 @@ This addon is based on the docker image https://hub.docker.com/r/fireflyiii/core ## Configuration -PLEASE CHANGE YOUR APP_KEY BEFORE FIRST LAUNCH! YOU WON'T BE ABLE AFTERWRADS WITHOUT RESETTING YOUR DATABASE. +Webui can be found at or through the sidebar using Ingress. +Configurations can be done through the app webUI, except for the following options. -Options can be configured through two ways : +**⚠️ IMPORTANT**: Change your `APP_KEY` before first launch! You won't be able to change it afterwards without resetting your database. -- Addon options +### Options + +| Option | Type | Default | Description | +|--------|------|---------|-------------| +| `APP_KEY` | str | `CHANGEME_32_CHARS_EuC5dfn3LAPzeO` | **CRITICAL**: 32-character encryption key - change before first run! | +| `CONFIG_LOCATION` | str | `/config/addons_config/fireflyiii/config.yaml` | Location of additional config file | +| `DB_CONNECTION` | list | `sqlite_internal` | Database type (sqlite_internal/mariadb_addon/mysql/pgsql) | +| `DB_HOST` | str | | Database host (for external databases) | +| `DB_PORT` | str | | Database port (for external databases) | +| `DB_DATABASE` | str | | Database name (for external databases) | +| `DB_USERNAME` | str | | Database username (for external databases) | +| `DB_PASSWORD` | str | | Database password (for external databases) | +| `Updates` | list | | Automatic update schedule (hourly/daily/weekly) | +| `silent` | bool | `true` | Silent mode - set to false for debug info | + +### Example Configuration ```yaml -"CONFIG_LOCATION": location of the config.yaml # Sets the location of the config.yaml (see below) -"DB_CONNECTION": "list(sqlite_internal|mariadb_addon|mysql|pgsql)" # Defines the type of database to use : sqlite (default, embedded in the addon) ; MariaDB (auto-detection if the MariaDB addon is installed and runs), and external databases that requires that the other DB_ fields are set (mysql and pgsql) -"APP_KEY": 32 characters # This is your encryption key, don't lose it! -"DB_HOST": "CHANGEME" # only needed if using a remote database -"DB_PORT": "CHANGEME" # only needed if using a remote database -"DB_DATABASE": "CHANGEME" # only needed if using a remote database -"DB_USERNAME": "CHANGEME" # only needed if using a remote database -"DB_PASSWORD": "CHANGEME" # only needed if using a remote database -"Updates": hourly|daily|weekly # Sets an automatic update -"silent": true # If false, show debug info +APP_KEY: "SomeRandomStringOf32CharsExactly" +CONFIG_LOCATION: "/config/addons_config/fireflyiii/config.yaml" +DB_CONNECTION: "mariadb_addon" +DB_HOST: "core-mariadb" +DB_PORT: "3306" +DB_DATABASE: "firefly" +DB_USERNAME: "firefly" +DB_PASSWORD: "secure_password" +Updates: "weekly" +silent: false ``` -- Config.yaml (advanced usage) +### Advanced Configuration -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/Addons-feature:-add-env-variables - -The complete list of ENV variables can be seen here : https://raw.githubusercontent.com/firefly-iii/firefly-iii/main/.env.example +Additional environment variables can be configured using the config.yaml file. See: +- [Add Environment Variables Guide](https://github.com/alexbelgium/hassio-addons/wiki/Add-Environment-variables-to-your-Addon) +- [Complete Firefly III environment variables](https://raw.githubusercontent.com/firefly-iii/firefly-iii/main/.env.example) ## Installation diff --git a/joal/README.md b/joal/README.md index 0b4945b85..27a1033a9 100644 --- a/joal/README.md +++ b/joal/README.md @@ -28,14 +28,25 @@ All credits for the app go to Anthony Raymond, please visit his repository here ## Configuration -Joal configuration : in the addon log are all informations tailored for your system +Webui can be found at or through the sidebar using Ingress. +Configuration details are available in the addon logs. -Addon options +### Options + +| Option | Type | Default | Description | +|--------|------|---------|-------------| +| `secret_token` | str | `lrMY24Byhx` | Authentication token for the web interface | +| `ui_path` | str | `joal` | Web UI path | +| `run_duration` | str | `12h` | Runtime duration (e.g., 5s, 2m, 12h, 5d) | +| `verbose` | bool | | Enable verbose logging | + +### Example Configuration ```yaml -secret_token: lrMY24Byhx #you can encode your own token here that will be used to identify in the app -ui_path: joal #the path where Joal will be accessible -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...) +secret_token: "your-custom-token-here" +ui_path: "joal" +run_duration: "24h" +verbose: true ``` ## Installation diff --git a/mealie/README.md b/mealie/README.md index 83aec1a60..7afe15ab5 100644 --- a/mealie/README.md +++ b/mealie/README.md @@ -33,30 +33,50 @@ This addon is based on the [docker image](https://hub.docker.com/r/hkotel/mealie ## 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. + - Start the addon. Wait a while and check the log for any errors. -- Open yourdomain.com:9090 (where ":9090" is the port configured in the addon). -- Default +- Default credentials: - Username: changeme@example.com - Password: MyPassword -Options can be configured through two ways : +### Options -- Addon options +| Option | Type | Default | Description | +|--------|------|---------|-------------| +| `PGID` | int | `1000` | Group ID for file permissions | +| `PUID` | int | `1000` | User ID for file permissions | +| `ssl` | bool | `false` | Enable HTTPS for the web interface | +| `certfile` | str | `fullchain.pem` | SSL certificate file (must be in /ssl) | +| `keyfile` | str | `privkey.pem` | SSL key file (must be in /ssl) | +| `BASE_URL` | str | | Optional external base URL | +| `DATA_DIR` | str | `/config` | Data directory path | +| `ALLOW_SIGNUP` | bool | `true` | Allow new user signup | + +### Example Configuration ```yaml - "BASE_URL": Optional, external base url - "PGID": user ID - "PUID": "group ID - "certfile": fullchain.pem #ssl certificate, must be located in /ssl - "keyfile": privkey.pem #sslkeyfile, must be located in /ssl - "ssl": ssl: true/false - "ALLOW_SIGNUP": Allow signup of users +PGID: 1000 +PUID: 1000 +ssl: false +certfile: "fullchain.pem" +keyfile: "privkey.pem" +BASE_URL: "https://mealie.mydomain.com" +DATA_DIR: "/config" +ALLOW_SIGNUP: false ``` -- Config.yaml - Additional options can be configured using the config.yaml file found in /homeassistant/addons_config/xxx-mealie/config.yaml +### Custom Scripts and Environment Variables -The complete list of options can be seen here : https://nightly.mealie.io/documentation/getting-started/installation/backend-config/ +This addon supports custom scripts and environment variables: + +- **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) + +You can add environment variables by creating `/homeassistant/addons_config/xxx-mealie/config.yaml`. + +The complete list of options can be found here: https://nightly.mealie.io/documentation/getting-started/installation/backend-config/ ## Integration with HA diff --git a/ombi/README.md b/ombi/README.md index 55618ecb3..975dbdec4 100644 --- a/ombi/README.md +++ b/ombi/README.md @@ -39,11 +39,21 @@ comparison to installing any other Hass.io add-on. ## Configuration -Webui can be found at . +Webui can be found at 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 | + +### Example Configuration ```yaml -PGID: user -GPID: user +PGID: 1000 +PUID: 1000 ``` ## Support diff --git a/organizr/README.md b/organizr/README.md index f429084bc..8f5e86f72 100644 --- a/organizr/README.md +++ b/organizr/README.md @@ -39,14 +39,25 @@ comparison to installing any other Hass.io add-on. ## Configuration -Webui can be found at . -Create the db in /data/... +Webui can be found at 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 | + +### Example Configuration ```yaml -PGID: user, can't be 0 -GPID: user, can't be 0 +PGID: 1000 +PUID: 1000 ``` +**Note**: Create the database in `/data/` directory as needed by the application. + ## Support Create an issue on github diff --git a/photoprism/README.md b/photoprism/README.md index 458e7a7ba..d0ac69fb0 100644 --- a/photoprism/README.md +++ b/photoprism/README.md @@ -44,52 +44,80 @@ comparison to installing any other Hass.io add-on. ## Configuration -Default user : admin -Default password : please_change_password +Webui can be found at or through the sidebar using Ingress. +Configurations can be done through the app webUI, except for the following options. -To access webdav, use as url : http://local-ip:addon-port/api/hassio.../originals -The second part (/api.../originals) Is described in the log when starting the addons +**System Requirements**: Minimum 2 cores and 4GB RAM +**Default Credentials**: +- Username: admin +- Password: please_change_password -Options can be configured through two ways : +**WebDAV Access**: Use URL `http://local-ip:addon-port/api/hassio.../originals` (see addon logs for full path) -- Addon options +### Options + +| Option | Type | Default | Description | +|--------|------|---------|-------------| +| `ssl` | bool | `false` | Enable HTTPS for the web interface | +| `certfile` | str | `fullchain.pem` | SSL certificate file (must be in /ssl) | +| `keyfile` | str | `privkey.pem` | SSL key file (must be in /ssl) | +| `DB_TYPE` | list | `sqlite` | Database type (sqlite/mariadb_addon/external) | +| `ORIGINALS_PATH` | str | `/share/photoprism/originals` | Photo and video collection path | +| `STORAGE_PATH` | str | `/share/photoprism/storage` | Cache, database and sidecar files path | +| `IMPORT_PATH` | str | `/share/photoprism/import` | Import files path | +| `BACKUP_PATH` | str | `/share/photoprism/backup` | Backup storage path | +| `UPLOAD_NSFW` | bool | `true` | Allow uploads that may be offensive | +| `CONFIG_LOCATION` | str | | Location of additional config.yaml | +| `graphic_drivers` | list | | Graphics driver (mesa) | +| `ingress_disabled` | bool | | Disable ingress for direct IP:port access | +| `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, must be located in /ssl -keyfile: privkey.pem #sslkeyfile, must be located in /ssl -DB_TYPE: "list(sqlite|mariadb_addon|external)" # Mariadb is automatically configured is the addon is installed, sqlite does not need configuration -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 -ingress_disable: false # optional, if true disable ingress and simplifies the url to access with IP:port -UPLOAD_NSFW: "true" allow uploads that may be offensive -STORAGE_PATH: "/share/photoprism/storage" # storage PATH for cache, database and sidecar files -ORIGINALS_PATH: "/share/photoprism/originals" # originals PATH containing your photo and video collection -IMPORT_PATH: "/share/photoprism/import" # PATH for importing files to originals -BACKUP_PATH: "/share/photoprism/backup" # backup storage PATH -CONFIG_LOCATION: "/config/addons_config/config.yaml" # Sets the location of the config.yaml (see below) +ssl: false +certfile: "fullchain.pem" +keyfile: "privkey.pem" +DB_TYPE: "mariadb_addon" +ORIGINALS_PATH: "/media/photos" +STORAGE_PATH: "/share/photoprism/storage" +IMPORT_PATH: "/share/photoprism/import" +BACKUP_PATH: "/share/photoprism/backup" +UPLOAD_NSFW: true +localdisks: "sda1,sdb1" +networkdisks: "//192.168.1.100/photos" +cifsusername: "photouser" +cifspassword: "password123" +cifsdomain: "workgroup" ``` -- Config.yaml +### Advanced Configuration -Configuration is done by customizing the config.yaml that can be found in /config/addons_config/config.yaml +Additional options can be configured in `/config/addons_config/photoprism/config.yaml`. +Complete list: https://github.com/photoprism/photoprism/blob/develop/docker-compose.yml -The complete list of options can be seen here : https://github.com/photoprism/photoprism/blob/develop/docker-compose.yml +### External Database Setup -- External db setting (@wesleygas) - -Allow for the use of an external database. This can be done in photoprism by correctly setting the following options on the addons_config/photoprism/config.yaml file: +For external database, add to `addons_config/photoprism/config.yaml`: ```yaml PHOTOPRISM_DATABASE_DRIVER: "mysql" PHOTOPRISM_DATABASE_SERVER: "IP:PORT" PHOTOPRISM_DATABASE_NAME: "photoprism" PHOTOPRISM_DATABASE_USER: "USERNAME" -PHOTOPRISM_DATABASE_PASSWORD: "PASSWORD +PHOTOPRISM_DATABASE_PASSWORD: "PASSWORD" ``` + +### 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) ## Using Photoprism Command-Line Interface Photoprism also provides a command line interface: diff --git a/piwigo/README.md b/piwigo/README.md index 1b12af1e0..029e2a844 100644 --- a/piwigo/README.md +++ b/piwigo/README.md @@ -39,21 +39,48 @@ comparison to installing any other Hass.io add-on. ## Configuration -1. You must create a user and database for piwigo to use in a mysql/mariadb server. -1. In the setup page for database, use the ip address rather than hostname. -1. A basic nginx configuration file can be found in /config/piwigo/nginx/site-confs, edit the file to enable ssl (port 443 by default), set servername etc. -1. Self-signed keys are generated the first time you run the container and can be found in /data/keys, if needed, you can replace them with your own. -1. The easiest way to edit the configuration file is to go in /config/piwigo from home assistant local files editor to configure email settings etc. +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 . +### Setup Steps + +1. Create a user and database for Piwigo in a MySQL/MariaDB server +2. In the database setup page, use IP address rather than hostname +3. Edit nginx configuration in `/config/piwigo/nginx/site-confs` for SSL (port 443) +4. Self-signed keys are in `/data/keys` (replace with your own if needed) +5. Edit configuration files in `/config/piwigo` for email settings + +### 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 -localdisks: sda1 #put the hardware name of your drive to mount separated by commas, or its label. ex. sda1, sdb1, MYNAS... -networkdisks: "" # list of smbv2/3 servers to mount (optional) -cifsusername: "username" # smb username (optional) -cifspassword: "password" # smb password (optional) +PGID: 1000 +PUID: 1000 +TZ: "Europe/London" +localdisks: "sda1,sdb1" +networkdisks: "//192.168.1.100/gallery" +cifsusername: "galleryuser" +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) + [repository]: https://github.com/alexbelgium/hassio-addons diff --git a/postgres_15/README.md b/postgres_15/README.md index 07babc047..7578873ca 100644 --- a/postgres_15/README.md +++ b/postgres_15/README.md @@ -31,23 +31,38 @@ This addon is based on the official image : https://hub.docker.com/_/postgres ## Configuration Postgres port is by default 5432 and is exposed to the host network. +Default user: `postgres`, password: set by `POSTGRES_PASSWORD` -default user: `postgres` -password: `set by POSTGRES_PASSWORD` +### Options -You can configure this options: +| Option | Type | Default | Description | +|--------|------|---------|-------------| +| `POSTGRES_PASSWORD` | password | `homeassistant` | Password for the postgres user | +| `POSTGRES_USER` | str | | Optional custom username | +| `POSTGRES_DB` | str | | Optional default database name | +| `POSTGRES_INITDB_ARGS` | str | | Additional arguments to initdb | +| `POSTGRES_HOST_AUTH_METHOD` | str | | Host authentication method | + +### Example Configuration ```yaml -POSTGRES_PASSWORD -POSTGRES_USER -POSTGRES_DB -POSTGRES_INITDB_ARGS -POSTGRES_HOST_AUTH_METHOD +POSTGRES_PASSWORD: "your-secure-password" +POSTGRES_USER: "myuser" +POSTGRES_DB: "mydatabase" +POSTGRES_INITDB_ARGS: "--encoding=UTF8 --lc-collate=C --lc-ctype=C" +POSTGRES_HOST_AUTH_METHOD: "md5" ``` -For more info check [base image docs](https://hub.docker.com/_/postgres). +For more information, check the [official PostgreSQL image docs](https://hub.docker.com/_/postgres). -By default `postgresql.conf` is stored in volume accessible by other addons and Home Assistant, so you can conviniently modify it by e.g. File Editor addon. If you prefer better security change `CONFIG_LOCATION` to e.g. `/data/orig/postgresql.conf`, so it will be acessible only to this addon, but you will have to modify it by the [Hassio SSH](https://developers.home-assistant.io/docs/operating-system/debugging/). +### Custom Scripts and Environment Variables + +This addon supports custom scripts and environment variables: + +- **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) + +**Configuration File**: By default `postgresql.conf` is stored in `/config/postgresql.conf` accessible by other addons and Home Assistant. You can modify it using the File Editor addon. For better security, change `CONFIG_LOCATION` to `/data/orig/postgresql.conf` to make it accessible only to this addon. ## Installation diff --git a/requestrr/README.md b/requestrr/README.md index 580bd1ad7..9043af453 100644 --- a/requestrr/README.md +++ b/requestrr/README.md @@ -44,18 +44,35 @@ 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. -Please run a first time the addon, then customize using my Filebrowser addon the config file created in /addon_configs/db21ed7f_requestrr +The default username/password is described in the startup log. +Run the addon first, then customize the config file created in `/addon_configs/db21ed7f_requestrr` using the Filebrowser addon. + +### 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`) | + +### Example Configuration ```yaml -PGID: user -GPID: user -TZ: timezone +PGID: 1000 +PUID: 1000 +TZ: "Europe/London" ``` +### Custom Scripts and Environment Variables + +This addon supports custom scripts and environment variables: + +- **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/scrutiny/README.md b/scrutiny/README.md index bfa73a5cc..70652717f 100644 --- a/scrutiny/README.md +++ b/scrutiny/README.md @@ -36,20 +36,46 @@ Features : ## Configuration ---- - -Webui can be found at , or through Ingress. +Webui can be found at or through the sidebar using Ingress. +Configurations can be done through the app webUI, except for the following options. It automatically mounts all local drives. -Enable full access only if you are encountering issues. SMART access should work without full access in all other scenarios. +**Note**: Enable full access only if encountering issues. SMART access should work without full access in all scenarios. + +### Options + +| Option | Type | Default | Description | +|--------|------|---------|-------------| +| `Updates` | list | `Hourly` | Update schedule (Quarterly/Hourly/Daily/Weekly/Custom) | +| `Updates_custom_time` | str | | Custom update interval (e.g., "5m", "2h", "1w", "2mo") | +| `TZ` | str | | Timezone (e.g., `Europe/London`) | +| `Mode` | list | | Operating mode (Collector+WebUI or Collector only) | +| `COLLECTOR_API_ENDPOINT` | str | | Collector API endpoint URL | +| `COLLECTOR_HOST_ID` | str | | Host identifier for collector | +| `SMARTCTL_COMMAND_DEVICE_TYPE` | list | | Device type for SMARTCTL commands | +| `SMARTCTL_MEGARAID_DISK_NUM` | int | | MegaRAID disk number | +| `expose_collector` | bool | | Expose collector port externally | + +### Example Configuration ```yaml -Updates: Hourly, Daily, Weekly -Updates_custom_time : if you select "Custom" as "Updates" variable, you can define specific updates in natural language in the "Updates_custom_time" field. Example : select "Custom" as "Updates", then type a custom intervals like "5m", "2h", "1w", or "2mo" to have an update every 5 minutes, or every 2 hours, or evey week, or every 2 months -TZ: timezone -Mode: Collector+WebUI or Collector only +Updates: "Daily" +Updates_custom_time: "12h" +TZ: "Europe/London" +Mode: "Collector+WebUI" +COLLECTOR_API_ENDPOINT: "http://localhost:8080" +COLLECTOR_HOST_ID: "home_assistant" +SMARTCTL_COMMAND_DEVICE_TYPE: "auto" +expose_collector: false ``` +### Custom Scripts and Environment Variables + +This addon supports custom scripts and environment variables: + +- **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/tandoor_recipes/README.md b/tandoor_recipes/README.md index 0529ae095..c806fa3c5 100644 --- a/tandoor_recipes/README.md +++ b/tandoor_recipes/README.md @@ -26,23 +26,41 @@ _Thanks to everyone having starred my repo! To star it click on the image below, ## Configuration -Ingress addition : https://community.home-assistant.io/t/ingress-access-for-tandoor-recipes/717859 +Webui can be found at or through the sidebar using Ingress. +Configurations can be done through the app webUI, except for the following options. -Please check Tandoor Recipes documentation : https://docs.tandoor.dev/install/docker/ +For Ingress support, see: https://community.home-assistant.io/t/ingress-access-for-tandoor-recipes/717859 +Complete documentation: https://docs.tandoor.dev/install/docker/ + +### Options + +| Option | Type | Default | Description | +|--------|------|---------|-------------| +| `SECRET_KEY` | str | `YOUR_SECRET_KEY` | **REQUIRED**: Django secret key for security | +| `ALLOWED_HOSTS` | str | | **REQUIRED**: Comma-separated Home Assistant URLs for ingress | +| `DB_TYPE` | list | `sqlite` | Database type (sqlite or postgresql_external) | +| `DEBUG` | list | `0` | Debug mode (0=normal, 1=debug) | +| `externalfiles_folder` | str | | Folder for external recipe file imports | +| `POSTGRES_HOST` | str | | PostgreSQL host (required for postgresql_external) | +| `POSTGRES_PORT` | str | | PostgreSQL port (required for postgresql_external) | +| `POSTGRES_USER` | str | | PostgreSQL username (required for postgresql_external) | +| `POSTGRES_PASSWORD` | str | | PostgreSQL password (required for postgresql_external) | +| `POSTGRES_DB` | str | | PostgreSQL database name (required for postgresql_external) | + +### Example Configuration ```yaml -Required : - "ALLOWED_HOSTS": "your system url", # You need to input your homeassistant urls (comma separated, without space) to allow ingress to work - "DB_TYPE": "list(sqlite|postgresql_external)" # Type of database to use. - "SECRET_KEY": "str", # Your secret key - "PORT": 9928 # By default, the webui is available on http://HAurl:9928. If you ever need to change the port, you should never do it within the app, but only through this option - "Environment": 0|1 # 1 is debug mode, 0 is normal mode. You should run in normal mode unless actively developing. -Optional : - "POSTGRES_HOST": "str?", # Needed for postgresql_external - "POSTGRES_PORT": "str?", # Needed for postgresql_external - "POSTGRES_USER": "str?", # Needed for postgresql_external - "POSTGRES_PASSWORD": "str?", # Needed for postgresql_external - "POSTGRES_DB": "str?" # Needed for postgresql_external +SECRET_KEY: "your-very-long-secret-key-here" +ALLOWED_HOSTS: "homeassistant.local,192.168.1.100" +DB_TYPE: "sqlite" +DEBUG: "0" +externalfiles_folder: "/config/addons_config/tandoor_recipes/externalfiles" +# For external PostgreSQL: +# POSTGRES_HOST: "core-postgres" +# POSTGRES_PORT: "5432" +# POSTGRES_USER: "tandoor" +# POSTGRES_PASSWORD: "secure_password" +# POSTGRES_DB: "tandoor_recipes" ``` ## Installation diff --git a/transmission/README.md b/transmission/README.md index 557fbe09b..c6fbef380 100644 --- a/transmission/README.md +++ b/transmission/README.md @@ -40,20 +40,58 @@ comparison to installing any other Hass.io add-on. ## Configuration -Options : +Webui can be found at 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`) | +| `download_dir` | str | `/share/downloads` | Directory for completed downloads | +| `incomplete_dir` | str | `/share/incomplete` | Directory for incomplete downloads | +| `watch_dir` | str | | Directory to watch for torrent files | +| `customUI` | list | `flood-for-transmission` | Web UI (standard/transmission-web-control/kettu/flood-for-transmission) | +| `user` | str | | Web UI username | +| `pass` | str | | Web UI password | +| `whitelist` | str | | IP whitelist for web access | +| `DNS_server` | str | `8.8.8.8,1.1.1.1` | 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 | +| `smbv1` | bool | | Enable SMB v1 protocol | + +### Example Configuration ```yaml -download_dir: "/share/downloads" # where the files will be saved after download -incomplete_dir: "/share/incomplete" # where the files are saved during download -localdisks: sda1 #put the hardware name of your drive to mount separated by commas, or its label. ex. sda1, sdb1, MYNAS... -networkdisks: "" # list of smbv2/3 servers to mount, '' if none -cifsusername: "" # smb username -cifspassword: "" # smb password +PGID: 0 +PUID: 0 +TZ: "Europe/London" +download_dir: "/media/downloads" +incomplete_dir: "/media/incomplete" +watch_dir: "/media/torrents" +customUI: "flood-for-transmission" +user: "transmission" +pass: "secure_password" +localdisks: "sda1,sdb1" +networkdisks: "//192.168.1.100/downloads" +cifsusername: "dluser" +cifspassword: "password123" +cifsdomain: "workgroup" ``` -Complete transmission options are in /share/transmission (make sure addon is stopped before modifying it as Transmission writes its ongoing values when stopping and could erase your changes) +### Mounting Drives -Webui can be found at `:9091`. +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) + +**Advanced Settings**: Complete transmission settings are available in `/share/transmission/settings.json`. Stop the addon before modifying as Transmission overwrites settings on shutdown. ## Issues