diff --git a/grav/README.md b/grav/README.md index 99dd90bbe..ea28a296c 100644 --- a/grav/README.md +++ b/grav/README.md @@ -44,26 +44,39 @@ The installation of this add-on is pretty straightforward and not different in c ## Configuration -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 +Webui can be found at . +Configurations can be done through the app webUI, except for the following options. -## Add theme/squeleton +### Setup Steps -You can place the user folder from the theme/skeleton in /share/grav/www/user, +1. Access the web interface after starting the addon +2. Follow the Grav setup wizard for initial configuration +3. Install themes/plugins through the admin panel +4. Custom themes can be placed in `/share/grav/www/user` -## Options +### 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`) | + +### 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: 1000 +PUID: 1000 +TZ: "Europe/London" ``` +### Adding Themes/Skeletons + +Place custom themes and skeletons in `/share/grav/www/user/` directory: +- Themes: `/share/grav/www/user/themes/` +- Plugins: `/share/grav/www/user/plugins/` +- Pages: `/share/grav/www/user/pages/` + ## Support Create an issue on github diff --git a/inadyn/README.md b/inadyn/README.md index effcc4bea..4cdff7544 100644 --- a/inadyn/README.md +++ b/inadyn/README.md @@ -41,10 +41,43 @@ comparison to installing any other Hass.io add-on. ## Configuration -To configure with addon options, no webUI. -For configuration, see https://github.com/troglobit/inadyn +This addon has no web interface - all configuration is done through addon options. +For detailed configuration information, see the [official documentation](https://github.com/troglobit/inadyn). -The available configuration options are as follows (this is filled in with some example data): +### Options + +| Option | Type | Default | Description | +|--------|------|---------|-------------| +| `verify_address` | bool | | Verify the IP address with check IP service | +| `fake_address` | bool | | Use fake address for testing | +| `allow_ipv6` | bool | | Enable IPv6 support | +| `iface` | str | | Network interface to use (e.g., `eth0`) | +| `iterations` | int | | Number of iterations (0 = infinite) | +| `period` | int | `300` | Update period in seconds | +| `forced_update` | int | | Forced update interval in seconds | +| `secure_ssl` | bool | | Enable secure SSL verification | +| `providers` | list | | List of DDNS provider configurations | + +### Provider Configuration + +Each provider in the `providers` list supports these options: + +| Option | Type | Description | +|--------|------|-------------| +| `provider` | str | Provider name or custom identifier | +| `custom_provider` | bool | Whether this is a custom provider | +| `username` | str | Username or token for authentication | +| `password` | str | Password or API key | +| `hostname` | str | Domain/hostname to update | +| `ssl` | bool | Use SSL for updates | +| `ddns_server` | str | Custom DDNS server | +| `ddns_path` | str | Custom update path | +| `checkip_server` | str | Custom IP check server | +| `checkip_path` | str | Custom IP check path | +| `checkip_ssl` | bool | Use SSL for IP checking | +| `append_myip` | bool | Append IP to request | + +### Example Configurations ```json { diff --git a/organizr/README.md b/organizr/README.md index 8f5e86f72..a674ce38d 100644 --- a/organizr/README.md +++ b/organizr/README.md @@ -42,6 +42,13 @@ comparison to installing any other Hass.io add-on. Webui can be found at or through the sidebar using Ingress. Configurations can be done through the app webUI, except for the following options. +### Setup Steps + +1. Start the addon and access the web interface +2. Follow the setup wizard to create admin account +3. Configure your services and tabs through the web interface +4. Database files are stored in `/data/` directory + ### Options | Option | Type | Default | Description | @@ -56,7 +63,7 @@ PGID: 1000 PUID: 1000 ``` -**Note**: Create the database in `/data/` directory as needed by the application. +**Note**: Organizr requires minimal configuration through the addon options. Most settings are configured through the web interface including service integration, authentication, and theming. ## Support diff --git a/seafile/README.md b/seafile/README.md index 4ca573b24..5440be9a7 100644 --- a/seafile/README.md +++ b/seafile/README.md @@ -45,31 +45,66 @@ The installation of this add-on is pretty straightforward and not different in c ## Configuration ---- +Webui can be found at (Seahub) and (File server). -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 +### Setup Steps -Default name : me@example.com -Default password : a_very_secret_password +1. Default login: `me@example.com` / `a_very_secret_password` +2. Change admin credentials after first login +3. Configure database (SQLite default, MariaDB recommended for production) +4. Set proper file server root URL for external access -If you store your database on a mounted drive, make sure to also host your sqlite database there : otherwise if there is an issue with the mount you'll lose your whole database (thanks @cokeman0) +### Options + +| Option | Type | Default | Description | +|--------|------|---------|-------------| +| `PGID` | int | `1000` | Group ID for file permissions | +| `PUID` | int | `1000` | User ID for file permissions | +| `TZ` | str | `Europe/Paris` | Timezone (e.g., `Europe/London`) | +| `SEAFILE_ADMIN_EMAIL` | email | `me@example.com` | Admin email address | +| `SEAFILE_ADMIN_PASSWORD` | password | `a_very_secret_password` | Admin password | +| `SERVER_IP` | str | `homeassistant.local` | Server IP or hostname | +| `FILE_SERVER_ROOT` | str | `http://homeassistant.local:8082` | File server root URL | +| `PORT` | str | `8082` | File server port | +| `url` | str | | External URL for Seafile | +| `database` | list | `sqlite` | Database type (sqlite/mariadb_addon) | +| `data_location` | str | `/share/seafile` | Data storage location | +| `CONFIG_LOCATION` | str | | Custom config file location | +| `localdisks` | str | | Local drives to mount (e.g., `sda1,sdb1`) | +| `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 -PASSWORD: Optionally set a password for the gui -CLI_ARGS: Optionally pass cli start arguments to seafile -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 -force_scheme_https: if you have issues accessing ingress with https, check this box to force https -force_external_port: if you have issues accessing ingress with https, note here your external port used to access HA +PGID: 1000 +PUID: 1000 +TZ: "Europe/London" +SEAFILE_ADMIN_EMAIL: "admin@mydomain.com" +SEAFILE_ADMIN_PASSWORD: "SecurePassword123" +SERVER_IP: "192.168.1.100" +FILE_SERVER_ROOT: "https://seafile.mydomain.com:8082" +url: "seafile.mydomain.com" +database: "mariadb_addon" +data_location: "/share/seafile" +localdisks: "sda1,sdb1" +networkdisks: "//nas.local/seafile" +cifsusername: "seafileuser" +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) + +**Important**: If storing database on mounted drive, ensure SQLite database is also hosted there to prevent data loss during mount issues. + ## Support Create an issue on github diff --git a/sponsorblockcast/README.md b/sponsorblockcast/README.md index 95c7ce1f7..ff2436fcf 100644 --- a/sponsorblockcast/README.md +++ b/sponsorblockcast/README.md @@ -33,7 +33,39 @@ Feedback from @diamant-x : ## Configuration -See https://github.com/gabe565/CastSponsorSkip +This addon has no web interface - all configuration is done through addon options. +The addon automatically discovers local Chromecast devices and monitors YouTube playback to skip sponsored content. + +### Options + +| Option | Type | Default | Description | +|--------|------|---------|-------------| +| `CSS_CATEGORIES` | str | `sponsor, intro, outro, selfpromo` | SponsorBlock categories to skip (comma-separated) | +| `CSS_DISCOVER_INTERVAL` | str | | Device discovery interval | +| `CSS_MUTE_ADS` | bool | | Mute ads instead of skipping | +| `CSS_PAUSED_INTERVAL` | str | | Check interval when video is paused | +| `CSS_PLAYING_INTERVAL` | str | | Check interval when video is playing | +| `CSS_YOUTUBE_API_KEY` | str | | YouTube API key for enhanced features | + +### Example Configuration + +```yaml +CSS_CATEGORIES: "sponsor, intro, outro, selfpromo, interaction" +CSS_MUTE_ADS: false +CSS_PAUSED_INTERVAL: "30s" +CSS_PLAYING_INTERVAL: "500ms" +``` + +### Custom Scripts and Environment Variables + +This addon supports custom script execution and environment variable injection: + +- **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) + +### Additional Resources + +For detailed configuration options, see: https://github.com/gabe565/CastSponsorSkip ## Installation diff --git a/teamspeak/README.md b/teamspeak/README.md index 929b2a19d..ef17063f5 100644 --- a/teamspeak/README.md +++ b/teamspeak/README.md @@ -41,9 +41,26 @@ The installation of this add-on is pretty straightforward and not different in c ## Configuration -- Start the addon. Wait a while and check the log for any errors. +This addon has no web interface - it runs a TeamSpeak 3 server. +Connect using the TeamSpeak client at `homeassistant.local:9987`. -In order to get the credentials for your TS server, check the container logs as it will output the serveradmin password and your ServerAdmin privilege key. +### Getting Server Credentials + +1. Start the addon and wait for initialization +2. Check the container logs for: + - ServerAdmin password + - ServerAdmin privilege key + +### Ports + +| Port | Protocol | Description | +|------|----------|-------------| +| `9987` | UDP | Voice communication | +| `10011` | TCP | ServerQuery (raw) | +| `30033` | TCP | File transfer | +| `41144` | TCP | TSDNS | + +**Important**: Configure your router to forward these ports for external access. ## Support diff --git a/webtop/README.md b/webtop/README.md index b71e18833..98c0f5451 100644 --- a/webtop/README.md +++ b/webtop/README.md @@ -39,18 +39,59 @@ If graphics don't work, use the DRINODE feature to select your graphic device. See all potential ENV variables here : https://docs.linuxserver.io/images/docker-webtop#optional-environment-variables +### 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`) | +| `additional_apps` | str | `engrampa,libreoffice` | Apps to install (comma-separated) | +| `DRINODE` | str | `/dev/dri/renderD128` | Graphics device path | +| `DNS_server` | str | `8.8.8.8` | Custom DNS server | +| `KEYBOARD` | str | `en-us-qwerty` | Keyboard layout | +| `PASSWORD` | str | | Custom password for web interface | +| `data_location` | str | | Custom data storage path | +| `localdisks` | str | | Local drives to mount (e.g., `sda1,sdb1`) | +| `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 -TZ: timezone ; Country/City according to https://manpages.ubuntu.com/manpages/trusty/man3/DateTime::TimeZone::Catalog.3pm.html -additional_apps: engrampa,thunderbird # Allows installation of apps, as they are not persistent -DRINODE: specify a custom graphic device, default is /dev/dri/renderD128 -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 -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: 1000 +PUID: 1000 +TZ: "Europe/London" +additional_apps: "firefox,gimp,vlc" +DRINODE: "/dev/dri/card0" +KEYBOARD: "fr-fr-azerty" +localdisks: "sda1,sdb1" +networkdisks: "//192.168.1.100/media" +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) + +### Custom Scripts and Environment Variables + +This addon supports custom script execution and environment variable injection: + +- **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) + +### Additional Resources + +See all potential environment variables: https://docs.linuxserver.io/images/docker-webtop#optional-environment-variables + ## Installation The installation of this add-on is pretty straightforward and not different in comparison to installing any other add-on. diff --git a/xteve/README.md b/xteve/README.md index 8afddf359..2872ecd9e 100644 --- a/xteve/README.md +++ b/xteve/README.md @@ -44,6 +44,20 @@ comparison to installing any other Hass.io add-on. Webui can be found at . +This addon has minimal configuration options as most settings are configured through the web interface. + +### Options + +No configuration options are required for this addon. All configuration is done through the web interface at port 34400. + +### Example Configuration + +```yaml +# No options needed - configure via web interface +``` + +**Note**: xTeVe stores its configuration in `/data/` and runs on port 34400. Access the web interface to configure M3U playlists and XMLTV sources. + ## Support Create an issue on github diff --git a/zoneminder/README.md b/zoneminder/README.md index 2bebdd30b..f11cdb2b6 100644 --- a/zoneminder/README.md +++ b/zoneminder/README.md @@ -28,7 +28,42 @@ This addon is based on the docker image https://github.com/ZoneMinder/zmdockerfi ## Configuration -Read official documentation for information how to set : https://github.com/ZoneMinder/zmdockerfiles/blob/master/utils/entrypoint.sh +Webui can be found at . + +### Setup Steps + +1. Access the web interface after starting the addon +2. Configure cameras through the web interface +3. Set up motion detection zones and alerts +4. Configure storage locations for recordings +5. Requires MariaDB addon for database storage + +### Options + +| Option | Type | Default | Description | +|--------|------|---------|-------------| +| `Images_location` | str | `/config/addons_config/zoneminder/images` | Path for storing camera images | + +### Example Configuration + +```yaml +Images_location: "/share/zoneminder/images" +``` + +### Database Requirements + +ZoneMinder requires a MySQL/MariaDB database. Install the MariaDB addon and configure Zoneminder to use it. + +### Storage Paths + +- Images: Configured via `Images_location` option +- Events: `/var/cache/zoneminder/events2` +- Sounds: `/var/cache/zoneminder/sounds2` +- Config: `/config/addons_config/zoneminder` + +### Additional Resources + +For detailed configuration: https://github.com/ZoneMinder/zmdockerfiles/blob/master/utils/entrypoint.sh ## Installation