avm/hassio-addons
1
0
Fork 0
mirror of https://github.com/alexbelgium/hassio-addons.git synced 2026-01-09 17:31:03 +01:00
Code Issues Packages Projects Releases Wiki Activity

Claudify

Browse Source
This commit is contained in:
Alexandre
2025-08-01 22:13:51 +02:00
parent 3302535e56
commit c735abc9b2
12 changed files with 431 additions and 108 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
calibre/README.md
View File

@@ -89,6 +89,13 @@ 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:
- **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

63
calibre_web/README.md
View File

@@ -45,29 +45,58 @@ The installation of this add-on is pretty straightforward and not different in c
## Configuration
---
Webui can be found at <http://homeassistant:PORT> or through the sidebar using Ingress.
The default username/password is described in the startup log.
Configurations can be done through the app webUI, except for the following options.
Webui can be found at <http://homeassistant:PORT>.
The default username/password : described in the startup log.
Configurations can be done through the app webUI, except for the following options
Default name: admin
Default password: admin123
Default name : admin
Default password : admin123
### 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`) |
| `DOCKER_MODS` | str | | Docker modifications to apply |
| `OAUTHLIB_RELAX_TOKEN_SCOPE` | str | | OAuth token scope relaxation |
| `ingress_user` | str | | Username for ingress authentication |
| `localdisks` | str | | Local drives to mount (e.g., `sda1,sdb1,MYNAS`) |
| `networkdisks` | str | | SMB shares to mount (e.g., `//SERVER/SHARE`) |
| `cifsusername` | str | | SMB username for network shares |
| `cifspassword` | str | | SMB password for network shares |
| `cifsdomain` | str | | SMB domain for network shares |
### Example Configuration
```yaml
PGID: user
GPID: user
TZ: timezone
PASSWORD: Optionally set a password for the gui
CLI_ARGS: Optionally pass cli start arguments to calibre-web
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: 0
PUID: 0
TZ: "Europe/London"
DOCKER_MODS: "linuxserver/mods:universal-calibre"
ingress_user: "admin"
localdisks: "sda1,sdb1"
networkdisks: "//192.168.1.100/books"
cifsusername: "bookuser"
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:
- **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

47
cloudcommander/README.md
View File

@@ -27,18 +27,49 @@ This addon is based on the [docker image](https://hub.docker.com/r/coderaiser/cl
## Configuration
Webui can be found at `<your-ip>:8000`.
Webui can be found at <http://homeassistant:8000> or through the sidebar using Ingress.
Configurations can be done through the app webUI, except for the following options.
### Options
| Option | Type | Default | Description |
|--------|------|---------|-------------|
| `CUSTOM_OPTIONS` | str | | Custom CLI options (e.g., `--name Homeassistant`) |
| `DROPBOX_TOKEN` | str | | Dropbox integration token (see https://cloudcmd.io/) |
| `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 |
### Example Configuration
```yaml
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
smbv1: "bool?" # smb v1
DROPBOX_TOKEN: "str?" # see https://cloudcmd.io/
CUSTOM_OPTIONS: "--name Homeassistant" # custom options from https://cloudcmd.io/
CUSTOM_OPTIONS: "--name Homeassistant"
DROPBOX_TOKEN: "your-dropbox-token"
localdisks: "sda1,sdb1"
networkdisks: "//192.168.1.100/files"
cifsusername: "fileuser"
cifspassword: "password123"
cifsdomain: "workgroup"
smbv1: 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:
- **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

35
gitea/README.md
View File

@@ -30,16 +30,37 @@ This addon is based on the [docker image](https://hub.docker.com/r/gitea/gitea).
## Configuration
Webui can be found at <http://homeassistant:PORT> or through the sidebar using Ingress.
Configurations can be done through the app webUI, except for the following options.
### Options
| Option | Type | Default | Description |
|--------|------|---------|-------------|
| `ssl` | bool | `false` | Enable HTTPS for the web interface |
| `certfile` | str | `fullchain.pem` | SSL certificate file (must be located in /ssl) |
| `keyfile` | str | `privkey.pem` | SSL key file (must be located in /ssl) |
| `APP_NAME` | str | | Name of the Gitea application |
| `DOMAIN` | str | | Domain to be reached (default: homeassistant.local) |
| `ROOT_URL` | str | | Customize root URL (for specific routing needs) |
### Example Configuration
```yaml
certfile: fullchain.pem #ssl certificate, must be located in /ssl
keyfile: privkey.pem #sslkeyfile, must be located in /ssl
ssl: should the app use https or not
APP_NAME: name of the app
DOMAIN: domain to be reached # default : homeassistant.local
ROOT_URL: customize root_url, should not be needed unless specific needs
ssl: false
certfile: "fullchain.pem"
keyfile: "privkey.pem"
APP_NAME: "Gitea for Homeassistant"
DOMAIN: "homeassistant.local"
ROOT_URL: "http://homeassistant.local:3000"
```
Webui can be found at `<your-ip>:port`.
### 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

42
mylar3/README.md
View File

@@ -40,20 +40,42 @@ The installation of this add-on is pretty straightforward and not different in c
## Configuration
Webui can be found at <http://homeassistant:PORT>.
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 <http://homeassistant:PORT> or through the sidebar using Ingress.
Configurations can be done through the app webUI, except for the following options.
### Options
| Option | Type | Default | Description |
|--------|------|---------|-------------|
| `PGID` | int | `0` | Group ID for file permissions |
| `PUID` | int | `0` | User ID for file permissions |
| `TZ` | str | | Timezone (e.g., `Europe/London`) |
| `localdisks` | str | | Local drives to mount (e.g., `sda1,sdb1,MYNAS`) |
| `networkdisks` | str | | SMB shares to mount (e.g., `//SERVER/SHARE`) |
| `cifsusername` | str | | SMB username for network shares |
| `cifspassword` | str | | SMB password for network shares |
| `cifsdomain` | str | | SMB domain for network shares |
### Example Configuration
```yaml
PGID: user
GPID: user
TZ: timezone
localdisks: sda1 #put the hardware name of your drive to mount separated by commas, or its label. ex. sda1, sdb1, MYNAS...
networkdisks: "//SERVER/SHARE" # optional, list of smb servers to mount, separated by commas
cifsusername: "username" # optional, smb username, same for all smb shares
cifspassword: "password" # optional, smb password
PGID: 0
PUID: 0
TZ: "Europe/London"
localdisks: "sda1,sdb1"
networkdisks: "//192.168.1.100/comics"
cifsusername: "comicuser"
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

69
navidrome/README.md
View File

@@ -27,19 +27,70 @@ This addon is based on the [docker image](https://hub.docker.com/r/deluan/navidr
## Configuration
see https://www.navidrome.org/docs/usage/configuration-options/#available-options
Webui can be found at <http://homeassistant:PORT> or through the sidebar using Ingress.
Configurations can be done through the app webUI, except for the following options.
See https://www.navidrome.org/docs/usage/configuration-options/ for additional configuration details.
### Options
| Option | Type | Default | Description |
|--------|------|---------|-------------|
| `base_url` | str | `/` | Base URL to configure Navidrome behind a proxy |
| `music_folder` | str | `/data/music` | Folder where your music library is stored |
| `data_folder` | str | `/data` | Folder to store application data (DB) |
| `log_level` | str | `info` | Log level (error, warn, info, debug, trace) |
| `ssl` | bool | `false` | Enable HTTPS for the web interface |
| `certfile` | str | | Path for the TLS certificate |
| `keyfile` | str | | Path for the TLS key file |
| `default_language` | str | | Default language for the interface |
| `image_cache_size` | str | | Size of the image cache |
| `transcoding_cache_size` | str | | Size of the transcoding cache |
| `scan_schedule` | str | | Cron expression for automatic library scanning |
| `password_encryption_key` | str | | Key for password encryption |
| `welcome_message` | str | | Custom welcome message |
| `lastfm_api_key` | str | | Last.fm API key for scrobbling |
| `lastfm_secret` | str | | Last.fm secret for scrobbling |
| `spotify_id` | str | | Spotify client ID for metadata |
| `spotify_secret` | str | | Spotify client secret for metadata |
| `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
"base_url": "localhost", # Base URL to configure Navidrome behind a proxy
"music_folder": "/data/music", # Folder where your music library is stored. Can be read-only
"data_folder": "/data/data", # Folder to store application data (DB)
"log_level": "info", # Log level. Useful for troubleshooting. Possible values: error, warn, info, debug, trace
"certfile": "fullchain.pem", # Path for the TLS certificate
"keyfile": "privkey.pem", # Path for the TLS key file
"ssl": false # should the app use https or not
base_url: "/"
music_folder: "/data/music"
data_folder: "/data"
log_level: "info"
ssl: false
certfile: "fullchain.pem"
keyfile: "privkey.pem"
scan_schedule: "0 2 * * *"
lastfm_api_key: "your-lastfm-key"
localdisks: "sda1,sdb1"
networkdisks: "//192.168.1.100/music"
cifsusername: "musicuser"
cifspassword: "password123"
cifsdomain: "workgroup"
```
Webui can be found at `<your-ip>:port`.
### 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:
- **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

44
prowlarr/README.md
View File

@@ -44,22 +44,44 @@ The installation of this add-on is pretty straightforward and not different in c
## Configuration
---
Webui can be found at <http://homeassistant:PORT> or through the sidebar using Ingress.
Configurations can be done through the app webUI, except for the following options.
Webui can be found at <http://homeassistant:PORT>.
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`) |
| `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 |
### Example Configuration
```yaml
PGID: user
GPID: user
TZ: timezone
localdisks: sda1 #put the hardware name of your drive to mount separated by commas, or its label. ex. sda1, sdb1, MYNAS...
networkdisks: "//SERVER/SHARE" # optional, list of smb servers to mount, separated by commas
cifsusername: "username" # optional, smb username, same for all smb shares
cifspassword: "password" # optional, smb password
PGID: 0
PUID: 0
TZ: "Europe/London"
localdisks: "sda1,sdb1"
networkdisks: "//192.168.1.100/indexers"
cifsusername: "indexer"
cifspassword: "password123"
cifsdomain: "workgroup"
smbv1: 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)
## Support
Create an issue on github

64
readarr/README.md
View File

@@ -42,43 +42,67 @@ The installation of this add-on is pretty straightforward and not different in c
1. Check the logs of the add-on to see if everything went well.
1. Open the webUI and adapt the software options
## Usage
## Configuration
Webui can be found at <http://homeassistant:8787/readarr> or with ingress ☝️ by clicking the `Open Web UI` button.
Webui can be found at <http://homeassistant:8787/readarr> or through the sidebar using Ingress.
Configurations can be done through the app webUI, except for the following options.
The default username/password : described in the startup log.
### Options
## Configuration
| 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`) |
| `CONFIG_LOCATION` | str | `/config` | Path where Readarr config is stored |
| `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 |
Options can be configured through three ways :
### Connection Modes
### Addon options
- `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"
CONFIG_LOCATION: "/config"
connection_mode: "ingress_noauth"
localdisks: "sda1,sdb1"
networkdisks: "//192.168.1.100/books,//nas.local/ebooks"
cifsusername: "bookuser"
cifspassword: "password123"
cifsdomain: "workgroup"
```
### Within readarr itself
### Mounting Drives
All normal configuration from within the app
This addon supports mounting both local drives and remote SMB shares:
### The ENV override file: `/config/addons_config/readarr_nas.yml`
- **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)
For more control, you can add enviroment variables by defining them as keys in a valid `.yaml` file.
### 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)
You can add environment variables by creating `/config/addons_config/readarr_nas.yml`:
```yaml
TZ: Europe/Paris
```
more info : https://github.com/alexbelgium/hassio-addons/wiki/Addons-feature:-add-env-variables
## Support
Create an issue on github

37
tdarr/README.md
View File

@@ -28,16 +28,41 @@ This addon is based on the [docker image](https://hub.docker.com/r/hurlenko/Tdar
## Configuration
Webui can be found at <http://homeassistant:8265>.
App documentation can be found here : https://docs.tdarr.io/docs/welcome/what/
Webui can be found at <http://homeassistant:8265> or through the sidebar using Ingress.
App documentation can be found here: https://docs.tdarr.io/docs/welcome/what/
Configurations can be done through the app webUI, except for the following options.
### Options
| Option | Type | Default | Description |
|--------|------|---------|-------------|
| `CONFIG_LOCATION` | str | `/config/addons_config/tdarr` | Path where Tdarr config is stored |
| `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
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)
CONFIG_LOCATION: "/config/addons_config/tdarr"
TZ: "Europe/London"
localdisks: "sda1,sdb1"
networkdisks: "//192.168.1.100/media,//nas.local/transcoding"
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

17
tor/README.md
View File

@@ -40,7 +40,22 @@ The installation of this add-on is pretty straightforward and not different in c
## Configuration
You should follow to the initial guide for configuring base addon options. Here will described only extra options in comparisons with base:
Configurations can be done through the app webUI, except for the following options.
### Options
| Option | Type | Default | Description |
|--------|------|---------|-------------|
| `hidden_services` | bool | `true` | Enable Tor hidden services |
| `http_tunnel` | bool | `false` | Enable HTTP tunnel on port 9080 |
| `socks` | bool | `false` | Enable SOCKS proxy |
| `stealth` | bool | `false` | Enable stealth mode |
| `bridges` | list | `[]` | List of bridge configurations |
| `client_names` | list | `[]` | Client names for stealth authentication |
| `ports` | list | `["8123", "8123:80"]` | Ports to expose via Tor |
| `log_level` | list | | Log level (trace/debug/info/notice/warning/error/fatal) |
You should follow the initial guide for configuring base addon options. Here are the extra options specific to this extended version:
### Option: `http_tunnel`

58
ubooquity/README.md
View File

@@ -49,23 +49,59 @@ comparison to installing any other Hass.io add-on.
## Configuration
---
Webui can be found at <http://homeassistant:PORT> or through the sidebar using Ingress.
The default username/password is described in the startup log.
Configurations can be done through the app webUI, except for the following options.
The default username/password : described in the startup log.
Configurations can be done through the app webUI, except for the following options
### Options
Network disk is mounted to /mnt/share name
| 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`) |
| `maxmem` | int | `200` | Maximum RAM usage for Java (MB) - **CRITICAL SETTING** |
| `ssl` | bool | `false` | Enable HTTPS for the web interface |
| `certfile` | str | `fullchain.pem` | Path for the TLS certificate |
| `keyfile` | str | `privkey.pem` | Path for the TLS key file |
| `theme` | list | `default` | Theme selection (default/comixology2/plextheme-master) |
| `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 |
**Important**: The `maxmem` setting controls Java heap space. Too low causes OutOfMemoryError; too high can crash Home Assistant. Default 200MB for RPi3B+, 512MB recommended for systems with 2GB+ RAM.
### Example Configuration
```yaml
PGID: user # https://docs.linuxserver.io/general/understanding-puid-and-pgid
GPID: user # https://docs.linuxserver.io/general/understanding-puid-and-pgid
maxmem: 200 # IMPORTANT read above. 200 is default for rpi3b+ ; 512 recommended if more 2gb RAM.
networkdisks: "<//SERVER/SHARE>" # list of smbv2/3 servers to mount (optional)
cifsusername: "username" # smb username (optional)
cifspassword: "password" # smb password (optional)
smbv1: false # Should smbv1 be used instead of 2.1+?
PGID: 0
PUID: 0
TZ: "Europe/London"
maxmem: 512
ssl: false
certfile: "fullchain.pem"
keyfile: "privkey.pem"
theme: "comixology2"
localdisks: "sda1,sdb1"
networkdisks: "//192.168.1.100/comics,//nas.local/books"
cifsusername: "comicuser"
cifspassword: "password123"
cifsdomain: "workgroup"
smbv1: 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)
Network disks are mounted to `/mnt/share_name`.
## Support
Create an issue on the [repository github][repository], or ask on the [home assistant thread](https://community.home-assistant.io/t/home-assistant-addon-ubooquity/283811)

56
whoogle/README.md
View File

@@ -27,20 +27,60 @@ This addon is based on the docker image https://hub.docker.com/r/benbusby/whoogl
## Configuration
Webui can be found at <http://homeassistant:PORT>.
Configurations can be done through the app webUI, except for the following options
Webui can be found at <http://homeassistant:PORT> 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 :
### Options
- Addon options
| Option | Type | Default | Description |
|--------|------|---------|-------------|
| `TZ` | str | `Europe/Amsterdam` | Timezone |
| `WHOOGLE_CONFIG_LANGUAGE` | str | `lang_en` | Interface language |
| `WHOOGLE_CONFIG_URL` | str | | Base URL for the service |
| `WHOOGLE_CONFIG_THEME` | list | | Theme (system/light/dark) |
| `WHOOGLE_CONFIG_COUNTRY` | str | | Country code for search results |
| `WHOOGLE_CONFIG_SEARCH_LANGUAGE` | str | | Search language |
| `WHOOGLE_CONFIG_BLOCK` | str | | Comma-separated list of sites to block |
| `WHOOGLE_CONFIG_SAFE` | list | | Safe search (0/1) |
| `WHOOGLE_CONFIG_ALTS` | list | | Use alternative frontends (0/1) |
| `WHOOGLE_CONFIG_NEW_TAB` | list | | Open results in new tab (0/1) |
| `WHOOGLE_CONFIG_VIEW_IMAGE` | list | | Enable view image option (0/1) |
| `WHOOGLE_CONFIG_GET_ONLY` | list | | GET requests only (0/1) |
| `WHOOGLE_CONFIG_DISABLE` | list | | Disable changing settings (0/1) |
| `WHOOGLE_AUTOCOMPLETE` | list | | Enable autocomplete (0/1) |
| `WHOOGLE_MINIMAL` | list | | Minimal mode (0/1) |
| `WHOOGLE_CSP` | list | | Content Security Policy (0/1) |
| `WHOOGLE_RESULTS_PER_PAGE` | int | | Results per page (5-100) |
| `WHOOGLE_USER` | str | | Username for authentication |
| `WHOOGLE_PASS` | password | | Password for authentication |
| `WHOOGLE_PROXY_TYPE` | str | | Proxy type |
| `WHOOGLE_PROXY_LOC` | str | | Proxy location |
| `WHOOGLE_PROXY_USER` | str | | Proxy username |
| `WHOOGLE_PROXY_PASS` | str | | Proxy password |
| `WHOOGLE_ALT_TW` | str | | Twitter alternative frontend |
| `WHOOGLE_ALT_YT` | str | | YouTube alternative frontend |
| `WHOOGLE_ALT_IG` | str | | Instagram alternative frontend |
| `WHOOGLE_ALT_RD` | str | | Reddit alternative frontend |
| `WHOOGLE_ALT_MD` | str | | Medium alternative frontend |
| `WHOOGLE_ALT_TL` | str | | TikTok alternative frontend |
| `HTTPS_ONLY` | list | | HTTPS only mode (0/1) |
### Example Configuration
```yaml
"CONFIG_LOCATION": location of the config.yaml (see below)
TZ: "Europe/London"
WHOOGLE_CONFIG_LANGUAGE: "lang_en"
WHOOGLE_CONFIG_URL: "https://search.mydomain.com"
WHOOGLE_CONFIG_THEME: "dark"
WHOOGLE_CONFIG_COUNTRY: "US"
WHOOGLE_CONFIG_SAFE: "0"
WHOOGLE_AUTOCOMPLETE: "1"
WHOOGLE_USER: "admin"
WHOOGLE_PASS: "secure-password"
WHOOGLE_RESULTS_PER_PAGE: 20
```
- Config.yaml
Custom env variables can be added to the config.yaml file referenced in the addon options. Full env variables can be found here : https://github.com/benbusby/whoogle-search#environment-variables. It must be entered in a valid yaml format, that is verified at launch of the addon.
For complete environment variable documentation, see: https://github.com/benbusby/whoogle-search#environment-variables
## Installation