avm/hassio-addons
1
0
Fork 0
mirror of https://github.com/alexbelgium/hassio-addons.git synced 2026-06-02 22:04:06 +02:00
Code Issues Packages Projects Releases Wiki Activity

Claudify

Browse Source
This commit is contained in:
Alexandre
2025-08-01 22:28:17 +02:00
parent ca03e5ac7b
commit 1a789cb081
9 changed files with 275 additions and 48 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
grav/README.md
View File

@@ -44,26 +44,39 @@ The installation of this add-on is pretty straightforward and not different in c
## Configuration ## Configuration
Webui can be found at <http://homeassistant:PORT>. Webui can be found at <http://homeassistant:9191>.
The default username/password : described in the startup log. Configurations can be done through the app webUI, except for the following options.
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 ```yaml
PGID: user PGID: 1000
GPID: user PUID: 1000
TZ: timezone TZ: "Europe/London"
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
``` ```
### 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 ## Support
Create an issue on github Create an issue on github

39
inadyn/README.md
View File

@@ -41,10 +41,43 @@ comparison to installing any other Hass.io add-on.
## Configuration ## Configuration
To configure with addon options, no webUI. This addon has no web interface - all configuration is done through addon options.
For configuration, see https://github.com/troglobit/inadyn 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 ```json
{ {

9
organizr/README.md
View File

@@ -42,6 +42,13 @@ comparison to installing any other Hass.io add-on.
Webui can be found at <http://homeassistant:80> or through the sidebar using Ingress. Webui can be found at <http://homeassistant:80> or through the sidebar using Ingress.
Configurations can be done through the app webUI, except for the following options. 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 ### Options
| Option | Type | Default | Description | | Option | Type | Default | Description |
@@ -56,7 +63,7 @@ PGID: 1000
PUID: 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 ## Support

71
seafile/README.md
View File

@@ -45,31 +45,66 @@ The installation of this add-on is pretty straightforward and not different in c
## Configuration ## Configuration
--- Webui can be found at <http://homeassistant:8000> (Seahub) and <http://homeassistant:8082> (File server).
Webui can be found at <http://homeassistant:PORT>. ### Setup Steps
The default username/password : described in the startup log.
Configurations can be done through the app webUI, except for the following options
Default name : me@example.com 1. Default login: `me@example.com` / `a_very_secret_password`
Default password : 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 ```yaml
PGID: user PGID: 1000
GPID: user PUID: 1000
TZ: timezone TZ: "Europe/London"
PASSWORD: Optionally set a password for the gui SEAFILE_ADMIN_EMAIL: "admin@mydomain.com"
CLI_ARGS: Optionally pass cli start arguments to seafile SEAFILE_ADMIN_PASSWORD: "SecurePassword123"
localdisks: sda1 #put the hardware name of your drive to mount separated by commas, or its label. ex. sda1, sdb1, MYNAS... SERVER_IP: "192.168.1.100"
networkdisks: "//SERVER/SHARE" # optional, list of smb servers to mount, separated by commas FILE_SERVER_ROOT: "https://seafile.mydomain.com:8082"
cifsusername: "username" # optional, smb username, same for all smb shares url: "seafile.mydomain.com"
cifspassword: "password" # optional, smb password database: "mariadb_addon"
force_scheme_https: if you have issues accessing ingress with https, check this box to force https data_location: "/share/seafile"
force_external_port: if you have issues accessing ingress with https, note here your external port used to access HA 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 ## Support
Create an issue on github Create an issue on github

34
sponsorblockcast/README.md
View File

@@ -33,7 +33,39 @@ Feedback from @diamant-x :
## Configuration ## 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 ## Installation

21
teamspeak/README.md
View File

@@ -41,9 +41,26 @@ The installation of this add-on is pretty straightforward and not different in c
## Configuration ## 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 ## Support

59
webtop/README.md
View File

@@ -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 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 ```yaml
TZ: timezone ; Country/City according to https://manpages.ubuntu.com/manpages/trusty/man3/DateTime::TimeZone::Catalog.3pm.html PGID: 1000
additional_apps: engrampa,thunderbird # Allows installation of apps, as they are not persistent PUID: 1000
DRINODE: specify a custom graphic device, default is /dev/dri/renderD128 TZ: "Europe/London"
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 additional_apps: "firefox,gimp,vlc"
localdisks: sda1 #put the hardware name of your drive to mount separated by commas, or its label. ex. sda1, sdb1, MYNAS... DRINODE: "/dev/dri/card0"
networkdisks: "//SERVER/SHARE" # optional, list of smb servers to mount, separated by commas KEYBOARD: "fr-fr-azerty"
cifsusername: "username" # optional, smb username, same for all smb shares localdisks: "sda1,sdb1"
cifspassword: "password" # optional, smb password networkdisks: "//192.168.1.100/media"
cifsdomain: "domain" # optional, allow setting the domain for the smb share 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 ## Installation
The installation of this add-on is pretty straightforward and not different in comparison to installing any other add-on. The installation of this add-on is pretty straightforward and not different in comparison to installing any other add-on.

14
xteve/README.md
View File

@@ -44,6 +44,20 @@ comparison to installing any other Hass.io add-on.
Webui can be found at <http://homeassistant:34400/web>. Webui can be found at <http://homeassistant:34400/web>.
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 ## Support
Create an issue on github Create an issue on github

37
zoneminder/README.md
View File

@@ -28,7 +28,42 @@ This addon is based on the docker image https://github.com/ZoneMinder/zmdockerfi
## Configuration ## Configuration
Read official documentation for information how to set : https://github.com/ZoneMinder/zmdockerfiles/blob/master/utils/entrypoint.sh Webui can be found at <http://homeassistant:3778/zm>.
### 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 ## Installation