This commit is contained in:
Alexandre
2023-01-24 10:48:40 +01:00
parent 2b47b4c927
commit ec2fc30cf1
73 changed files with 2482 additions and 3431 deletions

View File

@@ -3,108 +3,95 @@ configuration:
PGID: PGID:
name: PGID name: PGID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
PUID: PUID:
name: PUID name: PUID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
TZ: TZ:
name: TZ name: TZ
description: >- description: >-
The timezone, as described in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones The timezone, as described in
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
cifspassword: cifspassword:
name: cifspassword name: cifspassword
description: >- description: 'Your password to access your SMB share, same for all smb shares'
Your password to access your SMB share, same for all smb shares
cifsusername: cifsusername:
name: cifsusername name: cifsusername
description: >- description: 'Your username to access your SMB share, same for all smb shares'
Your username to access your SMB share, same for all smb shares
cifsdomain: cifsdomain:
name: cifsdomain name: cifsdomain
description: >- description: Allow setting the domain for the smb share
Allow setting the domain for the smb share
database: database:
name: database name: database
description: >- description: Type of database to use
Type of database to use
data_location: data_location:
name: data_location name: data_location
description: >- description: Where do you want your data stored
Where do you want your data stored
localdisks: localdisks:
name: localdisks name: localdisks
description: >- description: >-
Physical name of the partition (ex. sda1) or the share (ex. SharedFiles) to mount separated by commas (ex: sda1,sdb1,MYNAS) Physical name of the partition (ex. sda1) or the share (ex. SharedFiles)
to mount separated by commas (ex: sda1,sdb1,MYNAS)
networkdisks: networkdisks:
name: networkdisks name: networkdisks
description: >- description: 'list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)'
list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)
DB_HOSTNAME: DB_HOSTNAME:
name: DB_HOSTNAME name: DB_HOSTNAME
description: >- description: If using external postgresql
If using external postgresql
DB_USERNAME: DB_USERNAME:
name: DB_USERNAME name: DB_USERNAME
description: >- description: If using external postgresql
If using external postgresql
DB_PORT: DB_PORT:
name: DB_PORT name: DB_PORT
description: >- description: If using external postgresql
If using external postgresql
DB_PASSWORD: DB_PASSWORD:
name: DB_PASSWORD name: DB_PASSWORD
description: >- description: If using external postgresql
If using external postgresql
DB_DATABASE_NAME: DB_DATABASE_NAME:
name: DB_DATABASE_NAME name: DB_DATABASE_NAME
description: >- description: If using external postgresql
If using external postgresql
UPLOAD_LOCATION: UPLOAD_LOCATION:
name: UPLOAD_LOCATION name: UPLOAD_LOCATION
description: >- description: This is the location where uploaded files are stored
This is the location where uploaded files are stored
JWT_SECRET: JWT_SECRET:
name: JWT_SECRET name: JWT_SECRET
description: >- description: Used to sign the authentication keys for user login
Used to sign the authentication keys for user login
run_duration: run_duration:
name: run_duration name: run_duration
description: >- description: >-
12h #for how long should the addon run. Must be formatted as number + time unit (ex : 5s, or 2m, or 12h, or 5d...) 12h #for how long should the addon run. Must be formatted as number + time
unit (ex : 5s, or 2m, or 12h, or 5d...)
silent: silent:
name: silent name: silent
description: >- description: 'true #suppresses debug messages'
true #suppresses debug messages
ssl: ssl:
name: ssl name: ssl
description: >- description: 'true/false : enables ssl. Need certfile and keyfile filled'
true/false : enables ssl. Need certfile and keyfile filled
certfile: certfile:
name: certfile name: certfile
description: >- description: 'fullchain.pem #ssl certificate, must be located in /ssl'
fullchain.pem #ssl certificate, must be located in /ssl
keyfile: keyfile:
name: keyfile name: keyfile
description: >- description: 'privkey.pem #sslkeyfile, must be located in /ssl'
privkey.pem #sslkeyfile, must be located in /ssl
whitelist: whitelist:
name: whitelist name: whitelist
description: >- description: '"localhost,192.168.0.0/16" # list ip subnets that won''t need a password'
"localhost,192.168.0.0/16" # list ip subnets that won't need a password
customUI: customUI:
name: customUI name: customUI
description: >- description: >-
selection from list # alternative webUI can be set here. Latest version set at each addon start selection from list # alternative webUI can be set here. Latest version
set at each addon start
DNS_servers: DNS_servers:
name: DNS_servers name: DNS_servers
description: >- description: >-
8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to avoid spamming in case of local DNS ad-remover 8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to
avoid spamming in case of local DNS ad-remover
openvpn_alt_mode: openvpn_alt_mode:
name: openvpn_alt_mode name: openvpn_alt_mode
description: >- description: bind at container level and not app level
bind at container level and not app level
openvpn_config: openvpn_config:
name: openvpn_config name: openvpn_config
description: >- description: 'for example "config.ovpn" # name of the file located in /config/openvpn'
for example "config.ovpn" # name of the file located in /config/openvpn

View File

@@ -3,108 +3,95 @@ configuration:
PGID: PGID:
name: PGID name: PGID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
PUID: PUID:
name: PUID name: PUID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
TZ: TZ:
name: TZ name: TZ
description: >- description: >-
The timezone, as described in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones The timezone, as described in
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
cifspassword: cifspassword:
name: cifspassword name: cifspassword
description: >- description: "Your password to access your SMB share, same for all smb shares"
Your password to access your SMB share, same for all smb shares
cifsusername: cifsusername:
name: cifsusername name: cifsusername
description: >- description: "Your username to access your SMB share, same for all smb shares"
Your username to access your SMB share, same for all smb shares
cifsdomain: cifsdomain:
name: cifsdomain name: cifsdomain
description: >- description: Allow setting the domain for the smb share
Allow setting the domain for the smb share
database: database:
name: database name: database
description: >- description: Type of database to use
Type of database to use
data_location: data_location:
name: data_location name: data_location
description: >- description: Where do you want your data stored
Where do you want your data stored
localdisks: localdisks:
name: localdisks name: localdisks
description: >- description: >-
Physical name of the partition (ex. sda1) or the share (ex. SharedFiles) to mount separated by commas (ex: sda1,sdb1,MYNAS) Physical name of the partition (ex. sda1) or the share (ex. SharedFiles)
to mount separated by commas (ex: sda1,sdb1,MYNAS)
networkdisks: networkdisks:
name: networkdisks name: networkdisks
description: >- description: "list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)"
list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)
DB_HOSTNAME: DB_HOSTNAME:
name: DB_HOSTNAME name: DB_HOSTNAME
description: >- description: If using external postgresql
If using external postgresql
DB_USERNAME: DB_USERNAME:
name: DB_USERNAME name: DB_USERNAME
description: >- description: If using external postgresql
If using external postgresql
DB_PORT: DB_PORT:
name: DB_PORT name: DB_PORT
description: >- description: If using external postgresql
If using external postgresql
DB_PASSWORD: DB_PASSWORD:
name: DB_PASSWORD name: DB_PASSWORD
description: >- description: If using external postgresql
If using external postgresql
DB_DATABASE_NAME: DB_DATABASE_NAME:
name: DB_DATABASE_NAME name: DB_DATABASE_NAME
description: >- description: If using external postgresql
If using external postgresql
UPLOAD_LOCATION: UPLOAD_LOCATION:
name: UPLOAD_LOCATION name: UPLOAD_LOCATION
description: >- description: This is the location where uploaded files are stored
This is the location where uploaded files are stored
JWT_SECRET: JWT_SECRET:
name: JWT_SECRET name: JWT_SECRET
description: >- description: Used to sign the authentication keys for user login
Used to sign the authentication keys for user login
run_duration: run_duration:
name: run_duration name: run_duration
description: >- description: >-
12h #for how long should the addon run. Must be formatted as number + time unit (ex : 5s, or 2m, or 12h, or 5d...) 12h #for how long should the addon run. Must be formatted as number + time
unit (ex : 5s, or 2m, or 12h, or 5d...)
silent: silent:
name: silent name: silent
description: >- description: "true #suppresses debug messages"
true #suppresses debug messages
ssl: ssl:
name: ssl name: ssl
description: >- description: "true/false : enables ssl. Need certfile and keyfile filled"
true/false : enables ssl. Need certfile and keyfile filled
certfile: certfile:
name: certfile name: certfile
description: >- description: "fullchain.pem #ssl certificate, must be located in /ssl"
fullchain.pem #ssl certificate, must be located in /ssl
keyfile: keyfile:
name: keyfile name: keyfile
description: >- description: "privkey.pem #sslkeyfile, must be located in /ssl"
privkey.pem #sslkeyfile, must be located in /ssl
whitelist: whitelist:
name: whitelist name: whitelist
description: >- description: '"localhost,192.168.0.0/16" # list ip subnets that won''t need a password'
"localhost,192.168.0.0/16" # list ip subnets that won't need a password
customUI: customUI:
name: customUI name: customUI
description: >- description: >-
selection from list # alternative webUI can be set here. Latest version set at each addon start selection from list # alternative webUI can be set here. Latest version
set at each addon start
DNS_servers: DNS_servers:
name: DNS_servers name: DNS_servers
description: >- description: >-
8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to avoid spamming in case of local DNS ad-remover 8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to
avoid spamming in case of local DNS ad-remover
openvpn_alt_mode: openvpn_alt_mode:
name: openvpn_alt_mode name: openvpn_alt_mode
description: >- description: bind at container level and not app level
bind at container level and not app level
openvpn_config: openvpn_config:
name: openvpn_config name: openvpn_config
description: >- description: 'for example "config.ovpn" # name of the file located in /config/openvpn'
for example "config.ovpn" # name of the file located in /config/openvpn

View File

@@ -3,108 +3,95 @@ configuration:
PGID: PGID:
name: PGID name: PGID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
PUID: PUID:
name: PUID name: PUID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
TZ: TZ:
name: TZ name: TZ
description: >- description: >-
The timezone, as described in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones The timezone, as described in
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
cifspassword: cifspassword:
name: cifspassword name: cifspassword
description: >- description: "Your password to access your SMB share, same for all smb shares"
Your password to access your SMB share, same for all smb shares
cifsusername: cifsusername:
name: cifsusername name: cifsusername
description: >- description: "Your username to access your SMB share, same for all smb shares"
Your username to access your SMB share, same for all smb shares
cifsdomain: cifsdomain:
name: cifsdomain name: cifsdomain
description: >- description: Allow setting the domain for the smb share
Allow setting the domain for the smb share
database: database:
name: database name: database
description: >- description: Type of database to use
Type of database to use
data_location: data_location:
name: data_location name: data_location
description: >- description: Where do you want your data stored
Where do you want your data stored
localdisks: localdisks:
name: localdisks name: localdisks
description: >- description: >-
Physical name of the partition (ex. sda1) or the share (ex. SharedFiles) to mount separated by commas (ex: sda1,sdb1,MYNAS) Physical name of the partition (ex. sda1) or the share (ex. SharedFiles)
to mount separated by commas (ex: sda1,sdb1,MYNAS)
networkdisks: networkdisks:
name: networkdisks name: networkdisks
description: >- description: "list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)"
list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)
DB_HOSTNAME: DB_HOSTNAME:
name: DB_HOSTNAME name: DB_HOSTNAME
description: >- description: If using external postgresql
If using external postgresql
DB_USERNAME: DB_USERNAME:
name: DB_USERNAME name: DB_USERNAME
description: >- description: If using external postgresql
If using external postgresql
DB_PORT: DB_PORT:
name: DB_PORT name: DB_PORT
description: >- description: If using external postgresql
If using external postgresql
DB_PASSWORD: DB_PASSWORD:
name: DB_PASSWORD name: DB_PASSWORD
description: >- description: If using external postgresql
If using external postgresql
DB_DATABASE_NAME: DB_DATABASE_NAME:
name: DB_DATABASE_NAME name: DB_DATABASE_NAME
description: >- description: If using external postgresql
If using external postgresql
UPLOAD_LOCATION: UPLOAD_LOCATION:
name: UPLOAD_LOCATION name: UPLOAD_LOCATION
description: >- description: This is the location where uploaded files are stored
This is the location where uploaded files are stored
JWT_SECRET: JWT_SECRET:
name: JWT_SECRET name: JWT_SECRET
description: >- description: Used to sign the authentication keys for user login
Used to sign the authentication keys for user login
run_duration: run_duration:
name: run_duration name: run_duration
description: >- description: >-
12h #for how long should the addon run. Must be formatted as number + time unit (ex : 5s, or 2m, or 12h, or 5d...) 12h #for how long should the addon run. Must be formatted as number + time
unit (ex : 5s, or 2m, or 12h, or 5d...)
silent: silent:
name: silent name: silent
description: >- description: "true #suppresses debug messages"
true #suppresses debug messages
ssl: ssl:
name: ssl name: ssl
description: >- description: "true/false : enables ssl. Need certfile and keyfile filled"
true/false : enables ssl. Need certfile and keyfile filled
certfile: certfile:
name: certfile name: certfile
description: >- description: "fullchain.pem #ssl certificate, must be located in /ssl"
fullchain.pem #ssl certificate, must be located in /ssl
keyfile: keyfile:
name: keyfile name: keyfile
description: >- description: "privkey.pem #sslkeyfile, must be located in /ssl"
privkey.pem #sslkeyfile, must be located in /ssl
whitelist: whitelist:
name: whitelist name: whitelist
description: >- description: '"localhost,192.168.0.0/16" # list ip subnets that won''t need a password'
"localhost,192.168.0.0/16" # list ip subnets that won't need a password
customUI: customUI:
name: customUI name: customUI
description: >- description: >-
selection from list # alternative webUI can be set here. Latest version set at each addon start selection from list # alternative webUI can be set here. Latest version
set at each addon start
DNS_servers: DNS_servers:
name: DNS_servers name: DNS_servers
description: >- description: >-
8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to avoid spamming in case of local DNS ad-remover 8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to
avoid spamming in case of local DNS ad-remover
openvpn_alt_mode: openvpn_alt_mode:
name: openvpn_alt_mode name: openvpn_alt_mode
description: >- description: bind at container level and not app level
bind at container level and not app level
openvpn_config: openvpn_config:
name: openvpn_config name: openvpn_config
description: >- description: 'for example "config.ovpn" # name of the file located in /config/openvpn'
for example "config.ovpn" # name of the file located in /config/openvpn

View File

@@ -3,108 +3,95 @@ configuration:
PGID: PGID:
name: PGID name: PGID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
PUID: PUID:
name: PUID name: PUID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
TZ: TZ:
name: TZ name: TZ
description: >- description: >-
The timezone, as described in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones The timezone, as described in
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
cifspassword: cifspassword:
name: cifspassword name: cifspassword
description: >- description: "Your password to access your SMB share, same for all smb shares"
Your password to access your SMB share, same for all smb shares
cifsusername: cifsusername:
name: cifsusername name: cifsusername
description: >- description: "Your username to access your SMB share, same for all smb shares"
Your username to access your SMB share, same for all smb shares
cifsdomain: cifsdomain:
name: cifsdomain name: cifsdomain
description: >- description: Allow setting the domain for the smb share
Allow setting the domain for the smb share
database: database:
name: database name: database
description: >- description: Type of database to use
Type of database to use
data_location: data_location:
name: data_location name: data_location
description: >- description: Where do you want your data stored
Where do you want your data stored
localdisks: localdisks:
name: localdisks name: localdisks
description: >- description: >-
Physical name of the partition (ex. sda1) or the share (ex. SharedFiles) to mount separated by commas (ex: sda1,sdb1,MYNAS) Physical name of the partition (ex. sda1) or the share (ex. SharedFiles)
to mount separated by commas (ex: sda1,sdb1,MYNAS)
networkdisks: networkdisks:
name: networkdisks name: networkdisks
description: >- description: "list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)"
list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)
DB_HOSTNAME: DB_HOSTNAME:
name: DB_HOSTNAME name: DB_HOSTNAME
description: >- description: If using external postgresql
If using external postgresql
DB_USERNAME: DB_USERNAME:
name: DB_USERNAME name: DB_USERNAME
description: >- description: If using external postgresql
If using external postgresql
DB_PORT: DB_PORT:
name: DB_PORT name: DB_PORT
description: >- description: If using external postgresql
If using external postgresql
DB_PASSWORD: DB_PASSWORD:
name: DB_PASSWORD name: DB_PASSWORD
description: >- description: If using external postgresql
If using external postgresql
DB_DATABASE_NAME: DB_DATABASE_NAME:
name: DB_DATABASE_NAME name: DB_DATABASE_NAME
description: >- description: If using external postgresql
If using external postgresql
UPLOAD_LOCATION: UPLOAD_LOCATION:
name: UPLOAD_LOCATION name: UPLOAD_LOCATION
description: >- description: This is the location where uploaded files are stored
This is the location where uploaded files are stored
JWT_SECRET: JWT_SECRET:
name: JWT_SECRET name: JWT_SECRET
description: >- description: Used to sign the authentication keys for user login
Used to sign the authentication keys for user login
run_duration: run_duration:
name: run_duration name: run_duration
description: >- description: >-
12h #for how long should the addon run. Must be formatted as number + time unit (ex : 5s, or 2m, or 12h, or 5d...) 12h #for how long should the addon run. Must be formatted as number + time
unit (ex : 5s, or 2m, or 12h, or 5d...)
silent: silent:
name: silent name: silent
description: >- description: "true #suppresses debug messages"
true #suppresses debug messages
ssl: ssl:
name: ssl name: ssl
description: >- description: "true/false : enables ssl. Need certfile and keyfile filled"
true/false : enables ssl. Need certfile and keyfile filled
certfile: certfile:
name: certfile name: certfile
description: >- description: "fullchain.pem #ssl certificate, must be located in /ssl"
fullchain.pem #ssl certificate, must be located in /ssl
keyfile: keyfile:
name: keyfile name: keyfile
description: >- description: "privkey.pem #sslkeyfile, must be located in /ssl"
privkey.pem #sslkeyfile, must be located in /ssl
whitelist: whitelist:
name: whitelist name: whitelist
description: >- description: '"localhost,192.168.0.0/16" # list ip subnets that won''t need a password'
"localhost,192.168.0.0/16" # list ip subnets that won't need a password
customUI: customUI:
name: customUI name: customUI
description: >- description: >-
selection from list # alternative webUI can be set here. Latest version set at each addon start selection from list # alternative webUI can be set here. Latest version
set at each addon start
DNS_servers: DNS_servers:
name: DNS_servers name: DNS_servers
description: >- description: >-
8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to avoid spamming in case of local DNS ad-remover 8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to
avoid spamming in case of local DNS ad-remover
openvpn_alt_mode: openvpn_alt_mode:
name: openvpn_alt_mode name: openvpn_alt_mode
description: >- description: bind at container level and not app level
bind at container level and not app level
openvpn_config: openvpn_config:
name: openvpn_config name: openvpn_config
description: >- description: 'for example "config.ovpn" # name of the file located in /config/openvpn'
for example "config.ovpn" # name of the file located in /config/openvpn

View File

@@ -3,108 +3,95 @@ configuration:
PGID: PGID:
name: PGID name: PGID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
PUID: PUID:
name: PUID name: PUID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
TZ: TZ:
name: TZ name: TZ
description: >- description: >-
The timezone, as described in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones The timezone, as described in
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
cifspassword: cifspassword:
name: cifspassword name: cifspassword
description: >- description: "Your password to access your SMB share, same for all smb shares"
Your password to access your SMB share, same for all smb shares
cifsusername: cifsusername:
name: cifsusername name: cifsusername
description: >- description: "Your username to access your SMB share, same for all smb shares"
Your username to access your SMB share, same for all smb shares
cifsdomain: cifsdomain:
name: cifsdomain name: cifsdomain
description: >- description: Allow setting the domain for the smb share
Allow setting the domain for the smb share
database: database:
name: database name: database
description: >- description: Type of database to use
Type of database to use
data_location: data_location:
name: data_location name: data_location
description: >- description: Where do you want your data stored
Where do you want your data stored
localdisks: localdisks:
name: localdisks name: localdisks
description: >- description: >-
Physical name of the partition (ex. sda1) or the share (ex. SharedFiles) to mount separated by commas (ex: sda1,sdb1,MYNAS) Physical name of the partition (ex. sda1) or the share (ex. SharedFiles)
to mount separated by commas (ex: sda1,sdb1,MYNAS)
networkdisks: networkdisks:
name: networkdisks name: networkdisks
description: >- description: "list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)"
list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)
DB_HOSTNAME: DB_HOSTNAME:
name: DB_HOSTNAME name: DB_HOSTNAME
description: >- description: If using external postgresql
If using external postgresql
DB_USERNAME: DB_USERNAME:
name: DB_USERNAME name: DB_USERNAME
description: >- description: If using external postgresql
If using external postgresql
DB_PORT: DB_PORT:
name: DB_PORT name: DB_PORT
description: >- description: If using external postgresql
If using external postgresql
DB_PASSWORD: DB_PASSWORD:
name: DB_PASSWORD name: DB_PASSWORD
description: >- description: If using external postgresql
If using external postgresql
DB_DATABASE_NAME: DB_DATABASE_NAME:
name: DB_DATABASE_NAME name: DB_DATABASE_NAME
description: >- description: If using external postgresql
If using external postgresql
UPLOAD_LOCATION: UPLOAD_LOCATION:
name: UPLOAD_LOCATION name: UPLOAD_LOCATION
description: >- description: This is the location where uploaded files are stored
This is the location where uploaded files are stored
JWT_SECRET: JWT_SECRET:
name: JWT_SECRET name: JWT_SECRET
description: >- description: Used to sign the authentication keys for user login
Used to sign the authentication keys for user login
run_duration: run_duration:
name: run_duration name: run_duration
description: >- description: >-
12h #for how long should the addon run. Must be formatted as number + time unit (ex : 5s, or 2m, or 12h, or 5d...) 12h #for how long should the addon run. Must be formatted as number + time
unit (ex : 5s, or 2m, or 12h, or 5d...)
silent: silent:
name: silent name: silent
description: >- description: "true #suppresses debug messages"
true #suppresses debug messages
ssl: ssl:
name: ssl name: ssl
description: >- description: "true/false : enables ssl. Need certfile and keyfile filled"
true/false : enables ssl. Need certfile and keyfile filled
certfile: certfile:
name: certfile name: certfile
description: >- description: "fullchain.pem #ssl certificate, must be located in /ssl"
fullchain.pem #ssl certificate, must be located in /ssl
keyfile: keyfile:
name: keyfile name: keyfile
description: >- description: "privkey.pem #sslkeyfile, must be located in /ssl"
privkey.pem #sslkeyfile, must be located in /ssl
whitelist: whitelist:
name: whitelist name: whitelist
description: >- description: '"localhost,192.168.0.0/16" # list ip subnets that won''t need a password'
"localhost,192.168.0.0/16" # list ip subnets that won't need a password
customUI: customUI:
name: customUI name: customUI
description: >- description: >-
selection from list # alternative webUI can be set here. Latest version set at each addon start selection from list # alternative webUI can be set here. Latest version
set at each addon start
DNS_servers: DNS_servers:
name: DNS_servers name: DNS_servers
description: >- description: >-
8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to avoid spamming in case of local DNS ad-remover 8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to
avoid spamming in case of local DNS ad-remover
openvpn_alt_mode: openvpn_alt_mode:
name: openvpn_alt_mode name: openvpn_alt_mode
description: >- description: bind at container level and not app level
bind at container level and not app level
openvpn_config: openvpn_config:
name: openvpn_config name: openvpn_config
description: >- description: 'for example "config.ovpn" # name of the file located in /config/openvpn'
for example "config.ovpn" # name of the file located in /config/openvpn

View File

@@ -3,108 +3,95 @@ configuration:
PGID: PGID:
name: PGID name: PGID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
PUID: PUID:
name: PUID name: PUID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
TZ: TZ:
name: TZ name: TZ
description: >- description: >-
The timezone, as described in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones The timezone, as described in
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
cifspassword: cifspassword:
name: cifspassword name: cifspassword
description: >- description: "Your password to access your SMB share, same for all smb shares"
Your password to access your SMB share, same for all smb shares
cifsusername: cifsusername:
name: cifsusername name: cifsusername
description: >- description: "Your username to access your SMB share, same for all smb shares"
Your username to access your SMB share, same for all smb shares
cifsdomain: cifsdomain:
name: cifsdomain name: cifsdomain
description: >- description: Allow setting the domain for the smb share
Allow setting the domain for the smb share
database: database:
name: database name: database
description: >- description: Type of database to use
Type of database to use
data_location: data_location:
name: data_location name: data_location
description: >- description: Where do you want your data stored
Where do you want your data stored
localdisks: localdisks:
name: localdisks name: localdisks
description: >- description: >-
Physical name of the partition (ex. sda1) or the share (ex. SharedFiles) to mount separated by commas (ex: sda1,sdb1,MYNAS) Physical name of the partition (ex. sda1) or the share (ex. SharedFiles)
to mount separated by commas (ex: sda1,sdb1,MYNAS)
networkdisks: networkdisks:
name: networkdisks name: networkdisks
description: >- description: "list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)"
list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)
DB_HOSTNAME: DB_HOSTNAME:
name: DB_HOSTNAME name: DB_HOSTNAME
description: >- description: If using external postgresql
If using external postgresql
DB_USERNAME: DB_USERNAME:
name: DB_USERNAME name: DB_USERNAME
description: >- description: If using external postgresql
If using external postgresql
DB_PORT: DB_PORT:
name: DB_PORT name: DB_PORT
description: >- description: If using external postgresql
If using external postgresql
DB_PASSWORD: DB_PASSWORD:
name: DB_PASSWORD name: DB_PASSWORD
description: >- description: If using external postgresql
If using external postgresql
DB_DATABASE_NAME: DB_DATABASE_NAME:
name: DB_DATABASE_NAME name: DB_DATABASE_NAME
description: >- description: If using external postgresql
If using external postgresql
UPLOAD_LOCATION: UPLOAD_LOCATION:
name: UPLOAD_LOCATION name: UPLOAD_LOCATION
description: >- description: This is the location where uploaded files are stored
This is the location where uploaded files are stored
JWT_SECRET: JWT_SECRET:
name: JWT_SECRET name: JWT_SECRET
description: >- description: Used to sign the authentication keys for user login
Used to sign the authentication keys for user login
run_duration: run_duration:
name: run_duration name: run_duration
description: >- description: >-
12h #for how long should the addon run. Must be formatted as number + time unit (ex : 5s, or 2m, or 12h, or 5d...) 12h #for how long should the addon run. Must be formatted as number + time
unit (ex : 5s, or 2m, or 12h, or 5d...)
silent: silent:
name: silent name: silent
description: >- description: "true #suppresses debug messages"
true #suppresses debug messages
ssl: ssl:
name: ssl name: ssl
description: >- description: "true/false : enables ssl. Need certfile and keyfile filled"
true/false : enables ssl. Need certfile and keyfile filled
certfile: certfile:
name: certfile name: certfile
description: >- description: "fullchain.pem #ssl certificate, must be located in /ssl"
fullchain.pem #ssl certificate, must be located in /ssl
keyfile: keyfile:
name: keyfile name: keyfile
description: >- description: "privkey.pem #sslkeyfile, must be located in /ssl"
privkey.pem #sslkeyfile, must be located in /ssl
whitelist: whitelist:
name: whitelist name: whitelist
description: >- description: '"localhost,192.168.0.0/16" # list ip subnets that won''t need a password'
"localhost,192.168.0.0/16" # list ip subnets that won't need a password
customUI: customUI:
name: customUI name: customUI
description: >- description: >-
selection from list # alternative webUI can be set here. Latest version set at each addon start selection from list # alternative webUI can be set here. Latest version
set at each addon start
DNS_servers: DNS_servers:
name: DNS_servers name: DNS_servers
description: >- description: >-
8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to avoid spamming in case of local DNS ad-remover 8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to
avoid spamming in case of local DNS ad-remover
openvpn_alt_mode: openvpn_alt_mode:
name: openvpn_alt_mode name: openvpn_alt_mode
description: >- description: bind at container level and not app level
bind at container level and not app level
openvpn_config: openvpn_config:
name: openvpn_config name: openvpn_config
description: >- description: 'for example "config.ovpn" # name of the file located in /config/openvpn'
for example "config.ovpn" # name of the file located in /config/openvpn

View File

@@ -3,108 +3,95 @@ configuration:
PGID: PGID:
name: PGID name: PGID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
PUID: PUID:
name: PUID name: PUID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
TZ: TZ:
name: TZ name: TZ
description: >- description: >-
The timezone, as described in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones The timezone, as described in
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
cifspassword: cifspassword:
name: cifspassword name: cifspassword
description: >- description: "Your password to access your SMB share, same for all smb shares"
Your password to access your SMB share, same for all smb shares
cifsusername: cifsusername:
name: cifsusername name: cifsusername
description: >- description: "Your username to access your SMB share, same for all smb shares"
Your username to access your SMB share, same for all smb shares
cifsdomain: cifsdomain:
name: cifsdomain name: cifsdomain
description: >- description: Allow setting the domain for the smb share
Allow setting the domain for the smb share
database: database:
name: database name: database
description: >- description: Type of database to use
Type of database to use
data_location: data_location:
name: data_location name: data_location
description: >- description: Where do you want your data stored
Where do you want your data stored
localdisks: localdisks:
name: localdisks name: localdisks
description: >- description: >-
Physical name of the partition (ex. sda1) or the share (ex. SharedFiles) to mount separated by commas (ex: sda1,sdb1,MYNAS) Physical name of the partition (ex. sda1) or the share (ex. SharedFiles)
to mount separated by commas (ex: sda1,sdb1,MYNAS)
networkdisks: networkdisks:
name: networkdisks name: networkdisks
description: >- description: "list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)"
list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)
DB_HOSTNAME: DB_HOSTNAME:
name: DB_HOSTNAME name: DB_HOSTNAME
description: >- description: If using external postgresql
If using external postgresql
DB_USERNAME: DB_USERNAME:
name: DB_USERNAME name: DB_USERNAME
description: >- description: If using external postgresql
If using external postgresql
DB_PORT: DB_PORT:
name: DB_PORT name: DB_PORT
description: >- description: If using external postgresql
If using external postgresql
DB_PASSWORD: DB_PASSWORD:
name: DB_PASSWORD name: DB_PASSWORD
description: >- description: If using external postgresql
If using external postgresql
DB_DATABASE_NAME: DB_DATABASE_NAME:
name: DB_DATABASE_NAME name: DB_DATABASE_NAME
description: >- description: If using external postgresql
If using external postgresql
UPLOAD_LOCATION: UPLOAD_LOCATION:
name: UPLOAD_LOCATION name: UPLOAD_LOCATION
description: >- description: This is the location where uploaded files are stored
This is the location where uploaded files are stored
JWT_SECRET: JWT_SECRET:
name: JWT_SECRET name: JWT_SECRET
description: >- description: Used to sign the authentication keys for user login
Used to sign the authentication keys for user login
run_duration: run_duration:
name: run_duration name: run_duration
description: >- description: >-
12h #for how long should the addon run. Must be formatted as number + time unit (ex : 5s, or 2m, or 12h, or 5d...) 12h #for how long should the addon run. Must be formatted as number + time
unit (ex : 5s, or 2m, or 12h, or 5d...)
silent: silent:
name: silent name: silent
description: >- description: "true #suppresses debug messages"
true #suppresses debug messages
ssl: ssl:
name: ssl name: ssl
description: >- description: "true/false : enables ssl. Need certfile and keyfile filled"
true/false : enables ssl. Need certfile and keyfile filled
certfile: certfile:
name: certfile name: certfile
description: >- description: "fullchain.pem #ssl certificate, must be located in /ssl"
fullchain.pem #ssl certificate, must be located in /ssl
keyfile: keyfile:
name: keyfile name: keyfile
description: >- description: "privkey.pem #sslkeyfile, must be located in /ssl"
privkey.pem #sslkeyfile, must be located in /ssl
whitelist: whitelist:
name: whitelist name: whitelist
description: >- description: '"localhost,192.168.0.0/16" # list ip subnets that won''t need a password'
"localhost,192.168.0.0/16" # list ip subnets that won't need a password
customUI: customUI:
name: customUI name: customUI
description: >- description: >-
selection from list # alternative webUI can be set here. Latest version set at each addon start selection from list # alternative webUI can be set here. Latest version
set at each addon start
DNS_servers: DNS_servers:
name: DNS_servers name: DNS_servers
description: >- description: >-
8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to avoid spamming in case of local DNS ad-remover 8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to
avoid spamming in case of local DNS ad-remover
openvpn_alt_mode: openvpn_alt_mode:
name: openvpn_alt_mode name: openvpn_alt_mode
description: >- description: bind at container level and not app level
bind at container level and not app level
openvpn_config: openvpn_config:
name: openvpn_config name: openvpn_config
description: >- description: 'for example "config.ovpn" # name of the file located in /config/openvpn'
for example "config.ovpn" # name of the file located in /config/openvpn

View File

@@ -3,108 +3,95 @@ configuration:
PGID: PGID:
name: PGID name: PGID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
PUID: PUID:
name: PUID name: PUID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
TZ: TZ:
name: TZ name: TZ
description: >- description: >-
The timezone, as described in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones The timezone, as described in
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
cifspassword: cifspassword:
name: cifspassword name: cifspassword
description: >- description: "Your password to access your SMB share, same for all smb shares"
Your password to access your SMB share, same for all smb shares
cifsusername: cifsusername:
name: cifsusername name: cifsusername
description: >- description: "Your username to access your SMB share, same for all smb shares"
Your username to access your SMB share, same for all smb shares
cifsdomain: cifsdomain:
name: cifsdomain name: cifsdomain
description: >- description: Allow setting the domain for the smb share
Allow setting the domain for the smb share
database: database:
name: database name: database
description: >- description: Type of database to use
Type of database to use
data_location: data_location:
name: data_location name: data_location
description: >- description: Where do you want your data stored
Where do you want your data stored
localdisks: localdisks:
name: localdisks name: localdisks
description: >- description: >-
Physical name of the partition (ex. sda1) or the share (ex. SharedFiles) to mount separated by commas (ex: sda1,sdb1,MYNAS) Physical name of the partition (ex. sda1) or the share (ex. SharedFiles)
to mount separated by commas (ex: sda1,sdb1,MYNAS)
networkdisks: networkdisks:
name: networkdisks name: networkdisks
description: >- description: "list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)"
list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)
DB_HOSTNAME: DB_HOSTNAME:
name: DB_HOSTNAME name: DB_HOSTNAME
description: >- description: If using external postgresql
If using external postgresql
DB_USERNAME: DB_USERNAME:
name: DB_USERNAME name: DB_USERNAME
description: >- description: If using external postgresql
If using external postgresql
DB_PORT: DB_PORT:
name: DB_PORT name: DB_PORT
description: >- description: If using external postgresql
If using external postgresql
DB_PASSWORD: DB_PASSWORD:
name: DB_PASSWORD name: DB_PASSWORD
description: >- description: If using external postgresql
If using external postgresql
DB_DATABASE_NAME: DB_DATABASE_NAME:
name: DB_DATABASE_NAME name: DB_DATABASE_NAME
description: >- description: If using external postgresql
If using external postgresql
UPLOAD_LOCATION: UPLOAD_LOCATION:
name: UPLOAD_LOCATION name: UPLOAD_LOCATION
description: >- description: This is the location where uploaded files are stored
This is the location where uploaded files are stored
JWT_SECRET: JWT_SECRET:
name: JWT_SECRET name: JWT_SECRET
description: >- description: Used to sign the authentication keys for user login
Used to sign the authentication keys for user login
run_duration: run_duration:
name: run_duration name: run_duration
description: >- description: >-
12h #for how long should the addon run. Must be formatted as number + time unit (ex : 5s, or 2m, or 12h, or 5d...) 12h #for how long should the addon run. Must be formatted as number + time
unit (ex : 5s, or 2m, or 12h, or 5d...)
silent: silent:
name: silent name: silent
description: >- description: "true #suppresses debug messages"
true #suppresses debug messages
ssl: ssl:
name: ssl name: ssl
description: >- description: "true/false : enables ssl. Need certfile and keyfile filled"
true/false : enables ssl. Need certfile and keyfile filled
certfile: certfile:
name: certfile name: certfile
description: >- description: "fullchain.pem #ssl certificate, must be located in /ssl"
fullchain.pem #ssl certificate, must be located in /ssl
keyfile: keyfile:
name: keyfile name: keyfile
description: >- description: "privkey.pem #sslkeyfile, must be located in /ssl"
privkey.pem #sslkeyfile, must be located in /ssl
whitelist: whitelist:
name: whitelist name: whitelist
description: >- description: '"localhost,192.168.0.0/16" # list ip subnets that won''t need a password'
"localhost,192.168.0.0/16" # list ip subnets that won't need a password
customUI: customUI:
name: customUI name: customUI
description: >- description: >-
selection from list # alternative webUI can be set here. Latest version set at each addon start selection from list # alternative webUI can be set here. Latest version
set at each addon start
DNS_servers: DNS_servers:
name: DNS_servers name: DNS_servers
description: >- description: >-
8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to avoid spamming in case of local DNS ad-remover 8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to
avoid spamming in case of local DNS ad-remover
openvpn_alt_mode: openvpn_alt_mode:
name: openvpn_alt_mode name: openvpn_alt_mode
description: >- description: bind at container level and not app level
bind at container level and not app level
openvpn_config: openvpn_config:
name: openvpn_config name: openvpn_config
description: >- description: 'for example "config.ovpn" # name of the file located in /config/openvpn'
for example "config.ovpn" # name of the file located in /config/openvpn

View File

@@ -3,108 +3,95 @@ configuration:
PGID: PGID:
name: PGID name: PGID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
PUID: PUID:
name: PUID name: PUID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
TZ: TZ:
name: TZ name: TZ
description: >- description: >-
The timezone, as described in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones The timezone, as described in
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
cifspassword: cifspassword:
name: cifspassword name: cifspassword
description: >- description: "Your password to access your SMB share, same for all smb shares"
Your password to access your SMB share, same for all smb shares
cifsusername: cifsusername:
name: cifsusername name: cifsusername
description: >- description: "Your username to access your SMB share, same for all smb shares"
Your username to access your SMB share, same for all smb shares
cifsdomain: cifsdomain:
name: cifsdomain name: cifsdomain
description: >- description: Allow setting the domain for the smb share
Allow setting the domain for the smb share
database: database:
name: database name: database
description: >- description: Type of database to use
Type of database to use
data_location: data_location:
name: data_location name: data_location
description: >- description: Where do you want your data stored
Where do you want your data stored
localdisks: localdisks:
name: localdisks name: localdisks
description: >- description: >-
Physical name of the partition (ex. sda1) or the share (ex. SharedFiles) to mount separated by commas (ex: sda1,sdb1,MYNAS) Physical name of the partition (ex. sda1) or the share (ex. SharedFiles)
to mount separated by commas (ex: sda1,sdb1,MYNAS)
networkdisks: networkdisks:
name: networkdisks name: networkdisks
description: >- description: "list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)"
list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)
DB_HOSTNAME: DB_HOSTNAME:
name: DB_HOSTNAME name: DB_HOSTNAME
description: >- description: If using external postgresql
If using external postgresql
DB_USERNAME: DB_USERNAME:
name: DB_USERNAME name: DB_USERNAME
description: >- description: If using external postgresql
If using external postgresql
DB_PORT: DB_PORT:
name: DB_PORT name: DB_PORT
description: >- description: If using external postgresql
If using external postgresql
DB_PASSWORD: DB_PASSWORD:
name: DB_PASSWORD name: DB_PASSWORD
description: >- description: If using external postgresql
If using external postgresql
DB_DATABASE_NAME: DB_DATABASE_NAME:
name: DB_DATABASE_NAME name: DB_DATABASE_NAME
description: >- description: If using external postgresql
If using external postgresql
UPLOAD_LOCATION: UPLOAD_LOCATION:
name: UPLOAD_LOCATION name: UPLOAD_LOCATION
description: >- description: This is the location where uploaded files are stored
This is the location where uploaded files are stored
JWT_SECRET: JWT_SECRET:
name: JWT_SECRET name: JWT_SECRET
description: >- description: Used to sign the authentication keys for user login
Used to sign the authentication keys for user login
run_duration: run_duration:
name: run_duration name: run_duration
description: >- description: >-
12h #for how long should the addon run. Must be formatted as number + time unit (ex : 5s, or 2m, or 12h, or 5d...) 12h #for how long should the addon run. Must be formatted as number + time
unit (ex : 5s, or 2m, or 12h, or 5d...)
silent: silent:
name: silent name: silent
description: >- description: "true #suppresses debug messages"
true #suppresses debug messages
ssl: ssl:
name: ssl name: ssl
description: >- description: "true/false : enables ssl. Need certfile and keyfile filled"
true/false : enables ssl. Need certfile and keyfile filled
certfile: certfile:
name: certfile name: certfile
description: >- description: "fullchain.pem #ssl certificate, must be located in /ssl"
fullchain.pem #ssl certificate, must be located in /ssl
keyfile: keyfile:
name: keyfile name: keyfile
description: >- description: "privkey.pem #sslkeyfile, must be located in /ssl"
privkey.pem #sslkeyfile, must be located in /ssl
whitelist: whitelist:
name: whitelist name: whitelist
description: >- description: '"localhost,192.168.0.0/16" # list ip subnets that won''t need a password'
"localhost,192.168.0.0/16" # list ip subnets that won't need a password
customUI: customUI:
name: customUI name: customUI
description: >- description: >-
selection from list # alternative webUI can be set here. Latest version set at each addon start selection from list # alternative webUI can be set here. Latest version
set at each addon start
DNS_servers: DNS_servers:
name: DNS_servers name: DNS_servers
description: >- description: >-
8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to avoid spamming in case of local DNS ad-remover 8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to
avoid spamming in case of local DNS ad-remover
openvpn_alt_mode: openvpn_alt_mode:
name: openvpn_alt_mode name: openvpn_alt_mode
description: >- description: bind at container level and not app level
bind at container level and not app level
openvpn_config: openvpn_config:
name: openvpn_config name: openvpn_config
description: >- description: 'for example "config.ovpn" # name of the file located in /config/openvpn'
for example "config.ovpn" # name of the file located in /config/openvpn

View File

@@ -3,108 +3,95 @@ configuration:
PGID: PGID:
name: PGID name: PGID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
PUID: PUID:
name: PUID name: PUID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
TZ: TZ:
name: TZ name: TZ
description: >- description: >-
The timezone, as described in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones The timezone, as described in
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
cifspassword: cifspassword:
name: cifspassword name: cifspassword
description: >- description: "Your password to access your SMB share, same for all smb shares"
Your password to access your SMB share, same for all smb shares
cifsusername: cifsusername:
name: cifsusername name: cifsusername
description: >- description: "Your username to access your SMB share, same for all smb shares"
Your username to access your SMB share, same for all smb shares
cifsdomain: cifsdomain:
name: cifsdomain name: cifsdomain
description: >- description: Allow setting the domain for the smb share
Allow setting the domain for the smb share
database: database:
name: database name: database
description: >- description: Type of database to use
Type of database to use
data_location: data_location:
name: data_location name: data_location
description: >- description: Where do you want your data stored
Where do you want your data stored
localdisks: localdisks:
name: localdisks name: localdisks
description: >- description: >-
Physical name of the partition (ex. sda1) or the share (ex. SharedFiles) to mount separated by commas (ex: sda1,sdb1,MYNAS) Physical name of the partition (ex. sda1) or the share (ex. SharedFiles)
to mount separated by commas (ex: sda1,sdb1,MYNAS)
networkdisks: networkdisks:
name: networkdisks name: networkdisks
description: >- description: "list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)"
list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)
DB_HOSTNAME: DB_HOSTNAME:
name: DB_HOSTNAME name: DB_HOSTNAME
description: >- description: If using external postgresql
If using external postgresql
DB_USERNAME: DB_USERNAME:
name: DB_USERNAME name: DB_USERNAME
description: >- description: If using external postgresql
If using external postgresql
DB_PORT: DB_PORT:
name: DB_PORT name: DB_PORT
description: >- description: If using external postgresql
If using external postgresql
DB_PASSWORD: DB_PASSWORD:
name: DB_PASSWORD name: DB_PASSWORD
description: >- description: If using external postgresql
If using external postgresql
DB_DATABASE_NAME: DB_DATABASE_NAME:
name: DB_DATABASE_NAME name: DB_DATABASE_NAME
description: >- description: If using external postgresql
If using external postgresql
UPLOAD_LOCATION: UPLOAD_LOCATION:
name: UPLOAD_LOCATION name: UPLOAD_LOCATION
description: >- description: This is the location where uploaded files are stored
This is the location where uploaded files are stored
JWT_SECRET: JWT_SECRET:
name: JWT_SECRET name: JWT_SECRET
description: >- description: Used to sign the authentication keys for user login
Used to sign the authentication keys for user login
run_duration: run_duration:
name: run_duration name: run_duration
description: >- description: >-
12h #for how long should the addon run. Must be formatted as number + time unit (ex : 5s, or 2m, or 12h, or 5d...) 12h #for how long should the addon run. Must be formatted as number + time
unit (ex : 5s, or 2m, or 12h, or 5d...)
silent: silent:
name: silent name: silent
description: >- description: "true #suppresses debug messages"
true #suppresses debug messages
ssl: ssl:
name: ssl name: ssl
description: >- description: "true/false : enables ssl. Need certfile and keyfile filled"
true/false : enables ssl. Need certfile and keyfile filled
certfile: certfile:
name: certfile name: certfile
description: >- description: "fullchain.pem #ssl certificate, must be located in /ssl"
fullchain.pem #ssl certificate, must be located in /ssl
keyfile: keyfile:
name: keyfile name: keyfile
description: >- description: "privkey.pem #sslkeyfile, must be located in /ssl"
privkey.pem #sslkeyfile, must be located in /ssl
whitelist: whitelist:
name: whitelist name: whitelist
description: >- description: '"localhost,192.168.0.0/16" # list ip subnets that won''t need a password'
"localhost,192.168.0.0/16" # list ip subnets that won't need a password
customUI: customUI:
name: customUI name: customUI
description: >- description: >-
selection from list # alternative webUI can be set here. Latest version set at each addon start selection from list # alternative webUI can be set here. Latest version
set at each addon start
DNS_servers: DNS_servers:
name: DNS_servers name: DNS_servers
description: >- description: >-
8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to avoid spamming in case of local DNS ad-remover 8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to
avoid spamming in case of local DNS ad-remover
openvpn_alt_mode: openvpn_alt_mode:
name: openvpn_alt_mode name: openvpn_alt_mode
description: >- description: bind at container level and not app level
bind at container level and not app level
openvpn_config: openvpn_config:
name: openvpn_config name: openvpn_config
description: >- description: 'for example "config.ovpn" # name of the file located in /config/openvpn'
for example "config.ovpn" # name of the file located in /config/openvpn

View File

@@ -3,108 +3,95 @@ configuration:
PGID: PGID:
name: PGID name: PGID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
PUID: PUID:
name: PUID name: PUID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
TZ: TZ:
name: TZ name: TZ
description: >- description: >-
The timezone, as described in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones The timezone, as described in
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
cifspassword: cifspassword:
name: cifspassword name: cifspassword
description: >- description: "Your password to access your SMB share, same for all smb shares"
Your password to access your SMB share, same for all smb shares
cifsusername: cifsusername:
name: cifsusername name: cifsusername
description: >- description: "Your username to access your SMB share, same for all smb shares"
Your username to access your SMB share, same for all smb shares
cifsdomain: cifsdomain:
name: cifsdomain name: cifsdomain
description: >- description: Allow setting the domain for the smb share
Allow setting the domain for the smb share
database: database:
name: database name: database
description: >- description: Type of database to use
Type of database to use
data_location: data_location:
name: data_location name: data_location
description: >- description: Where do you want your data stored
Where do you want your data stored
localdisks: localdisks:
name: localdisks name: localdisks
description: >- description: >-
Physical name of the partition (ex. sda1) or the share (ex. SharedFiles) to mount separated by commas (ex: sda1,sdb1,MYNAS) Physical name of the partition (ex. sda1) or the share (ex. SharedFiles)
to mount separated by commas (ex: sda1,sdb1,MYNAS)
networkdisks: networkdisks:
name: networkdisks name: networkdisks
description: >- description: "list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)"
list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)
DB_HOSTNAME: DB_HOSTNAME:
name: DB_HOSTNAME name: DB_HOSTNAME
description: >- description: If using external postgresql
If using external postgresql
DB_USERNAME: DB_USERNAME:
name: DB_USERNAME name: DB_USERNAME
description: >- description: If using external postgresql
If using external postgresql
DB_PORT: DB_PORT:
name: DB_PORT name: DB_PORT
description: >- description: If using external postgresql
If using external postgresql
DB_PASSWORD: DB_PASSWORD:
name: DB_PASSWORD name: DB_PASSWORD
description: >- description: If using external postgresql
If using external postgresql
DB_DATABASE_NAME: DB_DATABASE_NAME:
name: DB_DATABASE_NAME name: DB_DATABASE_NAME
description: >- description: If using external postgresql
If using external postgresql
UPLOAD_LOCATION: UPLOAD_LOCATION:
name: UPLOAD_LOCATION name: UPLOAD_LOCATION
description: >- description: This is the location where uploaded files are stored
This is the location where uploaded files are stored
JWT_SECRET: JWT_SECRET:
name: JWT_SECRET name: JWT_SECRET
description: >- description: Used to sign the authentication keys for user login
Used to sign the authentication keys for user login
run_duration: run_duration:
name: run_duration name: run_duration
description: >- description: >-
12h #for how long should the addon run. Must be formatted as number + time unit (ex : 5s, or 2m, or 12h, or 5d...) 12h #for how long should the addon run. Must be formatted as number + time
unit (ex : 5s, or 2m, or 12h, or 5d...)
silent: silent:
name: silent name: silent
description: >- description: "true #suppresses debug messages"
true #suppresses debug messages
ssl: ssl:
name: ssl name: ssl
description: >- description: "true/false : enables ssl. Need certfile and keyfile filled"
true/false : enables ssl. Need certfile and keyfile filled
certfile: certfile:
name: certfile name: certfile
description: >- description: "fullchain.pem #ssl certificate, must be located in /ssl"
fullchain.pem #ssl certificate, must be located in /ssl
keyfile: keyfile:
name: keyfile name: keyfile
description: >- description: "privkey.pem #sslkeyfile, must be located in /ssl"
privkey.pem #sslkeyfile, must be located in /ssl
whitelist: whitelist:
name: whitelist name: whitelist
description: >- description: '"localhost,192.168.0.0/16" # list ip subnets that won''t need a password'
"localhost,192.168.0.0/16" # list ip subnets that won't need a password
customUI: customUI:
name: customUI name: customUI
description: >- description: >-
selection from list # alternative webUI can be set here. Latest version set at each addon start selection from list # alternative webUI can be set here. Latest version
set at each addon start
DNS_servers: DNS_servers:
name: DNS_servers name: DNS_servers
description: >- description: >-
8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to avoid spamming in case of local DNS ad-remover 8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to
avoid spamming in case of local DNS ad-remover
openvpn_alt_mode: openvpn_alt_mode:
name: openvpn_alt_mode name: openvpn_alt_mode
description: >- description: bind at container level and not app level
bind at container level and not app level
openvpn_config: openvpn_config:
name: openvpn_config name: openvpn_config
description: >- description: 'for example "config.ovpn" # name of the file located in /config/openvpn'
for example "config.ovpn" # name of the file located in /config/openvpn

View File

@@ -3,108 +3,95 @@ configuration:
PGID: PGID:
name: PGID name: PGID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
PUID: PUID:
name: PUID name: PUID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
TZ: TZ:
name: TZ name: TZ
description: >- description: >-
The timezone, as described in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones The timezone, as described in
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
cifspassword: cifspassword:
name: cifspassword name: cifspassword
description: >- description: "Your password to access your SMB share, same for all smb shares"
Your password to access your SMB share, same for all smb shares
cifsusername: cifsusername:
name: cifsusername name: cifsusername
description: >- description: "Your username to access your SMB share, same for all smb shares"
Your username to access your SMB share, same for all smb shares
cifsdomain: cifsdomain:
name: cifsdomain name: cifsdomain
description: >- description: Allow setting the domain for the smb share
Allow setting the domain for the smb share
database: database:
name: database name: database
description: >- description: Type of database to use
Type of database to use
data_location: data_location:
name: data_location name: data_location
description: >- description: Where do you want your data stored
Where do you want your data stored
localdisks: localdisks:
name: localdisks name: localdisks
description: >- description: >-
Physical name of the partition (ex. sda1) or the share (ex. SharedFiles) to mount separated by commas (ex: sda1,sdb1,MYNAS) Physical name of the partition (ex. sda1) or the share (ex. SharedFiles)
to mount separated by commas (ex: sda1,sdb1,MYNAS)
networkdisks: networkdisks:
name: networkdisks name: networkdisks
description: >- description: "list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)"
list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)
DB_HOSTNAME: DB_HOSTNAME:
name: DB_HOSTNAME name: DB_HOSTNAME
description: >- description: If using external postgresql
If using external postgresql
DB_USERNAME: DB_USERNAME:
name: DB_USERNAME name: DB_USERNAME
description: >- description: If using external postgresql
If using external postgresql
DB_PORT: DB_PORT:
name: DB_PORT name: DB_PORT
description: >- description: If using external postgresql
If using external postgresql
DB_PASSWORD: DB_PASSWORD:
name: DB_PASSWORD name: DB_PASSWORD
description: >- description: If using external postgresql
If using external postgresql
DB_DATABASE_NAME: DB_DATABASE_NAME:
name: DB_DATABASE_NAME name: DB_DATABASE_NAME
description: >- description: If using external postgresql
If using external postgresql
UPLOAD_LOCATION: UPLOAD_LOCATION:
name: UPLOAD_LOCATION name: UPLOAD_LOCATION
description: >- description: This is the location where uploaded files are stored
This is the location where uploaded files are stored
JWT_SECRET: JWT_SECRET:
name: JWT_SECRET name: JWT_SECRET
description: >- description: Used to sign the authentication keys for user login
Used to sign the authentication keys for user login
run_duration: run_duration:
name: run_duration name: run_duration
description: >- description: >-
12h #for how long should the addon run. Must be formatted as number + time unit (ex : 5s, or 2m, or 12h, or 5d...) 12h #for how long should the addon run. Must be formatted as number + time
unit (ex : 5s, or 2m, or 12h, or 5d...)
silent: silent:
name: silent name: silent
description: >- description: "true #suppresses debug messages"
true #suppresses debug messages
ssl: ssl:
name: ssl name: ssl
description: >- description: "true/false : enables ssl. Need certfile and keyfile filled"
true/false : enables ssl. Need certfile and keyfile filled
certfile: certfile:
name: certfile name: certfile
description: >- description: "fullchain.pem #ssl certificate, must be located in /ssl"
fullchain.pem #ssl certificate, must be located in /ssl
keyfile: keyfile:
name: keyfile name: keyfile
description: >- description: "privkey.pem #sslkeyfile, must be located in /ssl"
privkey.pem #sslkeyfile, must be located in /ssl
whitelist: whitelist:
name: whitelist name: whitelist
description: >- description: '"localhost,192.168.0.0/16" # list ip subnets that won''t need a password'
"localhost,192.168.0.0/16" # list ip subnets that won't need a password
customUI: customUI:
name: customUI name: customUI
description: >- description: >-
selection from list # alternative webUI can be set here. Latest version set at each addon start selection from list # alternative webUI can be set here. Latest version
set at each addon start
DNS_servers: DNS_servers:
name: DNS_servers name: DNS_servers
description: >- description: >-
8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to avoid spamming in case of local DNS ad-remover 8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to
avoid spamming in case of local DNS ad-remover
openvpn_alt_mode: openvpn_alt_mode:
name: openvpn_alt_mode name: openvpn_alt_mode
description: >- description: bind at container level and not app level
bind at container level and not app level
openvpn_config: openvpn_config:
name: openvpn_config name: openvpn_config
description: >- description: 'for example "config.ovpn" # name of the file located in /config/openvpn'
for example "config.ovpn" # name of the file located in /config/openvpn

View File

@@ -3,108 +3,95 @@ configuration:
PGID: PGID:
name: PGID name: PGID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
PUID: PUID:
name: PUID name: PUID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
TZ: TZ:
name: TZ name: TZ
description: >- description: >-
The timezone, as described in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones The timezone, as described in
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
cifspassword: cifspassword:
name: cifspassword name: cifspassword
description: >- description: "Your password to access your SMB share, same for all smb shares"
Your password to access your SMB share, same for all smb shares
cifsusername: cifsusername:
name: cifsusername name: cifsusername
description: >- description: "Your username to access your SMB share, same for all smb shares"
Your username to access your SMB share, same for all smb shares
cifsdomain: cifsdomain:
name: cifsdomain name: cifsdomain
description: >- description: Allow setting the domain for the smb share
Allow setting the domain for the smb share
database: database:
name: database name: database
description: >- description: Type of database to use
Type of database to use
data_location: data_location:
name: data_location name: data_location
description: >- description: Where do you want your data stored
Where do you want your data stored
localdisks: localdisks:
name: localdisks name: localdisks
description: >- description: >-
Physical name of the partition (ex. sda1) or the share (ex. SharedFiles) to mount separated by commas (ex: sda1,sdb1,MYNAS) Physical name of the partition (ex. sda1) or the share (ex. SharedFiles)
to mount separated by commas (ex: sda1,sdb1,MYNAS)
networkdisks: networkdisks:
name: networkdisks name: networkdisks
description: >- description: "list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)"
list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)
DB_HOSTNAME: DB_HOSTNAME:
name: DB_HOSTNAME name: DB_HOSTNAME
description: >- description: If using external postgresql
If using external postgresql
DB_USERNAME: DB_USERNAME:
name: DB_USERNAME name: DB_USERNAME
description: >- description: If using external postgresql
If using external postgresql
DB_PORT: DB_PORT:
name: DB_PORT name: DB_PORT
description: >- description: If using external postgresql
If using external postgresql
DB_PASSWORD: DB_PASSWORD:
name: DB_PASSWORD name: DB_PASSWORD
description: >- description: If using external postgresql
If using external postgresql
DB_DATABASE_NAME: DB_DATABASE_NAME:
name: DB_DATABASE_NAME name: DB_DATABASE_NAME
description: >- description: If using external postgresql
If using external postgresql
UPLOAD_LOCATION: UPLOAD_LOCATION:
name: UPLOAD_LOCATION name: UPLOAD_LOCATION
description: >- description: This is the location where uploaded files are stored
This is the location where uploaded files are stored
JWT_SECRET: JWT_SECRET:
name: JWT_SECRET name: JWT_SECRET
description: >- description: Used to sign the authentication keys for user login
Used to sign the authentication keys for user login
run_duration: run_duration:
name: run_duration name: run_duration
description: >- description: >-
12h #for how long should the addon run. Must be formatted as number + time unit (ex : 5s, or 2m, or 12h, or 5d...) 12h #for how long should the addon run. Must be formatted as number + time
unit (ex : 5s, or 2m, or 12h, or 5d...)
silent: silent:
name: silent name: silent
description: >- description: "true #suppresses debug messages"
true #suppresses debug messages
ssl: ssl:
name: ssl name: ssl
description: >- description: "true/false : enables ssl. Need certfile and keyfile filled"
true/false : enables ssl. Need certfile and keyfile filled
certfile: certfile:
name: certfile name: certfile
description: >- description: "fullchain.pem #ssl certificate, must be located in /ssl"
fullchain.pem #ssl certificate, must be located in /ssl
keyfile: keyfile:
name: keyfile name: keyfile
description: >- description: "privkey.pem #sslkeyfile, must be located in /ssl"
privkey.pem #sslkeyfile, must be located in /ssl
whitelist: whitelist:
name: whitelist name: whitelist
description: >- description: '"localhost,192.168.0.0/16" # list ip subnets that won''t need a password'
"localhost,192.168.0.0/16" # list ip subnets that won't need a password
customUI: customUI:
name: customUI name: customUI
description: >- description: >-
selection from list # alternative webUI can be set here. Latest version set at each addon start selection from list # alternative webUI can be set here. Latest version
set at each addon start
DNS_servers: DNS_servers:
name: DNS_servers name: DNS_servers
description: >- description: >-
8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to avoid spamming in case of local DNS ad-remover 8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to
avoid spamming in case of local DNS ad-remover
openvpn_alt_mode: openvpn_alt_mode:
name: openvpn_alt_mode name: openvpn_alt_mode
description: >- description: bind at container level and not app level
bind at container level and not app level
openvpn_config: openvpn_config:
name: openvpn_config name: openvpn_config
description: >- description: 'for example "config.ovpn" # name of the file located in /config/openvpn'
for example "config.ovpn" # name of the file located in /config/openvpn

View File

@@ -3,108 +3,95 @@ configuration:
PGID: PGID:
name: PGID name: PGID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
PUID: PUID:
name: PUID name: PUID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
TZ: TZ:
name: TZ name: TZ
description: >- description: >-
The timezone, as described in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones The timezone, as described in
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
cifspassword: cifspassword:
name: cifspassword name: cifspassword
description: >- description: "Your password to access your SMB share, same for all smb shares"
Your password to access your SMB share, same for all smb shares
cifsusername: cifsusername:
name: cifsusername name: cifsusername
description: >- description: "Your username to access your SMB share, same for all smb shares"
Your username to access your SMB share, same for all smb shares
cifsdomain: cifsdomain:
name: cifsdomain name: cifsdomain
description: >- description: Allow setting the domain for the smb share
Allow setting the domain for the smb share
database: database:
name: database name: database
description: >- description: Type of database to use
Type of database to use
data_location: data_location:
name: data_location name: data_location
description: >- description: Where do you want your data stored
Where do you want your data stored
localdisks: localdisks:
name: localdisks name: localdisks
description: >- description: >-
Physical name of the partition (ex. sda1) or the share (ex. SharedFiles) to mount separated by commas (ex: sda1,sdb1,MYNAS) Physical name of the partition (ex. sda1) or the share (ex. SharedFiles)
to mount separated by commas (ex: sda1,sdb1,MYNAS)
networkdisks: networkdisks:
name: networkdisks name: networkdisks
description: >- description: "list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)"
list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)
DB_HOSTNAME: DB_HOSTNAME:
name: DB_HOSTNAME name: DB_HOSTNAME
description: >- description: If using external postgresql
If using external postgresql
DB_USERNAME: DB_USERNAME:
name: DB_USERNAME name: DB_USERNAME
description: >- description: If using external postgresql
If using external postgresql
DB_PORT: DB_PORT:
name: DB_PORT name: DB_PORT
description: >- description: If using external postgresql
If using external postgresql
DB_PASSWORD: DB_PASSWORD:
name: DB_PASSWORD name: DB_PASSWORD
description: >- description: If using external postgresql
If using external postgresql
DB_DATABASE_NAME: DB_DATABASE_NAME:
name: DB_DATABASE_NAME name: DB_DATABASE_NAME
description: >- description: If using external postgresql
If using external postgresql
UPLOAD_LOCATION: UPLOAD_LOCATION:
name: UPLOAD_LOCATION name: UPLOAD_LOCATION
description: >- description: This is the location where uploaded files are stored
This is the location where uploaded files are stored
JWT_SECRET: JWT_SECRET:
name: JWT_SECRET name: JWT_SECRET
description: >- description: Used to sign the authentication keys for user login
Used to sign the authentication keys for user login
run_duration: run_duration:
name: run_duration name: run_duration
description: >- description: >-
12h #for how long should the addon run. Must be formatted as number + time unit (ex : 5s, or 2m, or 12h, or 5d...) 12h #for how long should the addon run. Must be formatted as number + time
unit (ex : 5s, or 2m, or 12h, or 5d...)
silent: silent:
name: silent name: silent
description: >- description: "true #suppresses debug messages"
true #suppresses debug messages
ssl: ssl:
name: ssl name: ssl
description: >- description: "true/false : enables ssl. Need certfile and keyfile filled"
true/false : enables ssl. Need certfile and keyfile filled
certfile: certfile:
name: certfile name: certfile
description: >- description: "fullchain.pem #ssl certificate, must be located in /ssl"
fullchain.pem #ssl certificate, must be located in /ssl
keyfile: keyfile:
name: keyfile name: keyfile
description: >- description: "privkey.pem #sslkeyfile, must be located in /ssl"
privkey.pem #sslkeyfile, must be located in /ssl
whitelist: whitelist:
name: whitelist name: whitelist
description: >- description: '"localhost,192.168.0.0/16" # list ip subnets that won''t need a password'
"localhost,192.168.0.0/16" # list ip subnets that won't need a password
customUI: customUI:
name: customUI name: customUI
description: >- description: >-
selection from list # alternative webUI can be set here. Latest version set at each addon start selection from list # alternative webUI can be set here. Latest version
set at each addon start
DNS_servers: DNS_servers:
name: DNS_servers name: DNS_servers
description: >- description: >-
8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to avoid spamming in case of local DNS ad-remover 8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to
avoid spamming in case of local DNS ad-remover
openvpn_alt_mode: openvpn_alt_mode:
name: openvpn_alt_mode name: openvpn_alt_mode
description: >- description: bind at container level and not app level
bind at container level and not app level
openvpn_config: openvpn_config:
name: openvpn_config name: openvpn_config
description: >- description: 'for example "config.ovpn" # name of the file located in /config/openvpn'
for example "config.ovpn" # name of the file located in /config/openvpn

View File

@@ -3,108 +3,95 @@ configuration:
PGID: PGID:
name: PGID name: PGID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
PUID: PUID:
name: PUID name: PUID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
TZ: TZ:
name: TZ name: TZ
description: >- description: >-
The timezone, as described in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones The timezone, as described in
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
cifspassword: cifspassword:
name: cifspassword name: cifspassword
description: >- description: "Your password to access your SMB share, same for all smb shares"
Your password to access your SMB share, same for all smb shares
cifsusername: cifsusername:
name: cifsusername name: cifsusername
description: >- description: "Your username to access your SMB share, same for all smb shares"
Your username to access your SMB share, same for all smb shares
cifsdomain: cifsdomain:
name: cifsdomain name: cifsdomain
description: >- description: Allow setting the domain for the smb share
Allow setting the domain for the smb share
database: database:
name: database name: database
description: >- description: Type of database to use
Type of database to use
data_location: data_location:
name: data_location name: data_location
description: >- description: Where do you want your data stored
Where do you want your data stored
localdisks: localdisks:
name: localdisks name: localdisks
description: >- description: >-
Physical name of the partition (ex. sda1) or the share (ex. SharedFiles) to mount separated by commas (ex: sda1,sdb1,MYNAS) Physical name of the partition (ex. sda1) or the share (ex. SharedFiles)
to mount separated by commas (ex: sda1,sdb1,MYNAS)
networkdisks: networkdisks:
name: networkdisks name: networkdisks
description: >- description: "list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)"
list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)
DB_HOSTNAME: DB_HOSTNAME:
name: DB_HOSTNAME name: DB_HOSTNAME
description: >- description: If using external postgresql
If using external postgresql
DB_USERNAME: DB_USERNAME:
name: DB_USERNAME name: DB_USERNAME
description: >- description: If using external postgresql
If using external postgresql
DB_PORT: DB_PORT:
name: DB_PORT name: DB_PORT
description: >- description: If using external postgresql
If using external postgresql
DB_PASSWORD: DB_PASSWORD:
name: DB_PASSWORD name: DB_PASSWORD
description: >- description: If using external postgresql
If using external postgresql
DB_DATABASE_NAME: DB_DATABASE_NAME:
name: DB_DATABASE_NAME name: DB_DATABASE_NAME
description: >- description: If using external postgresql
If using external postgresql
UPLOAD_LOCATION: UPLOAD_LOCATION:
name: UPLOAD_LOCATION name: UPLOAD_LOCATION
description: >- description: This is the location where uploaded files are stored
This is the location where uploaded files are stored
JWT_SECRET: JWT_SECRET:
name: JWT_SECRET name: JWT_SECRET
description: >- description: Used to sign the authentication keys for user login
Used to sign the authentication keys for user login
run_duration: run_duration:
name: run_duration name: run_duration
description: >- description: >-
12h #for how long should the addon run. Must be formatted as number + time unit (ex : 5s, or 2m, or 12h, or 5d...) 12h #for how long should the addon run. Must be formatted as number + time
unit (ex : 5s, or 2m, or 12h, or 5d...)
silent: silent:
name: silent name: silent
description: >- description: "true #suppresses debug messages"
true #suppresses debug messages
ssl: ssl:
name: ssl name: ssl
description: >- description: "true/false : enables ssl. Need certfile and keyfile filled"
true/false : enables ssl. Need certfile and keyfile filled
certfile: certfile:
name: certfile name: certfile
description: >- description: "fullchain.pem #ssl certificate, must be located in /ssl"
fullchain.pem #ssl certificate, must be located in /ssl
keyfile: keyfile:
name: keyfile name: keyfile
description: >- description: "privkey.pem #sslkeyfile, must be located in /ssl"
privkey.pem #sslkeyfile, must be located in /ssl
whitelist: whitelist:
name: whitelist name: whitelist
description: >- description: '"localhost,192.168.0.0/16" # list ip subnets that won''t need a password'
"localhost,192.168.0.0/16" # list ip subnets that won't need a password
customUI: customUI:
name: customUI name: customUI
description: >- description: >-
selection from list # alternative webUI can be set here. Latest version set at each addon start selection from list # alternative webUI can be set here. Latest version
set at each addon start
DNS_servers: DNS_servers:
name: DNS_servers name: DNS_servers
description: >- description: >-
8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to avoid spamming in case of local DNS ad-remover 8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to
avoid spamming in case of local DNS ad-remover
openvpn_alt_mode: openvpn_alt_mode:
name: openvpn_alt_mode name: openvpn_alt_mode
description: >- description: bind at container level and not app level
bind at container level and not app level
openvpn_config: openvpn_config:
name: openvpn_config name: openvpn_config
description: >- description: 'for example "config.ovpn" # name of the file located in /config/openvpn'
for example "config.ovpn" # name of the file located in /config/openvpn

View File

@@ -3,108 +3,95 @@ configuration:
PGID: PGID:
name: PGID name: PGID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
PUID: PUID:
name: PUID name: PUID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
TZ: TZ:
name: TZ name: TZ
description: >- description: >-
The timezone, as described in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones The timezone, as described in
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
cifspassword: cifspassword:
name: cifspassword name: cifspassword
description: >- description: "Your password to access your SMB share, same for all smb shares"
Your password to access your SMB share, same for all smb shares
cifsusername: cifsusername:
name: cifsusername name: cifsusername
description: >- description: "Your username to access your SMB share, same for all smb shares"
Your username to access your SMB share, same for all smb shares
cifsdomain: cifsdomain:
name: cifsdomain name: cifsdomain
description: >- description: Allow setting the domain for the smb share
Allow setting the domain for the smb share
database: database:
name: database name: database
description: >- description: Type of database to use
Type of database to use
data_location: data_location:
name: data_location name: data_location
description: >- description: Where do you want your data stored
Where do you want your data stored
localdisks: localdisks:
name: localdisks name: localdisks
description: >- description: >-
Physical name of the partition (ex. sda1) or the share (ex. SharedFiles) to mount separated by commas (ex: sda1,sdb1,MYNAS) Physical name of the partition (ex. sda1) or the share (ex. SharedFiles)
to mount separated by commas (ex: sda1,sdb1,MYNAS)
networkdisks: networkdisks:
name: networkdisks name: networkdisks
description: >- description: "list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)"
list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)
DB_HOSTNAME: DB_HOSTNAME:
name: DB_HOSTNAME name: DB_HOSTNAME
description: >- description: If using external postgresql
If using external postgresql
DB_USERNAME: DB_USERNAME:
name: DB_USERNAME name: DB_USERNAME
description: >- description: If using external postgresql
If using external postgresql
DB_PORT: DB_PORT:
name: DB_PORT name: DB_PORT
description: >- description: If using external postgresql
If using external postgresql
DB_PASSWORD: DB_PASSWORD:
name: DB_PASSWORD name: DB_PASSWORD
description: >- description: If using external postgresql
If using external postgresql
DB_DATABASE_NAME: DB_DATABASE_NAME:
name: DB_DATABASE_NAME name: DB_DATABASE_NAME
description: >- description: If using external postgresql
If using external postgresql
UPLOAD_LOCATION: UPLOAD_LOCATION:
name: UPLOAD_LOCATION name: UPLOAD_LOCATION
description: >- description: This is the location where uploaded files are stored
This is the location where uploaded files are stored
JWT_SECRET: JWT_SECRET:
name: JWT_SECRET name: JWT_SECRET
description: >- description: Used to sign the authentication keys for user login
Used to sign the authentication keys for user login
run_duration: run_duration:
name: run_duration name: run_duration
description: >- description: >-
12h #for how long should the addon run. Must be formatted as number + time unit (ex : 5s, or 2m, or 12h, or 5d...) 12h #for how long should the addon run. Must be formatted as number + time
unit (ex : 5s, or 2m, or 12h, or 5d...)
silent: silent:
name: silent name: silent
description: >- description: "true #suppresses debug messages"
true #suppresses debug messages
ssl: ssl:
name: ssl name: ssl
description: >- description: "true/false : enables ssl. Need certfile and keyfile filled"
true/false : enables ssl. Need certfile and keyfile filled
certfile: certfile:
name: certfile name: certfile
description: >- description: "fullchain.pem #ssl certificate, must be located in /ssl"
fullchain.pem #ssl certificate, must be located in /ssl
keyfile: keyfile:
name: keyfile name: keyfile
description: >- description: "privkey.pem #sslkeyfile, must be located in /ssl"
privkey.pem #sslkeyfile, must be located in /ssl
whitelist: whitelist:
name: whitelist name: whitelist
description: >- description: '"localhost,192.168.0.0/16" # list ip subnets that won''t need a password'
"localhost,192.168.0.0/16" # list ip subnets that won't need a password
customUI: customUI:
name: customUI name: customUI
description: >- description: >-
selection from list # alternative webUI can be set here. Latest version set at each addon start selection from list # alternative webUI can be set here. Latest version
set at each addon start
DNS_servers: DNS_servers:
name: DNS_servers name: DNS_servers
description: >- description: >-
8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to avoid spamming in case of local DNS ad-remover 8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to
avoid spamming in case of local DNS ad-remover
openvpn_alt_mode: openvpn_alt_mode:
name: openvpn_alt_mode name: openvpn_alt_mode
description: >- description: bind at container level and not app level
bind at container level and not app level
openvpn_config: openvpn_config:
name: openvpn_config name: openvpn_config
description: >- description: 'for example "config.ovpn" # name of the file located in /config/openvpn'
for example "config.ovpn" # name of the file located in /config/openvpn

View File

@@ -3,108 +3,95 @@ configuration:
PGID: PGID:
name: PGID name: PGID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
PUID: PUID:
name: PUID name: PUID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
TZ: TZ:
name: TZ name: TZ
description: >- description: >-
The timezone, as described in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones The timezone, as described in
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
cifspassword: cifspassword:
name: cifspassword name: cifspassword
description: >- description: "Your password to access your SMB share, same for all smb shares"
Your password to access your SMB share, same for all smb shares
cifsusername: cifsusername:
name: cifsusername name: cifsusername
description: >- description: "Your username to access your SMB share, same for all smb shares"
Your username to access your SMB share, same for all smb shares
cifsdomain: cifsdomain:
name: cifsdomain name: cifsdomain
description: >- description: Allow setting the domain for the smb share
Allow setting the domain for the smb share
database: database:
name: database name: database
description: >- description: Type of database to use
Type of database to use
data_location: data_location:
name: data_location name: data_location
description: >- description: Where do you want your data stored
Where do you want your data stored
localdisks: localdisks:
name: localdisks name: localdisks
description: >- description: >-
Physical name of the partition (ex. sda1) or the share (ex. SharedFiles) to mount separated by commas (ex: sda1,sdb1,MYNAS) Physical name of the partition (ex. sda1) or the share (ex. SharedFiles)
to mount separated by commas (ex: sda1,sdb1,MYNAS)
networkdisks: networkdisks:
name: networkdisks name: networkdisks
description: >- description: "list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)"
list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)
DB_HOSTNAME: DB_HOSTNAME:
name: DB_HOSTNAME name: DB_HOSTNAME
description: >- description: If using external postgresql
If using external postgresql
DB_USERNAME: DB_USERNAME:
name: DB_USERNAME name: DB_USERNAME
description: >- description: If using external postgresql
If using external postgresql
DB_PORT: DB_PORT:
name: DB_PORT name: DB_PORT
description: >- description: If using external postgresql
If using external postgresql
DB_PASSWORD: DB_PASSWORD:
name: DB_PASSWORD name: DB_PASSWORD
description: >- description: If using external postgresql
If using external postgresql
DB_DATABASE_NAME: DB_DATABASE_NAME:
name: DB_DATABASE_NAME name: DB_DATABASE_NAME
description: >- description: If using external postgresql
If using external postgresql
UPLOAD_LOCATION: UPLOAD_LOCATION:
name: UPLOAD_LOCATION name: UPLOAD_LOCATION
description: >- description: This is the location where uploaded files are stored
This is the location where uploaded files are stored
JWT_SECRET: JWT_SECRET:
name: JWT_SECRET name: JWT_SECRET
description: >- description: Used to sign the authentication keys for user login
Used to sign the authentication keys for user login
run_duration: run_duration:
name: run_duration name: run_duration
description: >- description: >-
12h #for how long should the addon run. Must be formatted as number + time unit (ex : 5s, or 2m, or 12h, or 5d...) 12h #for how long should the addon run. Must be formatted as number + time
unit (ex : 5s, or 2m, or 12h, or 5d...)
silent: silent:
name: silent name: silent
description: >- description: "true #suppresses debug messages"
true #suppresses debug messages
ssl: ssl:
name: ssl name: ssl
description: >- description: "true/false : enables ssl. Need certfile and keyfile filled"
true/false : enables ssl. Need certfile and keyfile filled
certfile: certfile:
name: certfile name: certfile
description: >- description: "fullchain.pem #ssl certificate, must be located in /ssl"
fullchain.pem #ssl certificate, must be located in /ssl
keyfile: keyfile:
name: keyfile name: keyfile
description: >- description: "privkey.pem #sslkeyfile, must be located in /ssl"
privkey.pem #sslkeyfile, must be located in /ssl
whitelist: whitelist:
name: whitelist name: whitelist
description: >- description: '"localhost,192.168.0.0/16" # list ip subnets that won''t need a password'
"localhost,192.168.0.0/16" # list ip subnets that won't need a password
customUI: customUI:
name: customUI name: customUI
description: >- description: >-
selection from list # alternative webUI can be set here. Latest version set at each addon start selection from list # alternative webUI can be set here. Latest version
set at each addon start
DNS_servers: DNS_servers:
name: DNS_servers name: DNS_servers
description: >- description: >-
8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to avoid spamming in case of local DNS ad-remover 8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to
avoid spamming in case of local DNS ad-remover
openvpn_alt_mode: openvpn_alt_mode:
name: openvpn_alt_mode name: openvpn_alt_mode
description: >- description: bind at container level and not app level
bind at container level and not app level
openvpn_config: openvpn_config:
name: openvpn_config name: openvpn_config
description: >- description: 'for example "config.ovpn" # name of the file located in /config/openvpn'
for example "config.ovpn" # name of the file located in /config/openvpn

View File

@@ -3,108 +3,95 @@ configuration:
PGID: PGID:
name: PGID name: PGID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
PUID: PUID:
name: PUID name: PUID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
TZ: TZ:
name: TZ name: TZ
description: >- description: >-
The timezone, as described in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones The timezone, as described in
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
cifspassword: cifspassword:
name: cifspassword name: cifspassword
description: >- description: "Your password to access your SMB share, same for all smb shares"
Your password to access your SMB share, same for all smb shares
cifsusername: cifsusername:
name: cifsusername name: cifsusername
description: >- description: "Your username to access your SMB share, same for all smb shares"
Your username to access your SMB share, same for all smb shares
cifsdomain: cifsdomain:
name: cifsdomain name: cifsdomain
description: >- description: Allow setting the domain for the smb share
Allow setting the domain for the smb share
database: database:
name: database name: database
description: >- description: Type of database to use
Type of database to use
data_location: data_location:
name: data_location name: data_location
description: >- description: Where do you want your data stored
Where do you want your data stored
localdisks: localdisks:
name: localdisks name: localdisks
description: >- description: >-
Physical name of the partition (ex. sda1) or the share (ex. SharedFiles) to mount separated by commas (ex: sda1,sdb1,MYNAS) Physical name of the partition (ex. sda1) or the share (ex. SharedFiles)
to mount separated by commas (ex: sda1,sdb1,MYNAS)
networkdisks: networkdisks:
name: networkdisks name: networkdisks
description: >- description: "list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)"
list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)
DB_HOSTNAME: DB_HOSTNAME:
name: DB_HOSTNAME name: DB_HOSTNAME
description: >- description: If using external postgresql
If using external postgresql
DB_USERNAME: DB_USERNAME:
name: DB_USERNAME name: DB_USERNAME
description: >- description: If using external postgresql
If using external postgresql
DB_PORT: DB_PORT:
name: DB_PORT name: DB_PORT
description: >- description: If using external postgresql
If using external postgresql
DB_PASSWORD: DB_PASSWORD:
name: DB_PASSWORD name: DB_PASSWORD
description: >- description: If using external postgresql
If using external postgresql
DB_DATABASE_NAME: DB_DATABASE_NAME:
name: DB_DATABASE_NAME name: DB_DATABASE_NAME
description: >- description: If using external postgresql
If using external postgresql
UPLOAD_LOCATION: UPLOAD_LOCATION:
name: UPLOAD_LOCATION name: UPLOAD_LOCATION
description: >- description: This is the location where uploaded files are stored
This is the location where uploaded files are stored
JWT_SECRET: JWT_SECRET:
name: JWT_SECRET name: JWT_SECRET
description: >- description: Used to sign the authentication keys for user login
Used to sign the authentication keys for user login
run_duration: run_duration:
name: run_duration name: run_duration
description: >- description: >-
12h #for how long should the addon run. Must be formatted as number + time unit (ex : 5s, or 2m, or 12h, or 5d...) 12h #for how long should the addon run. Must be formatted as number + time
unit (ex : 5s, or 2m, or 12h, or 5d...)
silent: silent:
name: silent name: silent
description: >- description: "true #suppresses debug messages"
true #suppresses debug messages
ssl: ssl:
name: ssl name: ssl
description: >- description: "true/false : enables ssl. Need certfile and keyfile filled"
true/false : enables ssl. Need certfile and keyfile filled
certfile: certfile:
name: certfile name: certfile
description: >- description: "fullchain.pem #ssl certificate, must be located in /ssl"
fullchain.pem #ssl certificate, must be located in /ssl
keyfile: keyfile:
name: keyfile name: keyfile
description: >- description: "privkey.pem #sslkeyfile, must be located in /ssl"
privkey.pem #sslkeyfile, must be located in /ssl
whitelist: whitelist:
name: whitelist name: whitelist
description: >- description: '"localhost,192.168.0.0/16" # list ip subnets that won''t need a password'
"localhost,192.168.0.0/16" # list ip subnets that won't need a password
customUI: customUI:
name: customUI name: customUI
description: >- description: >-
selection from list # alternative webUI can be set here. Latest version set at each addon start selection from list # alternative webUI can be set here. Latest version
set at each addon start
DNS_servers: DNS_servers:
name: DNS_servers name: DNS_servers
description: >- description: >-
8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to avoid spamming in case of local DNS ad-remover 8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to
avoid spamming in case of local DNS ad-remover
openvpn_alt_mode: openvpn_alt_mode:
name: openvpn_alt_mode name: openvpn_alt_mode
description: >- description: bind at container level and not app level
bind at container level and not app level
openvpn_config: openvpn_config:
name: openvpn_config name: openvpn_config
description: >- description: 'for example "config.ovpn" # name of the file located in /config/openvpn'
for example "config.ovpn" # name of the file located in /config/openvpn

View File

@@ -3,108 +3,95 @@ configuration:
PGID: PGID:
name: PGID name: PGID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
PUID: PUID:
name: PUID name: PUID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
TZ: TZ:
name: TZ name: TZ
description: >- description: >-
The timezone, as described in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones The timezone, as described in
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
cifspassword: cifspassword:
name: cifspassword name: cifspassword
description: >- description: "Your password to access your SMB share, same for all smb shares"
Your password to access your SMB share, same for all smb shares
cifsusername: cifsusername:
name: cifsusername name: cifsusername
description: >- description: "Your username to access your SMB share, same for all smb shares"
Your username to access your SMB share, same for all smb shares
cifsdomain: cifsdomain:
name: cifsdomain name: cifsdomain
description: >- description: Allow setting the domain for the smb share
Allow setting the domain for the smb share
database: database:
name: database name: database
description: >- description: Type of database to use
Type of database to use
data_location: data_location:
name: data_location name: data_location
description: >- description: Where do you want your data stored
Where do you want your data stored
localdisks: localdisks:
name: localdisks name: localdisks
description: >- description: >-
Physical name of the partition (ex. sda1) or the share (ex. SharedFiles) to mount separated by commas (ex: sda1,sdb1,MYNAS) Physical name of the partition (ex. sda1) or the share (ex. SharedFiles)
to mount separated by commas (ex: sda1,sdb1,MYNAS)
networkdisks: networkdisks:
name: networkdisks name: networkdisks
description: >- description: "list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)"
list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)
DB_HOSTNAME: DB_HOSTNAME:
name: DB_HOSTNAME name: DB_HOSTNAME
description: >- description: If using external postgresql
If using external postgresql
DB_USERNAME: DB_USERNAME:
name: DB_USERNAME name: DB_USERNAME
description: >- description: If using external postgresql
If using external postgresql
DB_PORT: DB_PORT:
name: DB_PORT name: DB_PORT
description: >- description: If using external postgresql
If using external postgresql
DB_PASSWORD: DB_PASSWORD:
name: DB_PASSWORD name: DB_PASSWORD
description: >- description: If using external postgresql
If using external postgresql
DB_DATABASE_NAME: DB_DATABASE_NAME:
name: DB_DATABASE_NAME name: DB_DATABASE_NAME
description: >- description: If using external postgresql
If using external postgresql
UPLOAD_LOCATION: UPLOAD_LOCATION:
name: UPLOAD_LOCATION name: UPLOAD_LOCATION
description: >- description: This is the location where uploaded files are stored
This is the location where uploaded files are stored
JWT_SECRET: JWT_SECRET:
name: JWT_SECRET name: JWT_SECRET
description: >- description: Used to sign the authentication keys for user login
Used to sign the authentication keys for user login
run_duration: run_duration:
name: run_duration name: run_duration
description: >- description: >-
12h #for how long should the addon run. Must be formatted as number + time unit (ex : 5s, or 2m, or 12h, or 5d...) 12h #for how long should the addon run. Must be formatted as number + time
unit (ex : 5s, or 2m, or 12h, or 5d...)
silent: silent:
name: silent name: silent
description: >- description: "true #suppresses debug messages"
true #suppresses debug messages
ssl: ssl:
name: ssl name: ssl
description: >- description: "true/false : enables ssl. Need certfile and keyfile filled"
true/false : enables ssl. Need certfile and keyfile filled
certfile: certfile:
name: certfile name: certfile
description: >- description: "fullchain.pem #ssl certificate, must be located in /ssl"
fullchain.pem #ssl certificate, must be located in /ssl
keyfile: keyfile:
name: keyfile name: keyfile
description: >- description: "privkey.pem #sslkeyfile, must be located in /ssl"
privkey.pem #sslkeyfile, must be located in /ssl
whitelist: whitelist:
name: whitelist name: whitelist
description: >- description: '"localhost,192.168.0.0/16" # list ip subnets that won''t need a password'
"localhost,192.168.0.0/16" # list ip subnets that won't need a password
customUI: customUI:
name: customUI name: customUI
description: >- description: >-
selection from list # alternative webUI can be set here. Latest version set at each addon start selection from list # alternative webUI can be set here. Latest version
set at each addon start
DNS_servers: DNS_servers:
name: DNS_servers name: DNS_servers
description: >- description: >-
8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to avoid spamming in case of local DNS ad-remover 8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to
avoid spamming in case of local DNS ad-remover
openvpn_alt_mode: openvpn_alt_mode:
name: openvpn_alt_mode name: openvpn_alt_mode
description: >- description: bind at container level and not app level
bind at container level and not app level
openvpn_config: openvpn_config:
name: openvpn_config name: openvpn_config
description: >- description: 'for example "config.ovpn" # name of the file located in /config/openvpn'
for example "config.ovpn" # name of the file located in /config/openvpn

View File

@@ -3,108 +3,95 @@ configuration:
PGID: PGID:
name: PGID name: PGID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
PUID: PUID:
name: PUID name: PUID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
TZ: TZ:
name: TZ name: TZ
description: >- description: >-
The timezone, as described in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones The timezone, as described in
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
cifspassword: cifspassword:
name: cifspassword name: cifspassword
description: >- description: "Your password to access your SMB share, same for all smb shares"
Your password to access your SMB share, same for all smb shares
cifsusername: cifsusername:
name: cifsusername name: cifsusername
description: >- description: "Your username to access your SMB share, same for all smb shares"
Your username to access your SMB share, same for all smb shares
cifsdomain: cifsdomain:
name: cifsdomain name: cifsdomain
description: >- description: Allow setting the domain for the smb share
Allow setting the domain for the smb share
database: database:
name: database name: database
description: >- description: Type of database to use
Type of database to use
data_location: data_location:
name: data_location name: data_location
description: >- description: Where do you want your data stored
Where do you want your data stored
localdisks: localdisks:
name: localdisks name: localdisks
description: >- description: >-
Physical name of the partition (ex. sda1) or the share (ex. SharedFiles) to mount separated by commas (ex: sda1,sdb1,MYNAS) Physical name of the partition (ex. sda1) or the share (ex. SharedFiles)
to mount separated by commas (ex: sda1,sdb1,MYNAS)
networkdisks: networkdisks:
name: networkdisks name: networkdisks
description: >- description: "list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)"
list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)
DB_HOSTNAME: DB_HOSTNAME:
name: DB_HOSTNAME name: DB_HOSTNAME
description: >- description: If using external postgresql
If using external postgresql
DB_USERNAME: DB_USERNAME:
name: DB_USERNAME name: DB_USERNAME
description: >- description: If using external postgresql
If using external postgresql
DB_PORT: DB_PORT:
name: DB_PORT name: DB_PORT
description: >- description: If using external postgresql
If using external postgresql
DB_PASSWORD: DB_PASSWORD:
name: DB_PASSWORD name: DB_PASSWORD
description: >- description: If using external postgresql
If using external postgresql
DB_DATABASE_NAME: DB_DATABASE_NAME:
name: DB_DATABASE_NAME name: DB_DATABASE_NAME
description: >- description: If using external postgresql
If using external postgresql
UPLOAD_LOCATION: UPLOAD_LOCATION:
name: UPLOAD_LOCATION name: UPLOAD_LOCATION
description: >- description: This is the location where uploaded files are stored
This is the location where uploaded files are stored
JWT_SECRET: JWT_SECRET:
name: JWT_SECRET name: JWT_SECRET
description: >- description: Used to sign the authentication keys for user login
Used to sign the authentication keys for user login
run_duration: run_duration:
name: run_duration name: run_duration
description: >- description: >-
12h #for how long should the addon run. Must be formatted as number + time unit (ex : 5s, or 2m, or 12h, or 5d...) 12h #for how long should the addon run. Must be formatted as number + time
unit (ex : 5s, or 2m, or 12h, or 5d...)
silent: silent:
name: silent name: silent
description: >- description: "true #suppresses debug messages"
true #suppresses debug messages
ssl: ssl:
name: ssl name: ssl
description: >- description: "true/false : enables ssl. Need certfile and keyfile filled"
true/false : enables ssl. Need certfile and keyfile filled
certfile: certfile:
name: certfile name: certfile
description: >- description: "fullchain.pem #ssl certificate, must be located in /ssl"
fullchain.pem #ssl certificate, must be located in /ssl
keyfile: keyfile:
name: keyfile name: keyfile
description: >- description: "privkey.pem #sslkeyfile, must be located in /ssl"
privkey.pem #sslkeyfile, must be located in /ssl
whitelist: whitelist:
name: whitelist name: whitelist
description: >- description: '"localhost,192.168.0.0/16" # list ip subnets that won''t need a password'
"localhost,192.168.0.0/16" # list ip subnets that won't need a password
customUI: customUI:
name: customUI name: customUI
description: >- description: >-
selection from list # alternative webUI can be set here. Latest version set at each addon start selection from list # alternative webUI can be set here. Latest version
set at each addon start
DNS_servers: DNS_servers:
name: DNS_servers name: DNS_servers
description: >- description: >-
8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to avoid spamming in case of local DNS ad-remover 8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to
avoid spamming in case of local DNS ad-remover
openvpn_alt_mode: openvpn_alt_mode:
name: openvpn_alt_mode name: openvpn_alt_mode
description: >- description: bind at container level and not app level
bind at container level and not app level
openvpn_config: openvpn_config:
name: openvpn_config name: openvpn_config
description: >- description: 'for example "config.ovpn" # name of the file located in /config/openvpn'
for example "config.ovpn" # name of the file located in /config/openvpn

View File

@@ -3,108 +3,95 @@ configuration:
PGID: PGID:
name: PGID name: PGID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
PUID: PUID:
name: PUID name: PUID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
TZ: TZ:
name: TZ name: TZ
description: >- description: >-
The timezone, as described in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones The timezone, as described in
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
cifspassword: cifspassword:
name: cifspassword name: cifspassword
description: >- description: "Your password to access your SMB share, same for all smb shares"
Your password to access your SMB share, same for all smb shares
cifsusername: cifsusername:
name: cifsusername name: cifsusername
description: >- description: "Your username to access your SMB share, same for all smb shares"
Your username to access your SMB share, same for all smb shares
cifsdomain: cifsdomain:
name: cifsdomain name: cifsdomain
description: >- description: Allow setting the domain for the smb share
Allow setting the domain for the smb share
database: database:
name: database name: database
description: >- description: Type of database to use
Type of database to use
data_location: data_location:
name: data_location name: data_location
description: >- description: Where do you want your data stored
Where do you want your data stored
localdisks: localdisks:
name: localdisks name: localdisks
description: >- description: >-
Physical name of the partition (ex. sda1) or the share (ex. SharedFiles) to mount separated by commas (ex: sda1,sdb1,MYNAS) Physical name of the partition (ex. sda1) or the share (ex. SharedFiles)
to mount separated by commas (ex: sda1,sdb1,MYNAS)
networkdisks: networkdisks:
name: networkdisks name: networkdisks
description: >- description: "list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)"
list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)
DB_HOSTNAME: DB_HOSTNAME:
name: DB_HOSTNAME name: DB_HOSTNAME
description: >- description: If using external postgresql
If using external postgresql
DB_USERNAME: DB_USERNAME:
name: DB_USERNAME name: DB_USERNAME
description: >- description: If using external postgresql
If using external postgresql
DB_PORT: DB_PORT:
name: DB_PORT name: DB_PORT
description: >- description: If using external postgresql
If using external postgresql
DB_PASSWORD: DB_PASSWORD:
name: DB_PASSWORD name: DB_PASSWORD
description: >- description: If using external postgresql
If using external postgresql
DB_DATABASE_NAME: DB_DATABASE_NAME:
name: DB_DATABASE_NAME name: DB_DATABASE_NAME
description: >- description: If using external postgresql
If using external postgresql
UPLOAD_LOCATION: UPLOAD_LOCATION:
name: UPLOAD_LOCATION name: UPLOAD_LOCATION
description: >- description: This is the location where uploaded files are stored
This is the location where uploaded files are stored
JWT_SECRET: JWT_SECRET:
name: JWT_SECRET name: JWT_SECRET
description: >- description: Used to sign the authentication keys for user login
Used to sign the authentication keys for user login
run_duration: run_duration:
name: run_duration name: run_duration
description: >- description: >-
12h #for how long should the addon run. Must be formatted as number + time unit (ex : 5s, or 2m, or 12h, or 5d...) 12h #for how long should the addon run. Must be formatted as number + time
unit (ex : 5s, or 2m, or 12h, or 5d...)
silent: silent:
name: silent name: silent
description: >- description: "true #suppresses debug messages"
true #suppresses debug messages
ssl: ssl:
name: ssl name: ssl
description: >- description: "true/false : enables ssl. Need certfile and keyfile filled"
true/false : enables ssl. Need certfile and keyfile filled
certfile: certfile:
name: certfile name: certfile
description: >- description: "fullchain.pem #ssl certificate, must be located in /ssl"
fullchain.pem #ssl certificate, must be located in /ssl
keyfile: keyfile:
name: keyfile name: keyfile
description: >- description: "privkey.pem #sslkeyfile, must be located in /ssl"
privkey.pem #sslkeyfile, must be located in /ssl
whitelist: whitelist:
name: whitelist name: whitelist
description: >- description: '"localhost,192.168.0.0/16" # list ip subnets that won''t need a password'
"localhost,192.168.0.0/16" # list ip subnets that won't need a password
customUI: customUI:
name: customUI name: customUI
description: >- description: >-
selection from list # alternative webUI can be set here. Latest version set at each addon start selection from list # alternative webUI can be set here. Latest version
set at each addon start
DNS_servers: DNS_servers:
name: DNS_servers name: DNS_servers
description: >- description: >-
8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to avoid spamming in case of local DNS ad-remover 8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to
avoid spamming in case of local DNS ad-remover
openvpn_alt_mode: openvpn_alt_mode:
name: openvpn_alt_mode name: openvpn_alt_mode
description: >- description: bind at container level and not app level
bind at container level and not app level
openvpn_config: openvpn_config:
name: openvpn_config name: openvpn_config
description: >- description: 'for example "config.ovpn" # name of the file located in /config/openvpn'
for example "config.ovpn" # name of the file located in /config/openvpn

View File

@@ -3,108 +3,95 @@ configuration:
PGID: PGID:
name: PGID name: PGID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
PUID: PUID:
name: PUID name: PUID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
TZ: TZ:
name: TZ name: TZ
description: >- description: >-
The timezone, as described in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones The timezone, as described in
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
cifspassword: cifspassword:
name: cifspassword name: cifspassword
description: >- description: "Your password to access your SMB share, same for all smb shares"
Your password to access your SMB share, same for all smb shares
cifsusername: cifsusername:
name: cifsusername name: cifsusername
description: >- description: "Your username to access your SMB share, same for all smb shares"
Your username to access your SMB share, same for all smb shares
cifsdomain: cifsdomain:
name: cifsdomain name: cifsdomain
description: >- description: Allow setting the domain for the smb share
Allow setting the domain for the smb share
database: database:
name: database name: database
description: >- description: Type of database to use
Type of database to use
data_location: data_location:
name: data_location name: data_location
description: >- description: Where do you want your data stored
Where do you want your data stored
localdisks: localdisks:
name: localdisks name: localdisks
description: >- description: >-
Physical name of the partition (ex. sda1) or the share (ex. SharedFiles) to mount separated by commas (ex: sda1,sdb1,MYNAS) Physical name of the partition (ex. sda1) or the share (ex. SharedFiles)
to mount separated by commas (ex: sda1,sdb1,MYNAS)
networkdisks: networkdisks:
name: networkdisks name: networkdisks
description: >- description: "list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)"
list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)
DB_HOSTNAME: DB_HOSTNAME:
name: DB_HOSTNAME name: DB_HOSTNAME
description: >- description: If using external postgresql
If using external postgresql
DB_USERNAME: DB_USERNAME:
name: DB_USERNAME name: DB_USERNAME
description: >- description: If using external postgresql
If using external postgresql
DB_PORT: DB_PORT:
name: DB_PORT name: DB_PORT
description: >- description: If using external postgresql
If using external postgresql
DB_PASSWORD: DB_PASSWORD:
name: DB_PASSWORD name: DB_PASSWORD
description: >- description: If using external postgresql
If using external postgresql
DB_DATABASE_NAME: DB_DATABASE_NAME:
name: DB_DATABASE_NAME name: DB_DATABASE_NAME
description: >- description: If using external postgresql
If using external postgresql
UPLOAD_LOCATION: UPLOAD_LOCATION:
name: UPLOAD_LOCATION name: UPLOAD_LOCATION
description: >- description: This is the location where uploaded files are stored
This is the location where uploaded files are stored
JWT_SECRET: JWT_SECRET:
name: JWT_SECRET name: JWT_SECRET
description: >- description: Used to sign the authentication keys for user login
Used to sign the authentication keys for user login
run_duration: run_duration:
name: run_duration name: run_duration
description: >- description: >-
12h #for how long should the addon run. Must be formatted as number + time unit (ex : 5s, or 2m, or 12h, or 5d...) 12h #for how long should the addon run. Must be formatted as number + time
unit (ex : 5s, or 2m, or 12h, or 5d...)
silent: silent:
name: silent name: silent
description: >- description: "true #suppresses debug messages"
true #suppresses debug messages
ssl: ssl:
name: ssl name: ssl
description: >- description: "true/false : enables ssl. Need certfile and keyfile filled"
true/false : enables ssl. Need certfile and keyfile filled
certfile: certfile:
name: certfile name: certfile
description: >- description: "fullchain.pem #ssl certificate, must be located in /ssl"
fullchain.pem #ssl certificate, must be located in /ssl
keyfile: keyfile:
name: keyfile name: keyfile
description: >- description: "privkey.pem #sslkeyfile, must be located in /ssl"
privkey.pem #sslkeyfile, must be located in /ssl
whitelist: whitelist:
name: whitelist name: whitelist
description: >- description: '"localhost,192.168.0.0/16" # list ip subnets that won''t need a password'
"localhost,192.168.0.0/16" # list ip subnets that won't need a password
customUI: customUI:
name: customUI name: customUI
description: >- description: >-
selection from list # alternative webUI can be set here. Latest version set at each addon start selection from list # alternative webUI can be set here. Latest version
set at each addon start
DNS_servers: DNS_servers:
name: DNS_servers name: DNS_servers
description: >- description: >-
8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to avoid spamming in case of local DNS ad-remover 8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to
avoid spamming in case of local DNS ad-remover
openvpn_alt_mode: openvpn_alt_mode:
name: openvpn_alt_mode name: openvpn_alt_mode
description: >- description: bind at container level and not app level
bind at container level and not app level
openvpn_config: openvpn_config:
name: openvpn_config name: openvpn_config
description: >- description: 'for example "config.ovpn" # name of the file located in /config/openvpn'
for example "config.ovpn" # name of the file located in /config/openvpn

View File

@@ -3,108 +3,95 @@ configuration:
PGID: PGID:
name: PGID name: PGID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
PUID: PUID:
name: PUID name: PUID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
TZ: TZ:
name: TZ name: TZ
description: >- description: >-
The timezone, as described in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones The timezone, as described in
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
cifspassword: cifspassword:
name: cifspassword name: cifspassword
description: >- description: "Your password to access your SMB share, same for all smb shares"
Your password to access your SMB share, same for all smb shares
cifsusername: cifsusername:
name: cifsusername name: cifsusername
description: >- description: "Your username to access your SMB share, same for all smb shares"
Your username to access your SMB share, same for all smb shares
cifsdomain: cifsdomain:
name: cifsdomain name: cifsdomain
description: >- description: Allow setting the domain for the smb share
Allow setting the domain for the smb share
database: database:
name: database name: database
description: >- description: Type of database to use
Type of database to use
data_location: data_location:
name: data_location name: data_location
description: >- description: Where do you want your data stored
Where do you want your data stored
localdisks: localdisks:
name: localdisks name: localdisks
description: >- description: >-
Physical name of the partition (ex. sda1) or the share (ex. SharedFiles) to mount separated by commas (ex: sda1,sdb1,MYNAS) Physical name of the partition (ex. sda1) or the share (ex. SharedFiles)
to mount separated by commas (ex: sda1,sdb1,MYNAS)
networkdisks: networkdisks:
name: networkdisks name: networkdisks
description: >- description: "list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)"
list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)
DB_HOSTNAME: DB_HOSTNAME:
name: DB_HOSTNAME name: DB_HOSTNAME
description: >- description: If using external postgresql
If using external postgresql
DB_USERNAME: DB_USERNAME:
name: DB_USERNAME name: DB_USERNAME
description: >- description: If using external postgresql
If using external postgresql
DB_PORT: DB_PORT:
name: DB_PORT name: DB_PORT
description: >- description: If using external postgresql
If using external postgresql
DB_PASSWORD: DB_PASSWORD:
name: DB_PASSWORD name: DB_PASSWORD
description: >- description: If using external postgresql
If using external postgresql
DB_DATABASE_NAME: DB_DATABASE_NAME:
name: DB_DATABASE_NAME name: DB_DATABASE_NAME
description: >- description: If using external postgresql
If using external postgresql
UPLOAD_LOCATION: UPLOAD_LOCATION:
name: UPLOAD_LOCATION name: UPLOAD_LOCATION
description: >- description: This is the location where uploaded files are stored
This is the location where uploaded files are stored
JWT_SECRET: JWT_SECRET:
name: JWT_SECRET name: JWT_SECRET
description: >- description: Used to sign the authentication keys for user login
Used to sign the authentication keys for user login
run_duration: run_duration:
name: run_duration name: run_duration
description: >- description: >-
12h #for how long should the addon run. Must be formatted as number + time unit (ex : 5s, or 2m, or 12h, or 5d...) 12h #for how long should the addon run. Must be formatted as number + time
unit (ex : 5s, or 2m, or 12h, or 5d...)
silent: silent:
name: silent name: silent
description: >- description: "true #suppresses debug messages"
true #suppresses debug messages
ssl: ssl:
name: ssl name: ssl
description: >- description: "true/false : enables ssl. Need certfile and keyfile filled"
true/false : enables ssl. Need certfile and keyfile filled
certfile: certfile:
name: certfile name: certfile
description: >- description: "fullchain.pem #ssl certificate, must be located in /ssl"
fullchain.pem #ssl certificate, must be located in /ssl
keyfile: keyfile:
name: keyfile name: keyfile
description: >- description: "privkey.pem #sslkeyfile, must be located in /ssl"
privkey.pem #sslkeyfile, must be located in /ssl
whitelist: whitelist:
name: whitelist name: whitelist
description: >- description: '"localhost,192.168.0.0/16" # list ip subnets that won''t need a password'
"localhost,192.168.0.0/16" # list ip subnets that won't need a password
customUI: customUI:
name: customUI name: customUI
description: >- description: >-
selection from list # alternative webUI can be set here. Latest version set at each addon start selection from list # alternative webUI can be set here. Latest version
set at each addon start
DNS_servers: DNS_servers:
name: DNS_servers name: DNS_servers
description: >- description: >-
8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to avoid spamming in case of local DNS ad-remover 8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to
avoid spamming in case of local DNS ad-remover
openvpn_alt_mode: openvpn_alt_mode:
name: openvpn_alt_mode name: openvpn_alt_mode
description: >- description: bind at container level and not app level
bind at container level and not app level
openvpn_config: openvpn_config:
name: openvpn_config name: openvpn_config
description: >- description: 'for example "config.ovpn" # name of the file located in /config/openvpn'
for example "config.ovpn" # name of the file located in /config/openvpn

View File

@@ -3,108 +3,95 @@ configuration:
PGID: PGID:
name: PGID name: PGID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
PUID: PUID:
name: PUID name: PUID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
TZ: TZ:
name: TZ name: TZ
description: >- description: >-
The timezone, as described in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones The timezone, as described in
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
cifspassword: cifspassword:
name: cifspassword name: cifspassword
description: >- description: "Your password to access your SMB share, same for all smb shares"
Your password to access your SMB share, same for all smb shares
cifsusername: cifsusername:
name: cifsusername name: cifsusername
description: >- description: "Your username to access your SMB share, same for all smb shares"
Your username to access your SMB share, same for all smb shares
cifsdomain: cifsdomain:
name: cifsdomain name: cifsdomain
description: >- description: Allow setting the domain for the smb share
Allow setting the domain for the smb share
database: database:
name: database name: database
description: >- description: Type of database to use
Type of database to use
data_location: data_location:
name: data_location name: data_location
description: >- description: Where do you want your data stored
Where do you want your data stored
localdisks: localdisks:
name: localdisks name: localdisks
description: >- description: >-
Physical name of the partition (ex. sda1) or the share (ex. SharedFiles) to mount separated by commas (ex: sda1,sdb1,MYNAS) Physical name of the partition (ex. sda1) or the share (ex. SharedFiles)
to mount separated by commas (ex: sda1,sdb1,MYNAS)
networkdisks: networkdisks:
name: networkdisks name: networkdisks
description: >- description: "list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)"
list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)
DB_HOSTNAME: DB_HOSTNAME:
name: DB_HOSTNAME name: DB_HOSTNAME
description: >- description: If using external postgresql
If using external postgresql
DB_USERNAME: DB_USERNAME:
name: DB_USERNAME name: DB_USERNAME
description: >- description: If using external postgresql
If using external postgresql
DB_PORT: DB_PORT:
name: DB_PORT name: DB_PORT
description: >- description: If using external postgresql
If using external postgresql
DB_PASSWORD: DB_PASSWORD:
name: DB_PASSWORD name: DB_PASSWORD
description: >- description: If using external postgresql
If using external postgresql
DB_DATABASE_NAME: DB_DATABASE_NAME:
name: DB_DATABASE_NAME name: DB_DATABASE_NAME
description: >- description: If using external postgresql
If using external postgresql
UPLOAD_LOCATION: UPLOAD_LOCATION:
name: UPLOAD_LOCATION name: UPLOAD_LOCATION
description: >- description: This is the location where uploaded files are stored
This is the location where uploaded files are stored
JWT_SECRET: JWT_SECRET:
name: JWT_SECRET name: JWT_SECRET
description: >- description: Used to sign the authentication keys for user login
Used to sign the authentication keys for user login
run_duration: run_duration:
name: run_duration name: run_duration
description: >- description: >-
12h #for how long should the addon run. Must be formatted as number + time unit (ex : 5s, or 2m, or 12h, or 5d...) 12h #for how long should the addon run. Must be formatted as number + time
unit (ex : 5s, or 2m, or 12h, or 5d...)
silent: silent:
name: silent name: silent
description: >- description: "true #suppresses debug messages"
true #suppresses debug messages
ssl: ssl:
name: ssl name: ssl
description: >- description: "true/false : enables ssl. Need certfile and keyfile filled"
true/false : enables ssl. Need certfile and keyfile filled
certfile: certfile:
name: certfile name: certfile
description: >- description: "fullchain.pem #ssl certificate, must be located in /ssl"
fullchain.pem #ssl certificate, must be located in /ssl
keyfile: keyfile:
name: keyfile name: keyfile
description: >- description: "privkey.pem #sslkeyfile, must be located in /ssl"
privkey.pem #sslkeyfile, must be located in /ssl
whitelist: whitelist:
name: whitelist name: whitelist
description: >- description: '"localhost,192.168.0.0/16" # list ip subnets that won''t need a password'
"localhost,192.168.0.0/16" # list ip subnets that won't need a password
customUI: customUI:
name: customUI name: customUI
description: >- description: >-
selection from list # alternative webUI can be set here. Latest version set at each addon start selection from list # alternative webUI can be set here. Latest version
set at each addon start
DNS_servers: DNS_servers:
name: DNS_servers name: DNS_servers
description: >- description: >-
8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to avoid spamming in case of local DNS ad-remover 8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to
avoid spamming in case of local DNS ad-remover
openvpn_alt_mode: openvpn_alt_mode:
name: openvpn_alt_mode name: openvpn_alt_mode
description: >- description: bind at container level and not app level
bind at container level and not app level
openvpn_config: openvpn_config:
name: openvpn_config name: openvpn_config
description: >- description: 'for example "config.ovpn" # name of the file located in /config/openvpn'
for example "config.ovpn" # name of the file located in /config/openvpn

View File

@@ -3,108 +3,95 @@ configuration:
PGID: PGID:
name: PGID name: PGID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
PUID: PUID:
name: PUID name: PUID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
TZ: TZ:
name: TZ name: TZ
description: >- description: >-
The timezone, as described in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones The timezone, as described in
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
cifspassword: cifspassword:
name: cifspassword name: cifspassword
description: >- description: "Your password to access your SMB share, same for all smb shares"
Your password to access your SMB share, same for all smb shares
cifsusername: cifsusername:
name: cifsusername name: cifsusername
description: >- description: "Your username to access your SMB share, same for all smb shares"
Your username to access your SMB share, same for all smb shares
cifsdomain: cifsdomain:
name: cifsdomain name: cifsdomain
description: >- description: Allow setting the domain for the smb share
Allow setting the domain for the smb share
database: database:
name: database name: database
description: >- description: Type of database to use
Type of database to use
data_location: data_location:
name: data_location name: data_location
description: >- description: Where do you want your data stored
Where do you want your data stored
localdisks: localdisks:
name: localdisks name: localdisks
description: >- description: >-
Physical name of the partition (ex. sda1) or the share (ex. SharedFiles) to mount separated by commas (ex: sda1,sdb1,MYNAS) Physical name of the partition (ex. sda1) or the share (ex. SharedFiles)
to mount separated by commas (ex: sda1,sdb1,MYNAS)
networkdisks: networkdisks:
name: networkdisks name: networkdisks
description: >- description: "list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)"
list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)
DB_HOSTNAME: DB_HOSTNAME:
name: DB_HOSTNAME name: DB_HOSTNAME
description: >- description: If using external postgresql
If using external postgresql
DB_USERNAME: DB_USERNAME:
name: DB_USERNAME name: DB_USERNAME
description: >- description: If using external postgresql
If using external postgresql
DB_PORT: DB_PORT:
name: DB_PORT name: DB_PORT
description: >- description: If using external postgresql
If using external postgresql
DB_PASSWORD: DB_PASSWORD:
name: DB_PASSWORD name: DB_PASSWORD
description: >- description: If using external postgresql
If using external postgresql
DB_DATABASE_NAME: DB_DATABASE_NAME:
name: DB_DATABASE_NAME name: DB_DATABASE_NAME
description: >- description: If using external postgresql
If using external postgresql
UPLOAD_LOCATION: UPLOAD_LOCATION:
name: UPLOAD_LOCATION name: UPLOAD_LOCATION
description: >- description: This is the location where uploaded files are stored
This is the location where uploaded files are stored
JWT_SECRET: JWT_SECRET:
name: JWT_SECRET name: JWT_SECRET
description: >- description: Used to sign the authentication keys for user login
Used to sign the authentication keys for user login
run_duration: run_duration:
name: run_duration name: run_duration
description: >- description: >-
12h #for how long should the addon run. Must be formatted as number + time unit (ex : 5s, or 2m, or 12h, or 5d...) 12h #for how long should the addon run. Must be formatted as number + time
unit (ex : 5s, or 2m, or 12h, or 5d...)
silent: silent:
name: silent name: silent
description: >- description: "true #suppresses debug messages"
true #suppresses debug messages
ssl: ssl:
name: ssl name: ssl
description: >- description: "true/false : enables ssl. Need certfile and keyfile filled"
true/false : enables ssl. Need certfile and keyfile filled
certfile: certfile:
name: certfile name: certfile
description: >- description: "fullchain.pem #ssl certificate, must be located in /ssl"
fullchain.pem #ssl certificate, must be located in /ssl
keyfile: keyfile:
name: keyfile name: keyfile
description: >- description: "privkey.pem #sslkeyfile, must be located in /ssl"
privkey.pem #sslkeyfile, must be located in /ssl
whitelist: whitelist:
name: whitelist name: whitelist
description: >- description: '"localhost,192.168.0.0/16" # list ip subnets that won''t need a password'
"localhost,192.168.0.0/16" # list ip subnets that won't need a password
customUI: customUI:
name: customUI name: customUI
description: >- description: >-
selection from list # alternative webUI can be set here. Latest version set at each addon start selection from list # alternative webUI can be set here. Latest version
set at each addon start
DNS_servers: DNS_servers:
name: DNS_servers name: DNS_servers
description: >- description: >-
8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to avoid spamming in case of local DNS ad-remover 8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to
avoid spamming in case of local DNS ad-remover
openvpn_alt_mode: openvpn_alt_mode:
name: openvpn_alt_mode name: openvpn_alt_mode
description: >- description: bind at container level and not app level
bind at container level and not app level
openvpn_config: openvpn_config:
name: openvpn_config name: openvpn_config
description: >- description: 'for example "config.ovpn" # name of the file located in /config/openvpn'
for example "config.ovpn" # name of the file located in /config/openvpn

View File

@@ -3,108 +3,95 @@ configuration:
PGID: PGID:
name: PGID name: PGID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
PUID: PUID:
name: PUID name: PUID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
TZ: TZ:
name: TZ name: TZ
description: >- description: >-
The timezone, as described in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones The timezone, as described in
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
cifspassword: cifspassword:
name: cifspassword name: cifspassword
description: >- description: "Your password to access your SMB share, same for all smb shares"
Your password to access your SMB share, same for all smb shares
cifsusername: cifsusername:
name: cifsusername name: cifsusername
description: >- description: "Your username to access your SMB share, same for all smb shares"
Your username to access your SMB share, same for all smb shares
cifsdomain: cifsdomain:
name: cifsdomain name: cifsdomain
description: >- description: Allow setting the domain for the smb share
Allow setting the domain for the smb share
database: database:
name: database name: database
description: >- description: Type of database to use
Type of database to use
data_location: data_location:
name: data_location name: data_location
description: >- description: Where do you want your data stored
Where do you want your data stored
localdisks: localdisks:
name: localdisks name: localdisks
description: >- description: >-
Physical name of the partition (ex. sda1) or the share (ex. SharedFiles) to mount separated by commas (ex: sda1,sdb1,MYNAS) Physical name of the partition (ex. sda1) or the share (ex. SharedFiles)
to mount separated by commas (ex: sda1,sdb1,MYNAS)
networkdisks: networkdisks:
name: networkdisks name: networkdisks
description: >- description: "list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)"
list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)
DB_HOSTNAME: DB_HOSTNAME:
name: DB_HOSTNAME name: DB_HOSTNAME
description: >- description: If using external postgresql
If using external postgresql
DB_USERNAME: DB_USERNAME:
name: DB_USERNAME name: DB_USERNAME
description: >- description: If using external postgresql
If using external postgresql
DB_PORT: DB_PORT:
name: DB_PORT name: DB_PORT
description: >- description: If using external postgresql
If using external postgresql
DB_PASSWORD: DB_PASSWORD:
name: DB_PASSWORD name: DB_PASSWORD
description: >- description: If using external postgresql
If using external postgresql
DB_DATABASE_NAME: DB_DATABASE_NAME:
name: DB_DATABASE_NAME name: DB_DATABASE_NAME
description: >- description: If using external postgresql
If using external postgresql
UPLOAD_LOCATION: UPLOAD_LOCATION:
name: UPLOAD_LOCATION name: UPLOAD_LOCATION
description: >- description: This is the location where uploaded files are stored
This is the location where uploaded files are stored
JWT_SECRET: JWT_SECRET:
name: JWT_SECRET name: JWT_SECRET
description: >- description: Used to sign the authentication keys for user login
Used to sign the authentication keys for user login
run_duration: run_duration:
name: run_duration name: run_duration
description: >- description: >-
12h #for how long should the addon run. Must be formatted as number + time unit (ex : 5s, or 2m, or 12h, or 5d...) 12h #for how long should the addon run. Must be formatted as number + time
unit (ex : 5s, or 2m, or 12h, or 5d...)
silent: silent:
name: silent name: silent
description: >- description: "true #suppresses debug messages"
true #suppresses debug messages
ssl: ssl:
name: ssl name: ssl
description: >- description: "true/false : enables ssl. Need certfile and keyfile filled"
true/false : enables ssl. Need certfile and keyfile filled
certfile: certfile:
name: certfile name: certfile
description: >- description: "fullchain.pem #ssl certificate, must be located in /ssl"
fullchain.pem #ssl certificate, must be located in /ssl
keyfile: keyfile:
name: keyfile name: keyfile
description: >- description: "privkey.pem #sslkeyfile, must be located in /ssl"
privkey.pem #sslkeyfile, must be located in /ssl
whitelist: whitelist:
name: whitelist name: whitelist
description: >- description: '"localhost,192.168.0.0/16" # list ip subnets that won''t need a password'
"localhost,192.168.0.0/16" # list ip subnets that won't need a password
customUI: customUI:
name: customUI name: customUI
description: >- description: >-
selection from list # alternative webUI can be set here. Latest version set at each addon start selection from list # alternative webUI can be set here. Latest version
set at each addon start
DNS_servers: DNS_servers:
name: DNS_servers name: DNS_servers
description: >- description: >-
8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to avoid spamming in case of local DNS ad-remover 8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to
avoid spamming in case of local DNS ad-remover
openvpn_alt_mode: openvpn_alt_mode:
name: openvpn_alt_mode name: openvpn_alt_mode
description: >- description: bind at container level and not app level
bind at container level and not app level
openvpn_config: openvpn_config:
name: openvpn_config name: openvpn_config
description: >- description: 'for example "config.ovpn" # name of the file located in /config/openvpn'
for example "config.ovpn" # name of the file located in /config/openvpn

View File

@@ -3,108 +3,95 @@ configuration:
PGID: PGID:
name: PGID name: PGID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
PUID: PUID:
name: PUID name: PUID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
TZ: TZ:
name: TZ name: TZ
description: >- description: >-
The timezone, as described in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones The timezone, as described in
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
cifspassword: cifspassword:
name: cifspassword name: cifspassword
description: >- description: "Your password to access your SMB share, same for all smb shares"
Your password to access your SMB share, same for all smb shares
cifsusername: cifsusername:
name: cifsusername name: cifsusername
description: >- description: "Your username to access your SMB share, same for all smb shares"
Your username to access your SMB share, same for all smb shares
cifsdomain: cifsdomain:
name: cifsdomain name: cifsdomain
description: >- description: Allow setting the domain for the smb share
Allow setting the domain for the smb share
database: database:
name: database name: database
description: >- description: Type of database to use
Type of database to use
data_location: data_location:
name: data_location name: data_location
description: >- description: Where do you want your data stored
Where do you want your data stored
localdisks: localdisks:
name: localdisks name: localdisks
description: >- description: >-
Physical name of the partition (ex. sda1) or the share (ex. SharedFiles) to mount separated by commas (ex: sda1,sdb1,MYNAS) Physical name of the partition (ex. sda1) or the share (ex. SharedFiles)
to mount separated by commas (ex: sda1,sdb1,MYNAS)
networkdisks: networkdisks:
name: networkdisks name: networkdisks
description: >- description: "list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)"
list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)
DB_HOSTNAME: DB_HOSTNAME:
name: DB_HOSTNAME name: DB_HOSTNAME
description: >- description: If using external postgresql
If using external postgresql
DB_USERNAME: DB_USERNAME:
name: DB_USERNAME name: DB_USERNAME
description: >- description: If using external postgresql
If using external postgresql
DB_PORT: DB_PORT:
name: DB_PORT name: DB_PORT
description: >- description: If using external postgresql
If using external postgresql
DB_PASSWORD: DB_PASSWORD:
name: DB_PASSWORD name: DB_PASSWORD
description: >- description: If using external postgresql
If using external postgresql
DB_DATABASE_NAME: DB_DATABASE_NAME:
name: DB_DATABASE_NAME name: DB_DATABASE_NAME
description: >- description: If using external postgresql
If using external postgresql
UPLOAD_LOCATION: UPLOAD_LOCATION:
name: UPLOAD_LOCATION name: UPLOAD_LOCATION
description: >- description: This is the location where uploaded files are stored
This is the location where uploaded files are stored
JWT_SECRET: JWT_SECRET:
name: JWT_SECRET name: JWT_SECRET
description: >- description: Used to sign the authentication keys for user login
Used to sign the authentication keys for user login
run_duration: run_duration:
name: run_duration name: run_duration
description: >- description: >-
12h #for how long should the addon run. Must be formatted as number + time unit (ex : 5s, or 2m, or 12h, or 5d...) 12h #for how long should the addon run. Must be formatted as number + time
unit (ex : 5s, or 2m, or 12h, or 5d...)
silent: silent:
name: silent name: silent
description: >- description: "true #suppresses debug messages"
true #suppresses debug messages
ssl: ssl:
name: ssl name: ssl
description: >- description: "true/false : enables ssl. Need certfile and keyfile filled"
true/false : enables ssl. Need certfile and keyfile filled
certfile: certfile:
name: certfile name: certfile
description: >- description: "fullchain.pem #ssl certificate, must be located in /ssl"
fullchain.pem #ssl certificate, must be located in /ssl
keyfile: keyfile:
name: keyfile name: keyfile
description: >- description: "privkey.pem #sslkeyfile, must be located in /ssl"
privkey.pem #sslkeyfile, must be located in /ssl
whitelist: whitelist:
name: whitelist name: whitelist
description: >- description: '"localhost,192.168.0.0/16" # list ip subnets that won''t need a password'
"localhost,192.168.0.0/16" # list ip subnets that won't need a password
customUI: customUI:
name: customUI name: customUI
description: >- description: >-
selection from list # alternative webUI can be set here. Latest version set at each addon start selection from list # alternative webUI can be set here. Latest version
set at each addon start
DNS_servers: DNS_servers:
name: DNS_servers name: DNS_servers
description: >- description: >-
8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to avoid spamming in case of local DNS ad-remover 8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to
avoid spamming in case of local DNS ad-remover
openvpn_alt_mode: openvpn_alt_mode:
name: openvpn_alt_mode name: openvpn_alt_mode
description: >- description: bind at container level and not app level
bind at container level and not app level
openvpn_config: openvpn_config:
name: openvpn_config name: openvpn_config
description: >- description: 'for example "config.ovpn" # name of the file located in /config/openvpn'
for example "config.ovpn" # name of the file located in /config/openvpn

View File

@@ -3,108 +3,95 @@ configuration:
PGID: PGID:
name: PGID name: PGID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
PUID: PUID:
name: PUID name: PUID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
TZ: TZ:
name: TZ name: TZ
description: >- description: >-
The timezone, as described in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones The timezone, as described in
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
cifspassword: cifspassword:
name: cifspassword name: cifspassword
description: >- description: "Your password to access your SMB share, same for all smb shares"
Your password to access your SMB share, same for all smb shares
cifsusername: cifsusername:
name: cifsusername name: cifsusername
description: >- description: "Your username to access your SMB share, same for all smb shares"
Your username to access your SMB share, same for all smb shares
cifsdomain: cifsdomain:
name: cifsdomain name: cifsdomain
description: >- description: Allow setting the domain for the smb share
Allow setting the domain for the smb share
database: database:
name: database name: database
description: >- description: Type of database to use
Type of database to use
data_location: data_location:
name: data_location name: data_location
description: >- description: Where do you want your data stored
Where do you want your data stored
localdisks: localdisks:
name: localdisks name: localdisks
description: >- description: >-
Physical name of the partition (ex. sda1) or the share (ex. SharedFiles) to mount separated by commas (ex: sda1,sdb1,MYNAS) Physical name of the partition (ex. sda1) or the share (ex. SharedFiles)
to mount separated by commas (ex: sda1,sdb1,MYNAS)
networkdisks: networkdisks:
name: networkdisks name: networkdisks
description: >- description: "list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)"
list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)
DB_HOSTNAME: DB_HOSTNAME:
name: DB_HOSTNAME name: DB_HOSTNAME
description: >- description: If using external postgresql
If using external postgresql
DB_USERNAME: DB_USERNAME:
name: DB_USERNAME name: DB_USERNAME
description: >- description: If using external postgresql
If using external postgresql
DB_PORT: DB_PORT:
name: DB_PORT name: DB_PORT
description: >- description: If using external postgresql
If using external postgresql
DB_PASSWORD: DB_PASSWORD:
name: DB_PASSWORD name: DB_PASSWORD
description: >- description: If using external postgresql
If using external postgresql
DB_DATABASE_NAME: DB_DATABASE_NAME:
name: DB_DATABASE_NAME name: DB_DATABASE_NAME
description: >- description: If using external postgresql
If using external postgresql
UPLOAD_LOCATION: UPLOAD_LOCATION:
name: UPLOAD_LOCATION name: UPLOAD_LOCATION
description: >- description: This is the location where uploaded files are stored
This is the location where uploaded files are stored
JWT_SECRET: JWT_SECRET:
name: JWT_SECRET name: JWT_SECRET
description: >- description: Used to sign the authentication keys for user login
Used to sign the authentication keys for user login
run_duration: run_duration:
name: run_duration name: run_duration
description: >- description: >-
12h #for how long should the addon run. Must be formatted as number + time unit (ex : 5s, or 2m, or 12h, or 5d...) 12h #for how long should the addon run. Must be formatted as number + time
unit (ex : 5s, or 2m, or 12h, or 5d...)
silent: silent:
name: silent name: silent
description: >- description: "true #suppresses debug messages"
true #suppresses debug messages
ssl: ssl:
name: ssl name: ssl
description: >- description: "true/false : enables ssl. Need certfile and keyfile filled"
true/false : enables ssl. Need certfile and keyfile filled
certfile: certfile:
name: certfile name: certfile
description: >- description: "fullchain.pem #ssl certificate, must be located in /ssl"
fullchain.pem #ssl certificate, must be located in /ssl
keyfile: keyfile:
name: keyfile name: keyfile
description: >- description: "privkey.pem #sslkeyfile, must be located in /ssl"
privkey.pem #sslkeyfile, must be located in /ssl
whitelist: whitelist:
name: whitelist name: whitelist
description: >- description: '"localhost,192.168.0.0/16" # list ip subnets that won''t need a password'
"localhost,192.168.0.0/16" # list ip subnets that won't need a password
customUI: customUI:
name: customUI name: customUI
description: >- description: >-
selection from list # alternative webUI can be set here. Latest version set at each addon start selection from list # alternative webUI can be set here. Latest version
set at each addon start
DNS_servers: DNS_servers:
name: DNS_servers name: DNS_servers
description: >- description: >-
8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to avoid spamming in case of local DNS ad-remover 8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to
avoid spamming in case of local DNS ad-remover
openvpn_alt_mode: openvpn_alt_mode:
name: openvpn_alt_mode name: openvpn_alt_mode
description: >- description: bind at container level and not app level
bind at container level and not app level
openvpn_config: openvpn_config:
name: openvpn_config name: openvpn_config
description: >- description: 'for example "config.ovpn" # name of the file located in /config/openvpn'
for example "config.ovpn" # name of the file located in /config/openvpn

View File

@@ -3,108 +3,95 @@ configuration:
PGID: PGID:
name: PGID name: PGID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
PUID: PUID:
name: PUID name: PUID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
TZ: TZ:
name: TZ name: TZ
description: >- description: >-
The timezone, as described in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones The timezone, as described in
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
cifspassword: cifspassword:
name: cifspassword name: cifspassword
description: >- description: "Your password to access your SMB share, same for all smb shares"
Your password to access your SMB share, same for all smb shares
cifsusername: cifsusername:
name: cifsusername name: cifsusername
description: >- description: "Your username to access your SMB share, same for all smb shares"
Your username to access your SMB share, same for all smb shares
cifsdomain: cifsdomain:
name: cifsdomain name: cifsdomain
description: >- description: Allow setting the domain for the smb share
Allow setting the domain for the smb share
database: database:
name: database name: database
description: >- description: Type of database to use
Type of database to use
data_location: data_location:
name: data_location name: data_location
description: >- description: Where do you want your data stored
Where do you want your data stored
localdisks: localdisks:
name: localdisks name: localdisks
description: >- description: >-
Physical name of the partition (ex. sda1) or the share (ex. SharedFiles) to mount separated by commas (ex: sda1,sdb1,MYNAS) Physical name of the partition (ex. sda1) or the share (ex. SharedFiles)
to mount separated by commas (ex: sda1,sdb1,MYNAS)
networkdisks: networkdisks:
name: networkdisks name: networkdisks
description: >- description: "list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)"
list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)
DB_HOSTNAME: DB_HOSTNAME:
name: DB_HOSTNAME name: DB_HOSTNAME
description: >- description: If using external postgresql
If using external postgresql
DB_USERNAME: DB_USERNAME:
name: DB_USERNAME name: DB_USERNAME
description: >- description: If using external postgresql
If using external postgresql
DB_PORT: DB_PORT:
name: DB_PORT name: DB_PORT
description: >- description: If using external postgresql
If using external postgresql
DB_PASSWORD: DB_PASSWORD:
name: DB_PASSWORD name: DB_PASSWORD
description: >- description: If using external postgresql
If using external postgresql
DB_DATABASE_NAME: DB_DATABASE_NAME:
name: DB_DATABASE_NAME name: DB_DATABASE_NAME
description: >- description: If using external postgresql
If using external postgresql
UPLOAD_LOCATION: UPLOAD_LOCATION:
name: UPLOAD_LOCATION name: UPLOAD_LOCATION
description: >- description: This is the location where uploaded files are stored
This is the location where uploaded files are stored
JWT_SECRET: JWT_SECRET:
name: JWT_SECRET name: JWT_SECRET
description: >- description: Used to sign the authentication keys for user login
Used to sign the authentication keys for user login
run_duration: run_duration:
name: run_duration name: run_duration
description: >- description: >-
12h #for how long should the addon run. Must be formatted as number + time unit (ex : 5s, or 2m, or 12h, or 5d...) 12h #for how long should the addon run. Must be formatted as number + time
unit (ex : 5s, or 2m, or 12h, or 5d...)
silent: silent:
name: silent name: silent
description: >- description: "true #suppresses debug messages"
true #suppresses debug messages
ssl: ssl:
name: ssl name: ssl
description: >- description: "true/false : enables ssl. Need certfile and keyfile filled"
true/false : enables ssl. Need certfile and keyfile filled
certfile: certfile:
name: certfile name: certfile
description: >- description: "fullchain.pem #ssl certificate, must be located in /ssl"
fullchain.pem #ssl certificate, must be located in /ssl
keyfile: keyfile:
name: keyfile name: keyfile
description: >- description: "privkey.pem #sslkeyfile, must be located in /ssl"
privkey.pem #sslkeyfile, must be located in /ssl
whitelist: whitelist:
name: whitelist name: whitelist
description: >- description: '"localhost,192.168.0.0/16" # list ip subnets that won''t need a password'
"localhost,192.168.0.0/16" # list ip subnets that won't need a password
customUI: customUI:
name: customUI name: customUI
description: >- description: >-
selection from list # alternative webUI can be set here. Latest version set at each addon start selection from list # alternative webUI can be set here. Latest version
set at each addon start
DNS_servers: DNS_servers:
name: DNS_servers name: DNS_servers
description: >- description: >-
8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to avoid spamming in case of local DNS ad-remover 8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to
avoid spamming in case of local DNS ad-remover
openvpn_alt_mode: openvpn_alt_mode:
name: openvpn_alt_mode name: openvpn_alt_mode
description: >- description: bind at container level and not app level
bind at container level and not app level
openvpn_config: openvpn_config:
name: openvpn_config name: openvpn_config
description: >- description: 'for example "config.ovpn" # name of the file located in /config/openvpn'
for example "config.ovpn" # name of the file located in /config/openvpn

View File

@@ -3,108 +3,95 @@ configuration:
PGID: PGID:
name: PGID name: PGID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
PUID: PUID:
name: PUID name: PUID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
TZ: TZ:
name: TZ name: TZ
description: >- description: >-
The timezone, as described in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones The timezone, as described in
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
cifspassword: cifspassword:
name: cifspassword name: cifspassword
description: >- description: "Your password to access your SMB share, same for all smb shares"
Your password to access your SMB share, same for all smb shares
cifsusername: cifsusername:
name: cifsusername name: cifsusername
description: >- description: "Your username to access your SMB share, same for all smb shares"
Your username to access your SMB share, same for all smb shares
cifsdomain: cifsdomain:
name: cifsdomain name: cifsdomain
description: >- description: Allow setting the domain for the smb share
Allow setting the domain for the smb share
database: database:
name: database name: database
description: >- description: Type of database to use
Type of database to use
data_location: data_location:
name: data_location name: data_location
description: >- description: Where do you want your data stored
Where do you want your data stored
localdisks: localdisks:
name: localdisks name: localdisks
description: >- description: >-
Physical name of the partition (ex. sda1) or the share (ex. SharedFiles) to mount separated by commas (ex: sda1,sdb1,MYNAS) Physical name of the partition (ex. sda1) or the share (ex. SharedFiles)
to mount separated by commas (ex: sda1,sdb1,MYNAS)
networkdisks: networkdisks:
name: networkdisks name: networkdisks
description: >- description: "list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)"
list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)
DB_HOSTNAME: DB_HOSTNAME:
name: DB_HOSTNAME name: DB_HOSTNAME
description: >- description: If using external postgresql
If using external postgresql
DB_USERNAME: DB_USERNAME:
name: DB_USERNAME name: DB_USERNAME
description: >- description: If using external postgresql
If using external postgresql
DB_PORT: DB_PORT:
name: DB_PORT name: DB_PORT
description: >- description: If using external postgresql
If using external postgresql
DB_PASSWORD: DB_PASSWORD:
name: DB_PASSWORD name: DB_PASSWORD
description: >- description: If using external postgresql
If using external postgresql
DB_DATABASE_NAME: DB_DATABASE_NAME:
name: DB_DATABASE_NAME name: DB_DATABASE_NAME
description: >- description: If using external postgresql
If using external postgresql
UPLOAD_LOCATION: UPLOAD_LOCATION:
name: UPLOAD_LOCATION name: UPLOAD_LOCATION
description: >- description: This is the location where uploaded files are stored
This is the location where uploaded files are stored
JWT_SECRET: JWT_SECRET:
name: JWT_SECRET name: JWT_SECRET
description: >- description: Used to sign the authentication keys for user login
Used to sign the authentication keys for user login
run_duration: run_duration:
name: run_duration name: run_duration
description: >- description: >-
12h #for how long should the addon run. Must be formatted as number + time unit (ex : 5s, or 2m, or 12h, or 5d...) 12h #for how long should the addon run. Must be formatted as number + time
unit (ex : 5s, or 2m, or 12h, or 5d...)
silent: silent:
name: silent name: silent
description: >- description: "true #suppresses debug messages"
true #suppresses debug messages
ssl: ssl:
name: ssl name: ssl
description: >- description: "true/false : enables ssl. Need certfile and keyfile filled"
true/false : enables ssl. Need certfile and keyfile filled
certfile: certfile:
name: certfile name: certfile
description: >- description: "fullchain.pem #ssl certificate, must be located in /ssl"
fullchain.pem #ssl certificate, must be located in /ssl
keyfile: keyfile:
name: keyfile name: keyfile
description: >- description: "privkey.pem #sslkeyfile, must be located in /ssl"
privkey.pem #sslkeyfile, must be located in /ssl
whitelist: whitelist:
name: whitelist name: whitelist
description: >- description: '"localhost,192.168.0.0/16" # list ip subnets that won''t need a password'
"localhost,192.168.0.0/16" # list ip subnets that won't need a password
customUI: customUI:
name: customUI name: customUI
description: >- description: >-
selection from list # alternative webUI can be set here. Latest version set at each addon start selection from list # alternative webUI can be set here. Latest version
set at each addon start
DNS_servers: DNS_servers:
name: DNS_servers name: DNS_servers
description: >- description: >-
8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to avoid spamming in case of local DNS ad-remover 8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to
avoid spamming in case of local DNS ad-remover
openvpn_alt_mode: openvpn_alt_mode:
name: openvpn_alt_mode name: openvpn_alt_mode
description: >- description: bind at container level and not app level
bind at container level and not app level
openvpn_config: openvpn_config:
name: openvpn_config name: openvpn_config
description: >- description: 'for example "config.ovpn" # name of the file located in /config/openvpn'
for example "config.ovpn" # name of the file located in /config/openvpn

View File

@@ -3,108 +3,95 @@ configuration:
PGID: PGID:
name: PGID name: PGID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
PUID: PUID:
name: PUID name: PUID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
TZ: TZ:
name: TZ name: TZ
description: >- description: >-
The timezone, as described in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones The timezone, as described in
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
cifspassword: cifspassword:
name: cifspassword name: cifspassword
description: >- description: "Your password to access your SMB share, same for all smb shares"
Your password to access your SMB share, same for all smb shares
cifsusername: cifsusername:
name: cifsusername name: cifsusername
description: >- description: "Your username to access your SMB share, same for all smb shares"
Your username to access your SMB share, same for all smb shares
cifsdomain: cifsdomain:
name: cifsdomain name: cifsdomain
description: >- description: Allow setting the domain for the smb share
Allow setting the domain for the smb share
database: database:
name: database name: database
description: >- description: Type of database to use
Type of database to use
data_location: data_location:
name: data_location name: data_location
description: >- description: Where do you want your data stored
Where do you want your data stored
localdisks: localdisks:
name: localdisks name: localdisks
description: >- description: >-
Physical name of the partition (ex. sda1) or the share (ex. SharedFiles) to mount separated by commas (ex: sda1,sdb1,MYNAS) Physical name of the partition (ex. sda1) or the share (ex. SharedFiles)
to mount separated by commas (ex: sda1,sdb1,MYNAS)
networkdisks: networkdisks:
name: networkdisks name: networkdisks
description: >- description: "list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)"
list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)
DB_HOSTNAME: DB_HOSTNAME:
name: DB_HOSTNAME name: DB_HOSTNAME
description: >- description: If using external postgresql
If using external postgresql
DB_USERNAME: DB_USERNAME:
name: DB_USERNAME name: DB_USERNAME
description: >- description: If using external postgresql
If using external postgresql
DB_PORT: DB_PORT:
name: DB_PORT name: DB_PORT
description: >- description: If using external postgresql
If using external postgresql
DB_PASSWORD: DB_PASSWORD:
name: DB_PASSWORD name: DB_PASSWORD
description: >- description: If using external postgresql
If using external postgresql
DB_DATABASE_NAME: DB_DATABASE_NAME:
name: DB_DATABASE_NAME name: DB_DATABASE_NAME
description: >- description: If using external postgresql
If using external postgresql
UPLOAD_LOCATION: UPLOAD_LOCATION:
name: UPLOAD_LOCATION name: UPLOAD_LOCATION
description: >- description: This is the location where uploaded files are stored
This is the location where uploaded files are stored
JWT_SECRET: JWT_SECRET:
name: JWT_SECRET name: JWT_SECRET
description: >- description: Used to sign the authentication keys for user login
Used to sign the authentication keys for user login
run_duration: run_duration:
name: run_duration name: run_duration
description: >- description: >-
12h #for how long should the addon run. Must be formatted as number + time unit (ex : 5s, or 2m, or 12h, or 5d...) 12h #for how long should the addon run. Must be formatted as number + time
unit (ex : 5s, or 2m, or 12h, or 5d...)
silent: silent:
name: silent name: silent
description: >- description: "true #suppresses debug messages"
true #suppresses debug messages
ssl: ssl:
name: ssl name: ssl
description: >- description: "true/false : enables ssl. Need certfile and keyfile filled"
true/false : enables ssl. Need certfile and keyfile filled
certfile: certfile:
name: certfile name: certfile
description: >- description: "fullchain.pem #ssl certificate, must be located in /ssl"
fullchain.pem #ssl certificate, must be located in /ssl
keyfile: keyfile:
name: keyfile name: keyfile
description: >- description: "privkey.pem #sslkeyfile, must be located in /ssl"
privkey.pem #sslkeyfile, must be located in /ssl
whitelist: whitelist:
name: whitelist name: whitelist
description: >- description: '"localhost,192.168.0.0/16" # list ip subnets that won''t need a password'
"localhost,192.168.0.0/16" # list ip subnets that won't need a password
customUI: customUI:
name: customUI name: customUI
description: >- description: >-
selection from list # alternative webUI can be set here. Latest version set at each addon start selection from list # alternative webUI can be set here. Latest version
set at each addon start
DNS_servers: DNS_servers:
name: DNS_servers name: DNS_servers
description: >- description: >-
8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to avoid spamming in case of local DNS ad-remover 8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to
avoid spamming in case of local DNS ad-remover
openvpn_alt_mode: openvpn_alt_mode:
name: openvpn_alt_mode name: openvpn_alt_mode
description: >- description: bind at container level and not app level
bind at container level and not app level
openvpn_config: openvpn_config:
name: openvpn_config name: openvpn_config
description: >- description: 'for example "config.ovpn" # name of the file located in /config/openvpn'
for example "config.ovpn" # name of the file located in /config/openvpn

View File

@@ -3,108 +3,95 @@ configuration:
PGID: PGID:
name: PGID name: PGID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
PUID: PUID:
name: PUID name: PUID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
TZ: TZ:
name: TZ name: TZ
description: >- description: >-
The timezone, as described in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones The timezone, as described in
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
cifspassword: cifspassword:
name: cifspassword name: cifspassword
description: >- description: "Your password to access your SMB share, same for all smb shares"
Your password to access your SMB share, same for all smb shares
cifsusername: cifsusername:
name: cifsusername name: cifsusername
description: >- description: "Your username to access your SMB share, same for all smb shares"
Your username to access your SMB share, same for all smb shares
cifsdomain: cifsdomain:
name: cifsdomain name: cifsdomain
description: >- description: Allow setting the domain for the smb share
Allow setting the domain for the smb share
database: database:
name: database name: database
description: >- description: Type of database to use
Type of database to use
data_location: data_location:
name: data_location name: data_location
description: >- description: Where do you want your data stored
Where do you want your data stored
localdisks: localdisks:
name: localdisks name: localdisks
description: >- description: >-
Physical name of the partition (ex. sda1) or the share (ex. SharedFiles) to mount separated by commas (ex: sda1,sdb1,MYNAS) Physical name of the partition (ex. sda1) or the share (ex. SharedFiles)
to mount separated by commas (ex: sda1,sdb1,MYNAS)
networkdisks: networkdisks:
name: networkdisks name: networkdisks
description: >- description: "list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)"
list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)
DB_HOSTNAME: DB_HOSTNAME:
name: DB_HOSTNAME name: DB_HOSTNAME
description: >- description: If using external postgresql
If using external postgresql
DB_USERNAME: DB_USERNAME:
name: DB_USERNAME name: DB_USERNAME
description: >- description: If using external postgresql
If using external postgresql
DB_PORT: DB_PORT:
name: DB_PORT name: DB_PORT
description: >- description: If using external postgresql
If using external postgresql
DB_PASSWORD: DB_PASSWORD:
name: DB_PASSWORD name: DB_PASSWORD
description: >- description: If using external postgresql
If using external postgresql
DB_DATABASE_NAME: DB_DATABASE_NAME:
name: DB_DATABASE_NAME name: DB_DATABASE_NAME
description: >- description: If using external postgresql
If using external postgresql
UPLOAD_LOCATION: UPLOAD_LOCATION:
name: UPLOAD_LOCATION name: UPLOAD_LOCATION
description: >- description: This is the location where uploaded files are stored
This is the location where uploaded files are stored
JWT_SECRET: JWT_SECRET:
name: JWT_SECRET name: JWT_SECRET
description: >- description: Used to sign the authentication keys for user login
Used to sign the authentication keys for user login
run_duration: run_duration:
name: run_duration name: run_duration
description: >- description: >-
12h #for how long should the addon run. Must be formatted as number + time unit (ex : 5s, or 2m, or 12h, or 5d...) 12h #for how long should the addon run. Must be formatted as number + time
unit (ex : 5s, or 2m, or 12h, or 5d...)
silent: silent:
name: silent name: silent
description: >- description: "true #suppresses debug messages"
true #suppresses debug messages
ssl: ssl:
name: ssl name: ssl
description: >- description: "true/false : enables ssl. Need certfile and keyfile filled"
true/false : enables ssl. Need certfile and keyfile filled
certfile: certfile:
name: certfile name: certfile
description: >- description: "fullchain.pem #ssl certificate, must be located in /ssl"
fullchain.pem #ssl certificate, must be located in /ssl
keyfile: keyfile:
name: keyfile name: keyfile
description: >- description: "privkey.pem #sslkeyfile, must be located in /ssl"
privkey.pem #sslkeyfile, must be located in /ssl
whitelist: whitelist:
name: whitelist name: whitelist
description: >- description: '"localhost,192.168.0.0/16" # list ip subnets that won''t need a password'
"localhost,192.168.0.0/16" # list ip subnets that won't need a password
customUI: customUI:
name: customUI name: customUI
description: >- description: >-
selection from list # alternative webUI can be set here. Latest version set at each addon start selection from list # alternative webUI can be set here. Latest version
set at each addon start
DNS_servers: DNS_servers:
name: DNS_servers name: DNS_servers
description: >- description: >-
8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to avoid spamming in case of local DNS ad-remover 8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to
avoid spamming in case of local DNS ad-remover
openvpn_alt_mode: openvpn_alt_mode:
name: openvpn_alt_mode name: openvpn_alt_mode
description: >- description: bind at container level and not app level
bind at container level and not app level
openvpn_config: openvpn_config:
name: openvpn_config name: openvpn_config
description: >- description: 'for example "config.ovpn" # name of the file located in /config/openvpn'
for example "config.ovpn" # name of the file located in /config/openvpn

View File

@@ -3,108 +3,95 @@ configuration:
PGID: PGID:
name: PGID name: PGID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
PUID: PUID:
name: PUID name: PUID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
TZ: TZ:
name: TZ name: TZ
description: >- description: >-
The timezone, as described in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones The timezone, as described in
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
cifspassword: cifspassword:
name: cifspassword name: cifspassword
description: >- description: "Your password to access your SMB share, same for all smb shares"
Your password to access your SMB share, same for all smb shares
cifsusername: cifsusername:
name: cifsusername name: cifsusername
description: >- description: "Your username to access your SMB share, same for all smb shares"
Your username to access your SMB share, same for all smb shares
cifsdomain: cifsdomain:
name: cifsdomain name: cifsdomain
description: >- description: Allow setting the domain for the smb share
Allow setting the domain for the smb share
database: database:
name: database name: database
description: >- description: Type of database to use
Type of database to use
data_location: data_location:
name: data_location name: data_location
description: >- description: Where do you want your data stored
Where do you want your data stored
localdisks: localdisks:
name: localdisks name: localdisks
description: >- description: >-
Physical name of the partition (ex. sda1) or the share (ex. SharedFiles) to mount separated by commas (ex: sda1,sdb1,MYNAS) Physical name of the partition (ex. sda1) or the share (ex. SharedFiles)
to mount separated by commas (ex: sda1,sdb1,MYNAS)
networkdisks: networkdisks:
name: networkdisks name: networkdisks
description: >- description: "list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)"
list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)
DB_HOSTNAME: DB_HOSTNAME:
name: DB_HOSTNAME name: DB_HOSTNAME
description: >- description: If using external postgresql
If using external postgresql
DB_USERNAME: DB_USERNAME:
name: DB_USERNAME name: DB_USERNAME
description: >- description: If using external postgresql
If using external postgresql
DB_PORT: DB_PORT:
name: DB_PORT name: DB_PORT
description: >- description: If using external postgresql
If using external postgresql
DB_PASSWORD: DB_PASSWORD:
name: DB_PASSWORD name: DB_PASSWORD
description: >- description: If using external postgresql
If using external postgresql
DB_DATABASE_NAME: DB_DATABASE_NAME:
name: DB_DATABASE_NAME name: DB_DATABASE_NAME
description: >- description: If using external postgresql
If using external postgresql
UPLOAD_LOCATION: UPLOAD_LOCATION:
name: UPLOAD_LOCATION name: UPLOAD_LOCATION
description: >- description: This is the location where uploaded files are stored
This is the location where uploaded files are stored
JWT_SECRET: JWT_SECRET:
name: JWT_SECRET name: JWT_SECRET
description: >- description: Used to sign the authentication keys for user login
Used to sign the authentication keys for user login
run_duration: run_duration:
name: run_duration name: run_duration
description: >- description: >-
12h #for how long should the addon run. Must be formatted as number + time unit (ex : 5s, or 2m, or 12h, or 5d...) 12h #for how long should the addon run. Must be formatted as number + time
unit (ex : 5s, or 2m, or 12h, or 5d...)
silent: silent:
name: silent name: silent
description: >- description: "true #suppresses debug messages"
true #suppresses debug messages
ssl: ssl:
name: ssl name: ssl
description: >- description: "true/false : enables ssl. Need certfile and keyfile filled"
true/false : enables ssl. Need certfile and keyfile filled
certfile: certfile:
name: certfile name: certfile
description: >- description: "fullchain.pem #ssl certificate, must be located in /ssl"
fullchain.pem #ssl certificate, must be located in /ssl
keyfile: keyfile:
name: keyfile name: keyfile
description: >- description: "privkey.pem #sslkeyfile, must be located in /ssl"
privkey.pem #sslkeyfile, must be located in /ssl
whitelist: whitelist:
name: whitelist name: whitelist
description: >- description: '"localhost,192.168.0.0/16" # list ip subnets that won''t need a password'
"localhost,192.168.0.0/16" # list ip subnets that won't need a password
customUI: customUI:
name: customUI name: customUI
description: >- description: >-
selection from list # alternative webUI can be set here. Latest version set at each addon start selection from list # alternative webUI can be set here. Latest version
set at each addon start
DNS_servers: DNS_servers:
name: DNS_servers name: DNS_servers
description: >- description: >-
8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to avoid spamming in case of local DNS ad-remover 8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to
avoid spamming in case of local DNS ad-remover
openvpn_alt_mode: openvpn_alt_mode:
name: openvpn_alt_mode name: openvpn_alt_mode
description: >- description: bind at container level and not app level
bind at container level and not app level
openvpn_config: openvpn_config:
name: openvpn_config name: openvpn_config
description: >- description: 'for example "config.ovpn" # name of the file located in /config/openvpn'
for example "config.ovpn" # name of the file located in /config/openvpn

View File

@@ -3,108 +3,95 @@ configuration:
PGID: PGID:
name: PGID name: PGID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
PUID: PUID:
name: PUID name: PUID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
TZ: TZ:
name: TZ name: TZ
description: >- description: >-
The timezone, as described in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones The timezone, as described in
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
cifspassword: cifspassword:
name: cifspassword name: cifspassword
description: >- description: "Your password to access your SMB share, same for all smb shares"
Your password to access your SMB share, same for all smb shares
cifsusername: cifsusername:
name: cifsusername name: cifsusername
description: >- description: "Your username to access your SMB share, same for all smb shares"
Your username to access your SMB share, same for all smb shares
cifsdomain: cifsdomain:
name: cifsdomain name: cifsdomain
description: >- description: Allow setting the domain for the smb share
Allow setting the domain for the smb share
database: database:
name: database name: database
description: >- description: Type of database to use
Type of database to use
data_location: data_location:
name: data_location name: data_location
description: >- description: Where do you want your data stored
Where do you want your data stored
localdisks: localdisks:
name: localdisks name: localdisks
description: >- description: >-
Physical name of the partition (ex. sda1) or the share (ex. SharedFiles) to mount separated by commas (ex: sda1,sdb1,MYNAS) Physical name of the partition (ex. sda1) or the share (ex. SharedFiles)
to mount separated by commas (ex: sda1,sdb1,MYNAS)
networkdisks: networkdisks:
name: networkdisks name: networkdisks
description: >- description: "list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)"
list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)
DB_HOSTNAME: DB_HOSTNAME:
name: DB_HOSTNAME name: DB_HOSTNAME
description: >- description: If using external postgresql
If using external postgresql
DB_USERNAME: DB_USERNAME:
name: DB_USERNAME name: DB_USERNAME
description: >- description: If using external postgresql
If using external postgresql
DB_PORT: DB_PORT:
name: DB_PORT name: DB_PORT
description: >- description: If using external postgresql
If using external postgresql
DB_PASSWORD: DB_PASSWORD:
name: DB_PASSWORD name: DB_PASSWORD
description: >- description: If using external postgresql
If using external postgresql
DB_DATABASE_NAME: DB_DATABASE_NAME:
name: DB_DATABASE_NAME name: DB_DATABASE_NAME
description: >- description: If using external postgresql
If using external postgresql
UPLOAD_LOCATION: UPLOAD_LOCATION:
name: UPLOAD_LOCATION name: UPLOAD_LOCATION
description: >- description: This is the location where uploaded files are stored
This is the location where uploaded files are stored
JWT_SECRET: JWT_SECRET:
name: JWT_SECRET name: JWT_SECRET
description: >- description: Used to sign the authentication keys for user login
Used to sign the authentication keys for user login
run_duration: run_duration:
name: run_duration name: run_duration
description: >- description: >-
12h #for how long should the addon run. Must be formatted as number + time unit (ex : 5s, or 2m, or 12h, or 5d...) 12h #for how long should the addon run. Must be formatted as number + time
unit (ex : 5s, or 2m, or 12h, or 5d...)
silent: silent:
name: silent name: silent
description: >- description: "true #suppresses debug messages"
true #suppresses debug messages
ssl: ssl:
name: ssl name: ssl
description: >- description: "true/false : enables ssl. Need certfile and keyfile filled"
true/false : enables ssl. Need certfile and keyfile filled
certfile: certfile:
name: certfile name: certfile
description: >- description: "fullchain.pem #ssl certificate, must be located in /ssl"
fullchain.pem #ssl certificate, must be located in /ssl
keyfile: keyfile:
name: keyfile name: keyfile
description: >- description: "privkey.pem #sslkeyfile, must be located in /ssl"
privkey.pem #sslkeyfile, must be located in /ssl
whitelist: whitelist:
name: whitelist name: whitelist
description: >- description: '"localhost,192.168.0.0/16" # list ip subnets that won''t need a password'
"localhost,192.168.0.0/16" # list ip subnets that won't need a password
customUI: customUI:
name: customUI name: customUI
description: >- description: >-
selection from list # alternative webUI can be set here. Latest version set at each addon start selection from list # alternative webUI can be set here. Latest version
set at each addon start
DNS_servers: DNS_servers:
name: DNS_servers name: DNS_servers
description: >- description: >-
8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to avoid spamming in case of local DNS ad-remover 8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to
avoid spamming in case of local DNS ad-remover
openvpn_alt_mode: openvpn_alt_mode:
name: openvpn_alt_mode name: openvpn_alt_mode
description: >- description: bind at container level and not app level
bind at container level and not app level
openvpn_config: openvpn_config:
name: openvpn_config name: openvpn_config
description: >- description: 'for example "config.ovpn" # name of the file located in /config/openvpn'
for example "config.ovpn" # name of the file located in /config/openvpn

View File

@@ -3,108 +3,95 @@ configuration:
PGID: PGID:
name: PGID name: PGID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
PUID: PUID:
name: PUID name: PUID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
TZ: TZ:
name: TZ name: TZ
description: >- description: >-
The timezone, as described in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones The timezone, as described in
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
cifspassword: cifspassword:
name: cifspassword name: cifspassword
description: >- description: "Your password to access your SMB share, same for all smb shares"
Your password to access your SMB share, same for all smb shares
cifsusername: cifsusername:
name: cifsusername name: cifsusername
description: >- description: "Your username to access your SMB share, same for all smb shares"
Your username to access your SMB share, same for all smb shares
cifsdomain: cifsdomain:
name: cifsdomain name: cifsdomain
description: >- description: Allow setting the domain for the smb share
Allow setting the domain for the smb share
database: database:
name: database name: database
description: >- description: Type of database to use
Type of database to use
data_location: data_location:
name: data_location name: data_location
description: >- description: Where do you want your data stored
Where do you want your data stored
localdisks: localdisks:
name: localdisks name: localdisks
description: >- description: >-
Physical name of the partition (ex. sda1) or the share (ex. SharedFiles) to mount separated by commas (ex: sda1,sdb1,MYNAS) Physical name of the partition (ex. sda1) or the share (ex. SharedFiles)
to mount separated by commas (ex: sda1,sdb1,MYNAS)
networkdisks: networkdisks:
name: networkdisks name: networkdisks
description: >- description: "list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)"
list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)
DB_HOSTNAME: DB_HOSTNAME:
name: DB_HOSTNAME name: DB_HOSTNAME
description: >- description: If using external postgresql
If using external postgresql
DB_USERNAME: DB_USERNAME:
name: DB_USERNAME name: DB_USERNAME
description: >- description: If using external postgresql
If using external postgresql
DB_PORT: DB_PORT:
name: DB_PORT name: DB_PORT
description: >- description: If using external postgresql
If using external postgresql
DB_PASSWORD: DB_PASSWORD:
name: DB_PASSWORD name: DB_PASSWORD
description: >- description: If using external postgresql
If using external postgresql
DB_DATABASE_NAME: DB_DATABASE_NAME:
name: DB_DATABASE_NAME name: DB_DATABASE_NAME
description: >- description: If using external postgresql
If using external postgresql
UPLOAD_LOCATION: UPLOAD_LOCATION:
name: UPLOAD_LOCATION name: UPLOAD_LOCATION
description: >- description: This is the location where uploaded files are stored
This is the location where uploaded files are stored
JWT_SECRET: JWT_SECRET:
name: JWT_SECRET name: JWT_SECRET
description: >- description: Used to sign the authentication keys for user login
Used to sign the authentication keys for user login
run_duration: run_duration:
name: run_duration name: run_duration
description: >- description: >-
12h #for how long should the addon run. Must be formatted as number + time unit (ex : 5s, or 2m, or 12h, or 5d...) 12h #for how long should the addon run. Must be formatted as number + time
unit (ex : 5s, or 2m, or 12h, or 5d...)
silent: silent:
name: silent name: silent
description: >- description: "true #suppresses debug messages"
true #suppresses debug messages
ssl: ssl:
name: ssl name: ssl
description: >- description: "true/false : enables ssl. Need certfile and keyfile filled"
true/false : enables ssl. Need certfile and keyfile filled
certfile: certfile:
name: certfile name: certfile
description: >- description: "fullchain.pem #ssl certificate, must be located in /ssl"
fullchain.pem #ssl certificate, must be located in /ssl
keyfile: keyfile:
name: keyfile name: keyfile
description: >- description: "privkey.pem #sslkeyfile, must be located in /ssl"
privkey.pem #sslkeyfile, must be located in /ssl
whitelist: whitelist:
name: whitelist name: whitelist
description: >- description: '"localhost,192.168.0.0/16" # list ip subnets that won''t need a password'
"localhost,192.168.0.0/16" # list ip subnets that won't need a password
customUI: customUI:
name: customUI name: customUI
description: >- description: >-
selection from list # alternative webUI can be set here. Latest version set at each addon start selection from list # alternative webUI can be set here. Latest version
set at each addon start
DNS_servers: DNS_servers:
name: DNS_servers name: DNS_servers
description: >- description: >-
8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to avoid spamming in case of local DNS ad-remover 8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to
avoid spamming in case of local DNS ad-remover
openvpn_alt_mode: openvpn_alt_mode:
name: openvpn_alt_mode name: openvpn_alt_mode
description: >- description: bind at container level and not app level
bind at container level and not app level
openvpn_config: openvpn_config:
name: openvpn_config name: openvpn_config
description: >- description: 'for example "config.ovpn" # name of the file located in /config/openvpn'
for example "config.ovpn" # name of the file located in /config/openvpn

View File

@@ -3,108 +3,95 @@ configuration:
PGID: PGID:
name: PGID name: PGID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
PUID: PUID:
name: PUID name: PUID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
TZ: TZ:
name: TZ name: TZ
description: >- description: >-
The timezone, as described in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones The timezone, as described in
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
cifspassword: cifspassword:
name: cifspassword name: cifspassword
description: >- description: "Your password to access your SMB share, same for all smb shares"
Your password to access your SMB share, same for all smb shares
cifsusername: cifsusername:
name: cifsusername name: cifsusername
description: >- description: "Your username to access your SMB share, same for all smb shares"
Your username to access your SMB share, same for all smb shares
cifsdomain: cifsdomain:
name: cifsdomain name: cifsdomain
description: >- description: Allow setting the domain for the smb share
Allow setting the domain for the smb share
database: database:
name: database name: database
description: >- description: Type of database to use
Type of database to use
data_location: data_location:
name: data_location name: data_location
description: >- description: Where do you want your data stored
Where do you want your data stored
localdisks: localdisks:
name: localdisks name: localdisks
description: >- description: >-
Physical name of the partition (ex. sda1) or the share (ex. SharedFiles) to mount separated by commas (ex: sda1,sdb1,MYNAS) Physical name of the partition (ex. sda1) or the share (ex. SharedFiles)
to mount separated by commas (ex: sda1,sdb1,MYNAS)
networkdisks: networkdisks:
name: networkdisks name: networkdisks
description: >- description: "list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)"
list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)
DB_HOSTNAME: DB_HOSTNAME:
name: DB_HOSTNAME name: DB_HOSTNAME
description: >- description: If using external postgresql
If using external postgresql
DB_USERNAME: DB_USERNAME:
name: DB_USERNAME name: DB_USERNAME
description: >- description: If using external postgresql
If using external postgresql
DB_PORT: DB_PORT:
name: DB_PORT name: DB_PORT
description: >- description: If using external postgresql
If using external postgresql
DB_PASSWORD: DB_PASSWORD:
name: DB_PASSWORD name: DB_PASSWORD
description: >- description: If using external postgresql
If using external postgresql
DB_DATABASE_NAME: DB_DATABASE_NAME:
name: DB_DATABASE_NAME name: DB_DATABASE_NAME
description: >- description: If using external postgresql
If using external postgresql
UPLOAD_LOCATION: UPLOAD_LOCATION:
name: UPLOAD_LOCATION name: UPLOAD_LOCATION
description: >- description: This is the location where uploaded files are stored
This is the location where uploaded files are stored
JWT_SECRET: JWT_SECRET:
name: JWT_SECRET name: JWT_SECRET
description: >- description: Used to sign the authentication keys for user login
Used to sign the authentication keys for user login
run_duration: run_duration:
name: run_duration name: run_duration
description: >- description: >-
12h #for how long should the addon run. Must be formatted as number + time unit (ex : 5s, or 2m, or 12h, or 5d...) 12h #for how long should the addon run. Must be formatted as number + time
unit (ex : 5s, or 2m, or 12h, or 5d...)
silent: silent:
name: silent name: silent
description: >- description: "true #suppresses debug messages"
true #suppresses debug messages
ssl: ssl:
name: ssl name: ssl
description: >- description: "true/false : enables ssl. Need certfile and keyfile filled"
true/false : enables ssl. Need certfile and keyfile filled
certfile: certfile:
name: certfile name: certfile
description: >- description: "fullchain.pem #ssl certificate, must be located in /ssl"
fullchain.pem #ssl certificate, must be located in /ssl
keyfile: keyfile:
name: keyfile name: keyfile
description: >- description: "privkey.pem #sslkeyfile, must be located in /ssl"
privkey.pem #sslkeyfile, must be located in /ssl
whitelist: whitelist:
name: whitelist name: whitelist
description: >- description: '"localhost,192.168.0.0/16" # list ip subnets that won''t need a password'
"localhost,192.168.0.0/16" # list ip subnets that won't need a password
customUI: customUI:
name: customUI name: customUI
description: >- description: >-
selection from list # alternative webUI can be set here. Latest version set at each addon start selection from list # alternative webUI can be set here. Latest version
set at each addon start
DNS_servers: DNS_servers:
name: DNS_servers name: DNS_servers
description: >- description: >-
8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to avoid spamming in case of local DNS ad-remover 8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to
avoid spamming in case of local DNS ad-remover
openvpn_alt_mode: openvpn_alt_mode:
name: openvpn_alt_mode name: openvpn_alt_mode
description: >- description: bind at container level and not app level
bind at container level and not app level
openvpn_config: openvpn_config:
name: openvpn_config name: openvpn_config
description: >- description: 'for example "config.ovpn" # name of the file located in /config/openvpn'
for example "config.ovpn" # name of the file located in /config/openvpn

View File

@@ -3,108 +3,95 @@ configuration:
PGID: PGID:
name: PGID name: PGID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
PUID: PUID:
name: PUID name: PUID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
TZ: TZ:
name: TZ name: TZ
description: >- description: >-
The timezone, as described in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones The timezone, as described in
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
cifspassword: cifspassword:
name: cifspassword name: cifspassword
description: >- description: "Your password to access your SMB share, same for all smb shares"
Your password to access your SMB share, same for all smb shares
cifsusername: cifsusername:
name: cifsusername name: cifsusername
description: >- description: "Your username to access your SMB share, same for all smb shares"
Your username to access your SMB share, same for all smb shares
cifsdomain: cifsdomain:
name: cifsdomain name: cifsdomain
description: >- description: Allow setting the domain for the smb share
Allow setting the domain for the smb share
database: database:
name: database name: database
description: >- description: Type of database to use
Type of database to use
data_location: data_location:
name: data_location name: data_location
description: >- description: Where do you want your data stored
Where do you want your data stored
localdisks: localdisks:
name: localdisks name: localdisks
description: >- description: >-
Physical name of the partition (ex. sda1) or the share (ex. SharedFiles) to mount separated by commas (ex: sda1,sdb1,MYNAS) Physical name of the partition (ex. sda1) or the share (ex. SharedFiles)
to mount separated by commas (ex: sda1,sdb1,MYNAS)
networkdisks: networkdisks:
name: networkdisks name: networkdisks
description: >- description: "list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)"
list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)
DB_HOSTNAME: DB_HOSTNAME:
name: DB_HOSTNAME name: DB_HOSTNAME
description: >- description: If using external postgresql
If using external postgresql
DB_USERNAME: DB_USERNAME:
name: DB_USERNAME name: DB_USERNAME
description: >- description: If using external postgresql
If using external postgresql
DB_PORT: DB_PORT:
name: DB_PORT name: DB_PORT
description: >- description: If using external postgresql
If using external postgresql
DB_PASSWORD: DB_PASSWORD:
name: DB_PASSWORD name: DB_PASSWORD
description: >- description: If using external postgresql
If using external postgresql
DB_DATABASE_NAME: DB_DATABASE_NAME:
name: DB_DATABASE_NAME name: DB_DATABASE_NAME
description: >- description: If using external postgresql
If using external postgresql
UPLOAD_LOCATION: UPLOAD_LOCATION:
name: UPLOAD_LOCATION name: UPLOAD_LOCATION
description: >- description: This is the location where uploaded files are stored
This is the location where uploaded files are stored
JWT_SECRET: JWT_SECRET:
name: JWT_SECRET name: JWT_SECRET
description: >- description: Used to sign the authentication keys for user login
Used to sign the authentication keys for user login
run_duration: run_duration:
name: run_duration name: run_duration
description: >- description: >-
12h #for how long should the addon run. Must be formatted as number + time unit (ex : 5s, or 2m, or 12h, or 5d...) 12h #for how long should the addon run. Must be formatted as number + time
unit (ex : 5s, or 2m, or 12h, or 5d...)
silent: silent:
name: silent name: silent
description: >- description: "true #suppresses debug messages"
true #suppresses debug messages
ssl: ssl:
name: ssl name: ssl
description: >- description: "true/false : enables ssl. Need certfile and keyfile filled"
true/false : enables ssl. Need certfile and keyfile filled
certfile: certfile:
name: certfile name: certfile
description: >- description: "fullchain.pem #ssl certificate, must be located in /ssl"
fullchain.pem #ssl certificate, must be located in /ssl
keyfile: keyfile:
name: keyfile name: keyfile
description: >- description: "privkey.pem #sslkeyfile, must be located in /ssl"
privkey.pem #sslkeyfile, must be located in /ssl
whitelist: whitelist:
name: whitelist name: whitelist
description: >- description: '"localhost,192.168.0.0/16" # list ip subnets that won''t need a password'
"localhost,192.168.0.0/16" # list ip subnets that won't need a password
customUI: customUI:
name: customUI name: customUI
description: >- description: >-
selection from list # alternative webUI can be set here. Latest version set at each addon start selection from list # alternative webUI can be set here. Latest version
set at each addon start
DNS_servers: DNS_servers:
name: DNS_servers name: DNS_servers
description: >- description: >-
8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to avoid spamming in case of local DNS ad-remover 8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to
avoid spamming in case of local DNS ad-remover
openvpn_alt_mode: openvpn_alt_mode:
name: openvpn_alt_mode name: openvpn_alt_mode
description: >- description: bind at container level and not app level
bind at container level and not app level
openvpn_config: openvpn_config:
name: openvpn_config name: openvpn_config
description: >- description: 'for example "config.ovpn" # name of the file located in /config/openvpn'
for example "config.ovpn" # name of the file located in /config/openvpn

View File

@@ -3,108 +3,95 @@ configuration:
PGID: PGID:
name: PGID name: PGID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
PUID: PUID:
name: PUID name: PUID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
TZ: TZ:
name: TZ name: TZ
description: >- description: >-
The timezone, as described in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones The timezone, as described in
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
cifspassword: cifspassword:
name: cifspassword name: cifspassword
description: >- description: "Your password to access your SMB share, same for all smb shares"
Your password to access your SMB share, same for all smb shares
cifsusername: cifsusername:
name: cifsusername name: cifsusername
description: >- description: "Your username to access your SMB share, same for all smb shares"
Your username to access your SMB share, same for all smb shares
cifsdomain: cifsdomain:
name: cifsdomain name: cifsdomain
description: >- description: Allow setting the domain for the smb share
Allow setting the domain for the smb share
database: database:
name: database name: database
description: >- description: Type of database to use
Type of database to use
data_location: data_location:
name: data_location name: data_location
description: >- description: Where do you want your data stored
Where do you want your data stored
localdisks: localdisks:
name: localdisks name: localdisks
description: >- description: >-
Physical name of the partition (ex. sda1) or the share (ex. SharedFiles) to mount separated by commas (ex: sda1,sdb1,MYNAS) Physical name of the partition (ex. sda1) or the share (ex. SharedFiles)
to mount separated by commas (ex: sda1,sdb1,MYNAS)
networkdisks: networkdisks:
name: networkdisks name: networkdisks
description: >- description: "list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)"
list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)
DB_HOSTNAME: DB_HOSTNAME:
name: DB_HOSTNAME name: DB_HOSTNAME
description: >- description: If using external postgresql
If using external postgresql
DB_USERNAME: DB_USERNAME:
name: DB_USERNAME name: DB_USERNAME
description: >- description: If using external postgresql
If using external postgresql
DB_PORT: DB_PORT:
name: DB_PORT name: DB_PORT
description: >- description: If using external postgresql
If using external postgresql
DB_PASSWORD: DB_PASSWORD:
name: DB_PASSWORD name: DB_PASSWORD
description: >- description: If using external postgresql
If using external postgresql
DB_DATABASE_NAME: DB_DATABASE_NAME:
name: DB_DATABASE_NAME name: DB_DATABASE_NAME
description: >- description: If using external postgresql
If using external postgresql
UPLOAD_LOCATION: UPLOAD_LOCATION:
name: UPLOAD_LOCATION name: UPLOAD_LOCATION
description: >- description: This is the location where uploaded files are stored
This is the location where uploaded files are stored
JWT_SECRET: JWT_SECRET:
name: JWT_SECRET name: JWT_SECRET
description: >- description: Used to sign the authentication keys for user login
Used to sign the authentication keys for user login
run_duration: run_duration:
name: run_duration name: run_duration
description: >- description: >-
12h #for how long should the addon run. Must be formatted as number + time unit (ex : 5s, or 2m, or 12h, or 5d...) 12h #for how long should the addon run. Must be formatted as number + time
unit (ex : 5s, or 2m, or 12h, or 5d...)
silent: silent:
name: silent name: silent
description: >- description: "true #suppresses debug messages"
true #suppresses debug messages
ssl: ssl:
name: ssl name: ssl
description: >- description: "true/false : enables ssl. Need certfile and keyfile filled"
true/false : enables ssl. Need certfile and keyfile filled
certfile: certfile:
name: certfile name: certfile
description: >- description: "fullchain.pem #ssl certificate, must be located in /ssl"
fullchain.pem #ssl certificate, must be located in /ssl
keyfile: keyfile:
name: keyfile name: keyfile
description: >- description: "privkey.pem #sslkeyfile, must be located in /ssl"
privkey.pem #sslkeyfile, must be located in /ssl
whitelist: whitelist:
name: whitelist name: whitelist
description: >- description: '"localhost,192.168.0.0/16" # list ip subnets that won''t need a password'
"localhost,192.168.0.0/16" # list ip subnets that won't need a password
customUI: customUI:
name: customUI name: customUI
description: >- description: >-
selection from list # alternative webUI can be set here. Latest version set at each addon start selection from list # alternative webUI can be set here. Latest version
set at each addon start
DNS_servers: DNS_servers:
name: DNS_servers name: DNS_servers
description: >- description: >-
8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to avoid spamming in case of local DNS ad-remover 8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to
avoid spamming in case of local DNS ad-remover
openvpn_alt_mode: openvpn_alt_mode:
name: openvpn_alt_mode name: openvpn_alt_mode
description: >- description: bind at container level and not app level
bind at container level and not app level
openvpn_config: openvpn_config:
name: openvpn_config name: openvpn_config
description: >- description: 'for example "config.ovpn" # name of the file located in /config/openvpn'
for example "config.ovpn" # name of the file located in /config/openvpn

View File

@@ -3,108 +3,95 @@ configuration:
PGID: PGID:
name: PGID name: PGID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
PUID: PUID:
name: PUID name: PUID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
TZ: TZ:
name: TZ name: TZ
description: >- description: >-
The timezone, as described in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones The timezone, as described in
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
cifspassword: cifspassword:
name: cifspassword name: cifspassword
description: >- description: "Your password to access your SMB share, same for all smb shares"
Your password to access your SMB share, same for all smb shares
cifsusername: cifsusername:
name: cifsusername name: cifsusername
description: >- description: "Your username to access your SMB share, same for all smb shares"
Your username to access your SMB share, same for all smb shares
cifsdomain: cifsdomain:
name: cifsdomain name: cifsdomain
description: >- description: Allow setting the domain for the smb share
Allow setting the domain for the smb share
database: database:
name: database name: database
description: >- description: Type of database to use
Type of database to use
data_location: data_location:
name: data_location name: data_location
description: >- description: Where do you want your data stored
Where do you want your data stored
localdisks: localdisks:
name: localdisks name: localdisks
description: >- description: >-
Physical name of the partition (ex. sda1) or the share (ex. SharedFiles) to mount separated by commas (ex: sda1,sdb1,MYNAS) Physical name of the partition (ex. sda1) or the share (ex. SharedFiles)
to mount separated by commas (ex: sda1,sdb1,MYNAS)
networkdisks: networkdisks:
name: networkdisks name: networkdisks
description: >- description: "list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)"
list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)
DB_HOSTNAME: DB_HOSTNAME:
name: DB_HOSTNAME name: DB_HOSTNAME
description: >- description: If using external postgresql
If using external postgresql
DB_USERNAME: DB_USERNAME:
name: DB_USERNAME name: DB_USERNAME
description: >- description: If using external postgresql
If using external postgresql
DB_PORT: DB_PORT:
name: DB_PORT name: DB_PORT
description: >- description: If using external postgresql
If using external postgresql
DB_PASSWORD: DB_PASSWORD:
name: DB_PASSWORD name: DB_PASSWORD
description: >- description: If using external postgresql
If using external postgresql
DB_DATABASE_NAME: DB_DATABASE_NAME:
name: DB_DATABASE_NAME name: DB_DATABASE_NAME
description: >- description: If using external postgresql
If using external postgresql
UPLOAD_LOCATION: UPLOAD_LOCATION:
name: UPLOAD_LOCATION name: UPLOAD_LOCATION
description: >- description: This is the location where uploaded files are stored
This is the location where uploaded files are stored
JWT_SECRET: JWT_SECRET:
name: JWT_SECRET name: JWT_SECRET
description: >- description: Used to sign the authentication keys for user login
Used to sign the authentication keys for user login
run_duration: run_duration:
name: run_duration name: run_duration
description: >- description: >-
12h #for how long should the addon run. Must be formatted as number + time unit (ex : 5s, or 2m, or 12h, or 5d...) 12h #for how long should the addon run. Must be formatted as number + time
unit (ex : 5s, or 2m, or 12h, or 5d...)
silent: silent:
name: silent name: silent
description: >- description: "true #suppresses debug messages"
true #suppresses debug messages
ssl: ssl:
name: ssl name: ssl
description: >- description: "true/false : enables ssl. Need certfile and keyfile filled"
true/false : enables ssl. Need certfile and keyfile filled
certfile: certfile:
name: certfile name: certfile
description: >- description: "fullchain.pem #ssl certificate, must be located in /ssl"
fullchain.pem #ssl certificate, must be located in /ssl
keyfile: keyfile:
name: keyfile name: keyfile
description: >- description: "privkey.pem #sslkeyfile, must be located in /ssl"
privkey.pem #sslkeyfile, must be located in /ssl
whitelist: whitelist:
name: whitelist name: whitelist
description: >- description: '"localhost,192.168.0.0/16" # list ip subnets that won''t need a password'
"localhost,192.168.0.0/16" # list ip subnets that won't need a password
customUI: customUI:
name: customUI name: customUI
description: >- description: >-
selection from list # alternative webUI can be set here. Latest version set at each addon start selection from list # alternative webUI can be set here. Latest version
set at each addon start
DNS_servers: DNS_servers:
name: DNS_servers name: DNS_servers
description: >- description: >-
8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to avoid spamming in case of local DNS ad-remover 8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to
avoid spamming in case of local DNS ad-remover
openvpn_alt_mode: openvpn_alt_mode:
name: openvpn_alt_mode name: openvpn_alt_mode
description: >- description: bind at container level and not app level
bind at container level and not app level
openvpn_config: openvpn_config:
name: openvpn_config name: openvpn_config
description: >- description: 'for example "config.ovpn" # name of the file located in /config/openvpn'
for example "config.ovpn" # name of the file located in /config/openvpn

View File

@@ -3,108 +3,95 @@ configuration:
PGID: PGID:
name: PGID name: PGID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
PUID: PUID:
name: PUID name: PUID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
TZ: TZ:
name: TZ name: TZ
description: >- description: >-
The timezone, as described in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones The timezone, as described in
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
cifspassword: cifspassword:
name: cifspassword name: cifspassword
description: >- description: "Your password to access your SMB share, same for all smb shares"
Your password to access your SMB share, same for all smb shares
cifsusername: cifsusername:
name: cifsusername name: cifsusername
description: >- description: "Your username to access your SMB share, same for all smb shares"
Your username to access your SMB share, same for all smb shares
cifsdomain: cifsdomain:
name: cifsdomain name: cifsdomain
description: >- description: Allow setting the domain for the smb share
Allow setting the domain for the smb share
database: database:
name: database name: database
description: >- description: Type of database to use
Type of database to use
data_location: data_location:
name: data_location name: data_location
description: >- description: Where do you want your data stored
Where do you want your data stored
localdisks: localdisks:
name: localdisks name: localdisks
description: >- description: >-
Physical name of the partition (ex. sda1) or the share (ex. SharedFiles) to mount separated by commas (ex: sda1,sdb1,MYNAS) Physical name of the partition (ex. sda1) or the share (ex. SharedFiles)
to mount separated by commas (ex: sda1,sdb1,MYNAS)
networkdisks: networkdisks:
name: networkdisks name: networkdisks
description: >- description: "list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)"
list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)
DB_HOSTNAME: DB_HOSTNAME:
name: DB_HOSTNAME name: DB_HOSTNAME
description: >- description: If using external postgresql
If using external postgresql
DB_USERNAME: DB_USERNAME:
name: DB_USERNAME name: DB_USERNAME
description: >- description: If using external postgresql
If using external postgresql
DB_PORT: DB_PORT:
name: DB_PORT name: DB_PORT
description: >- description: If using external postgresql
If using external postgresql
DB_PASSWORD: DB_PASSWORD:
name: DB_PASSWORD name: DB_PASSWORD
description: >- description: If using external postgresql
If using external postgresql
DB_DATABASE_NAME: DB_DATABASE_NAME:
name: DB_DATABASE_NAME name: DB_DATABASE_NAME
description: >- description: If using external postgresql
If using external postgresql
UPLOAD_LOCATION: UPLOAD_LOCATION:
name: UPLOAD_LOCATION name: UPLOAD_LOCATION
description: >- description: This is the location where uploaded files are stored
This is the location where uploaded files are stored
JWT_SECRET: JWT_SECRET:
name: JWT_SECRET name: JWT_SECRET
description: >- description: Used to sign the authentication keys for user login
Used to sign the authentication keys for user login
run_duration: run_duration:
name: run_duration name: run_duration
description: >- description: >-
12h #for how long should the addon run. Must be formatted as number + time unit (ex : 5s, or 2m, or 12h, or 5d...) 12h #for how long should the addon run. Must be formatted as number + time
unit (ex : 5s, or 2m, or 12h, or 5d...)
silent: silent:
name: silent name: silent
description: >- description: "true #suppresses debug messages"
true #suppresses debug messages
ssl: ssl:
name: ssl name: ssl
description: >- description: "true/false : enables ssl. Need certfile and keyfile filled"
true/false : enables ssl. Need certfile and keyfile filled
certfile: certfile:
name: certfile name: certfile
description: >- description: "fullchain.pem #ssl certificate, must be located in /ssl"
fullchain.pem #ssl certificate, must be located in /ssl
keyfile: keyfile:
name: keyfile name: keyfile
description: >- description: "privkey.pem #sslkeyfile, must be located in /ssl"
privkey.pem #sslkeyfile, must be located in /ssl
whitelist: whitelist:
name: whitelist name: whitelist
description: >- description: '"localhost,192.168.0.0/16" # list ip subnets that won''t need a password'
"localhost,192.168.0.0/16" # list ip subnets that won't need a password
customUI: customUI:
name: customUI name: customUI
description: >- description: >-
selection from list # alternative webUI can be set here. Latest version set at each addon start selection from list # alternative webUI can be set here. Latest version
set at each addon start
DNS_servers: DNS_servers:
name: DNS_servers name: DNS_servers
description: >- description: >-
8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to avoid spamming in case of local DNS ad-remover 8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to
avoid spamming in case of local DNS ad-remover
openvpn_alt_mode: openvpn_alt_mode:
name: openvpn_alt_mode name: openvpn_alt_mode
description: >- description: bind at container level and not app level
bind at container level and not app level
openvpn_config: openvpn_config:
name: openvpn_config name: openvpn_config
description: >- description: 'for example "config.ovpn" # name of the file located in /config/openvpn'
for example "config.ovpn" # name of the file located in /config/openvpn

View File

@@ -3,108 +3,95 @@ configuration:
PGID: PGID:
name: PGID name: PGID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
PUID: PUID:
name: PUID name: PUID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
TZ: TZ:
name: TZ name: TZ
description: >- description: >-
The timezone, as described in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones The timezone, as described in
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
cifspassword: cifspassword:
name: cifspassword name: cifspassword
description: >- description: "Your password to access your SMB share, same for all smb shares"
Your password to access your SMB share, same for all smb shares
cifsusername: cifsusername:
name: cifsusername name: cifsusername
description: >- description: "Your username to access your SMB share, same for all smb shares"
Your username to access your SMB share, same for all smb shares
cifsdomain: cifsdomain:
name: cifsdomain name: cifsdomain
description: >- description: Allow setting the domain for the smb share
Allow setting the domain for the smb share
database: database:
name: database name: database
description: >- description: Type of database to use
Type of database to use
data_location: data_location:
name: data_location name: data_location
description: >- description: Where do you want your data stored
Where do you want your data stored
localdisks: localdisks:
name: localdisks name: localdisks
description: >- description: >-
Physical name of the partition (ex. sda1) or the share (ex. SharedFiles) to mount separated by commas (ex: sda1,sdb1,MYNAS) Physical name of the partition (ex. sda1) or the share (ex. SharedFiles)
to mount separated by commas (ex: sda1,sdb1,MYNAS)
networkdisks: networkdisks:
name: networkdisks name: networkdisks
description: >- description: "list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)"
list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)
DB_HOSTNAME: DB_HOSTNAME:
name: DB_HOSTNAME name: DB_HOSTNAME
description: >- description: If using external postgresql
If using external postgresql
DB_USERNAME: DB_USERNAME:
name: DB_USERNAME name: DB_USERNAME
description: >- description: If using external postgresql
If using external postgresql
DB_PORT: DB_PORT:
name: DB_PORT name: DB_PORT
description: >- description: If using external postgresql
If using external postgresql
DB_PASSWORD: DB_PASSWORD:
name: DB_PASSWORD name: DB_PASSWORD
description: >- description: If using external postgresql
If using external postgresql
DB_DATABASE_NAME: DB_DATABASE_NAME:
name: DB_DATABASE_NAME name: DB_DATABASE_NAME
description: >- description: If using external postgresql
If using external postgresql
UPLOAD_LOCATION: UPLOAD_LOCATION:
name: UPLOAD_LOCATION name: UPLOAD_LOCATION
description: >- description: This is the location where uploaded files are stored
This is the location where uploaded files are stored
JWT_SECRET: JWT_SECRET:
name: JWT_SECRET name: JWT_SECRET
description: >- description: Used to sign the authentication keys for user login
Used to sign the authentication keys for user login
run_duration: run_duration:
name: run_duration name: run_duration
description: >- description: >-
12h #for how long should the addon run. Must be formatted as number + time unit (ex : 5s, or 2m, or 12h, or 5d...) 12h #for how long should the addon run. Must be formatted as number + time
unit (ex : 5s, or 2m, or 12h, or 5d...)
silent: silent:
name: silent name: silent
description: >- description: "true #suppresses debug messages"
true #suppresses debug messages
ssl: ssl:
name: ssl name: ssl
description: >- description: "true/false : enables ssl. Need certfile and keyfile filled"
true/false : enables ssl. Need certfile and keyfile filled
certfile: certfile:
name: certfile name: certfile
description: >- description: "fullchain.pem #ssl certificate, must be located in /ssl"
fullchain.pem #ssl certificate, must be located in /ssl
keyfile: keyfile:
name: keyfile name: keyfile
description: >- description: "privkey.pem #sslkeyfile, must be located in /ssl"
privkey.pem #sslkeyfile, must be located in /ssl
whitelist: whitelist:
name: whitelist name: whitelist
description: >- description: '"localhost,192.168.0.0/16" # list ip subnets that won''t need a password'
"localhost,192.168.0.0/16" # list ip subnets that won't need a password
customUI: customUI:
name: customUI name: customUI
description: >- description: >-
selection from list # alternative webUI can be set here. Latest version set at each addon start selection from list # alternative webUI can be set here. Latest version
set at each addon start
DNS_servers: DNS_servers:
name: DNS_servers name: DNS_servers
description: >- description: >-
8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to avoid spamming in case of local DNS ad-remover 8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to
avoid spamming in case of local DNS ad-remover
openvpn_alt_mode: openvpn_alt_mode:
name: openvpn_alt_mode name: openvpn_alt_mode
description: >- description: bind at container level and not app level
bind at container level and not app level
openvpn_config: openvpn_config:
name: openvpn_config name: openvpn_config
description: >- description: 'for example "config.ovpn" # name of the file located in /config/openvpn'
for example "config.ovpn" # name of the file located in /config/openvpn

View File

@@ -3,108 +3,95 @@ configuration:
PGID: PGID:
name: PGID name: PGID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
PUID: PUID:
name: PUID name: PUID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
TZ: TZ:
name: TZ name: TZ
description: >- description: >-
The timezone, as described in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones The timezone, as described in
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
cifspassword: cifspassword:
name: cifspassword name: cifspassword
description: >- description: "Your password to access your SMB share, same for all smb shares"
Your password to access your SMB share, same for all smb shares
cifsusername: cifsusername:
name: cifsusername name: cifsusername
description: >- description: "Your username to access your SMB share, same for all smb shares"
Your username to access your SMB share, same for all smb shares
cifsdomain: cifsdomain:
name: cifsdomain name: cifsdomain
description: >- description: Allow setting the domain for the smb share
Allow setting the domain for the smb share
database: database:
name: database name: database
description: >- description: Type of database to use
Type of database to use
data_location: data_location:
name: data_location name: data_location
description: >- description: Where do you want your data stored
Where do you want your data stored
localdisks: localdisks:
name: localdisks name: localdisks
description: >- description: >-
Physical name of the partition (ex. sda1) or the share (ex. SharedFiles) to mount separated by commas (ex: sda1,sdb1,MYNAS) Physical name of the partition (ex. sda1) or the share (ex. SharedFiles)
to mount separated by commas (ex: sda1,sdb1,MYNAS)
networkdisks: networkdisks:
name: networkdisks name: networkdisks
description: >- description: "list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)"
list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)
DB_HOSTNAME: DB_HOSTNAME:
name: DB_HOSTNAME name: DB_HOSTNAME
description: >- description: If using external postgresql
If using external postgresql
DB_USERNAME: DB_USERNAME:
name: DB_USERNAME name: DB_USERNAME
description: >- description: If using external postgresql
If using external postgresql
DB_PORT: DB_PORT:
name: DB_PORT name: DB_PORT
description: >- description: If using external postgresql
If using external postgresql
DB_PASSWORD: DB_PASSWORD:
name: DB_PASSWORD name: DB_PASSWORD
description: >- description: If using external postgresql
If using external postgresql
DB_DATABASE_NAME: DB_DATABASE_NAME:
name: DB_DATABASE_NAME name: DB_DATABASE_NAME
description: >- description: If using external postgresql
If using external postgresql
UPLOAD_LOCATION: UPLOAD_LOCATION:
name: UPLOAD_LOCATION name: UPLOAD_LOCATION
description: >- description: This is the location where uploaded files are stored
This is the location where uploaded files are stored
JWT_SECRET: JWT_SECRET:
name: JWT_SECRET name: JWT_SECRET
description: >- description: Used to sign the authentication keys for user login
Used to sign the authentication keys for user login
run_duration: run_duration:
name: run_duration name: run_duration
description: >- description: >-
12h #for how long should the addon run. Must be formatted as number + time unit (ex : 5s, or 2m, or 12h, or 5d...) 12h #for how long should the addon run. Must be formatted as number + time
unit (ex : 5s, or 2m, or 12h, or 5d...)
silent: silent:
name: silent name: silent
description: >- description: "true #suppresses debug messages"
true #suppresses debug messages
ssl: ssl:
name: ssl name: ssl
description: >- description: "true/false : enables ssl. Need certfile and keyfile filled"
true/false : enables ssl. Need certfile and keyfile filled
certfile: certfile:
name: certfile name: certfile
description: >- description: "fullchain.pem #ssl certificate, must be located in /ssl"
fullchain.pem #ssl certificate, must be located in /ssl
keyfile: keyfile:
name: keyfile name: keyfile
description: >- description: "privkey.pem #sslkeyfile, must be located in /ssl"
privkey.pem #sslkeyfile, must be located in /ssl
whitelist: whitelist:
name: whitelist name: whitelist
description: >- description: '"localhost,192.168.0.0/16" # list ip subnets that won''t need a password'
"localhost,192.168.0.0/16" # list ip subnets that won't need a password
customUI: customUI:
name: customUI name: customUI
description: >- description: >-
selection from list # alternative webUI can be set here. Latest version set at each addon start selection from list # alternative webUI can be set here. Latest version
set at each addon start
DNS_servers: DNS_servers:
name: DNS_servers name: DNS_servers
description: >- description: >-
8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to avoid spamming in case of local DNS ad-remover 8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to
avoid spamming in case of local DNS ad-remover
openvpn_alt_mode: openvpn_alt_mode:
name: openvpn_alt_mode name: openvpn_alt_mode
description: >- description: bind at container level and not app level
bind at container level and not app level
openvpn_config: openvpn_config:
name: openvpn_config name: openvpn_config
description: >- description: 'for example "config.ovpn" # name of the file located in /config/openvpn'
for example "config.ovpn" # name of the file located in /config/openvpn

View File

@@ -3,108 +3,95 @@ configuration:
PGID: PGID:
name: PGID name: PGID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
PUID: PUID:
name: PUID name: PUID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
TZ: TZ:
name: TZ name: TZ
description: >- description: >-
The timezone, as described in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones The timezone, as described in
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
cifspassword: cifspassword:
name: cifspassword name: cifspassword
description: >- description: "Your password to access your SMB share, same for all smb shares"
Your password to access your SMB share, same for all smb shares
cifsusername: cifsusername:
name: cifsusername name: cifsusername
description: >- description: "Your username to access your SMB share, same for all smb shares"
Your username to access your SMB share, same for all smb shares
cifsdomain: cifsdomain:
name: cifsdomain name: cifsdomain
description: >- description: Allow setting the domain for the smb share
Allow setting the domain for the smb share
database: database:
name: database name: database
description: >- description: Type of database to use
Type of database to use
data_location: data_location:
name: data_location name: data_location
description: >- description: Where do you want your data stored
Where do you want your data stored
localdisks: localdisks:
name: localdisks name: localdisks
description: >- description: >-
Physical name of the partition (ex. sda1) or the share (ex. SharedFiles) to mount separated by commas (ex: sda1,sdb1,MYNAS) Physical name of the partition (ex. sda1) or the share (ex. SharedFiles)
to mount separated by commas (ex: sda1,sdb1,MYNAS)
networkdisks: networkdisks:
name: networkdisks name: networkdisks
description: >- description: "list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)"
list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)
DB_HOSTNAME: DB_HOSTNAME:
name: DB_HOSTNAME name: DB_HOSTNAME
description: >- description: If using external postgresql
If using external postgresql
DB_USERNAME: DB_USERNAME:
name: DB_USERNAME name: DB_USERNAME
description: >- description: If using external postgresql
If using external postgresql
DB_PORT: DB_PORT:
name: DB_PORT name: DB_PORT
description: >- description: If using external postgresql
If using external postgresql
DB_PASSWORD: DB_PASSWORD:
name: DB_PASSWORD name: DB_PASSWORD
description: >- description: If using external postgresql
If using external postgresql
DB_DATABASE_NAME: DB_DATABASE_NAME:
name: DB_DATABASE_NAME name: DB_DATABASE_NAME
description: >- description: If using external postgresql
If using external postgresql
UPLOAD_LOCATION: UPLOAD_LOCATION:
name: UPLOAD_LOCATION name: UPLOAD_LOCATION
description: >- description: This is the location where uploaded files are stored
This is the location where uploaded files are stored
JWT_SECRET: JWT_SECRET:
name: JWT_SECRET name: JWT_SECRET
description: >- description: Used to sign the authentication keys for user login
Used to sign the authentication keys for user login
run_duration: run_duration:
name: run_duration name: run_duration
description: >- description: >-
12h #for how long should the addon run. Must be formatted as number + time unit (ex : 5s, or 2m, or 12h, or 5d...) 12h #for how long should the addon run. Must be formatted as number + time
unit (ex : 5s, or 2m, or 12h, or 5d...)
silent: silent:
name: silent name: silent
description: >- description: "true #suppresses debug messages"
true #suppresses debug messages
ssl: ssl:
name: ssl name: ssl
description: >- description: "true/false : enables ssl. Need certfile and keyfile filled"
true/false : enables ssl. Need certfile and keyfile filled
certfile: certfile:
name: certfile name: certfile
description: >- description: "fullchain.pem #ssl certificate, must be located in /ssl"
fullchain.pem #ssl certificate, must be located in /ssl
keyfile: keyfile:
name: keyfile name: keyfile
description: >- description: "privkey.pem #sslkeyfile, must be located in /ssl"
privkey.pem #sslkeyfile, must be located in /ssl
whitelist: whitelist:
name: whitelist name: whitelist
description: >- description: '"localhost,192.168.0.0/16" # list ip subnets that won''t need a password'
"localhost,192.168.0.0/16" # list ip subnets that won't need a password
customUI: customUI:
name: customUI name: customUI
description: >- description: >-
selection from list # alternative webUI can be set here. Latest version set at each addon start selection from list # alternative webUI can be set here. Latest version
set at each addon start
DNS_servers: DNS_servers:
name: DNS_servers name: DNS_servers
description: >- description: >-
8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to avoid spamming in case of local DNS ad-remover 8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to
avoid spamming in case of local DNS ad-remover
openvpn_alt_mode: openvpn_alt_mode:
name: openvpn_alt_mode name: openvpn_alt_mode
description: >- description: bind at container level and not app level
bind at container level and not app level
openvpn_config: openvpn_config:
name: openvpn_config name: openvpn_config
description: >- description: 'for example "config.ovpn" # name of the file located in /config/openvpn'
for example "config.ovpn" # name of the file located in /config/openvpn

View File

@@ -3,108 +3,95 @@ configuration:
PGID: PGID:
name: PGID name: PGID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
PUID: PUID:
name: PUID name: PUID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
TZ: TZ:
name: TZ name: TZ
description: >- description: >-
The timezone, as described in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones The timezone, as described in
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
cifspassword: cifspassword:
name: cifspassword name: cifspassword
description: >- description: "Your password to access your SMB share, same for all smb shares"
Your password to access your SMB share, same for all smb shares
cifsusername: cifsusername:
name: cifsusername name: cifsusername
description: >- description: "Your username to access your SMB share, same for all smb shares"
Your username to access your SMB share, same for all smb shares
cifsdomain: cifsdomain:
name: cifsdomain name: cifsdomain
description: >- description: Allow setting the domain for the smb share
Allow setting the domain for the smb share
database: database:
name: database name: database
description: >- description: Type of database to use
Type of database to use
data_location: data_location:
name: data_location name: data_location
description: >- description: Where do you want your data stored
Where do you want your data stored
localdisks: localdisks:
name: localdisks name: localdisks
description: >- description: >-
Physical name of the partition (ex. sda1) or the share (ex. SharedFiles) to mount separated by commas (ex: sda1,sdb1,MYNAS) Physical name of the partition (ex. sda1) or the share (ex. SharedFiles)
to mount separated by commas (ex: sda1,sdb1,MYNAS)
networkdisks: networkdisks:
name: networkdisks name: networkdisks
description: >- description: "list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)"
list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)
DB_HOSTNAME: DB_HOSTNAME:
name: DB_HOSTNAME name: DB_HOSTNAME
description: >- description: If using external postgresql
If using external postgresql
DB_USERNAME: DB_USERNAME:
name: DB_USERNAME name: DB_USERNAME
description: >- description: If using external postgresql
If using external postgresql
DB_PORT: DB_PORT:
name: DB_PORT name: DB_PORT
description: >- description: If using external postgresql
If using external postgresql
DB_PASSWORD: DB_PASSWORD:
name: DB_PASSWORD name: DB_PASSWORD
description: >- description: If using external postgresql
If using external postgresql
DB_DATABASE_NAME: DB_DATABASE_NAME:
name: DB_DATABASE_NAME name: DB_DATABASE_NAME
description: >- description: If using external postgresql
If using external postgresql
UPLOAD_LOCATION: UPLOAD_LOCATION:
name: UPLOAD_LOCATION name: UPLOAD_LOCATION
description: >- description: This is the location where uploaded files are stored
This is the location where uploaded files are stored
JWT_SECRET: JWT_SECRET:
name: JWT_SECRET name: JWT_SECRET
description: >- description: Used to sign the authentication keys for user login
Used to sign the authentication keys for user login
run_duration: run_duration:
name: run_duration name: run_duration
description: >- description: >-
12h #for how long should the addon run. Must be formatted as number + time unit (ex : 5s, or 2m, or 12h, or 5d...) 12h #for how long should the addon run. Must be formatted as number + time
unit (ex : 5s, or 2m, or 12h, or 5d...)
silent: silent:
name: silent name: silent
description: >- description: "true #suppresses debug messages"
true #suppresses debug messages
ssl: ssl:
name: ssl name: ssl
description: >- description: "true/false : enables ssl. Need certfile and keyfile filled"
true/false : enables ssl. Need certfile and keyfile filled
certfile: certfile:
name: certfile name: certfile
description: >- description: "fullchain.pem #ssl certificate, must be located in /ssl"
fullchain.pem #ssl certificate, must be located in /ssl
keyfile: keyfile:
name: keyfile name: keyfile
description: >- description: "privkey.pem #sslkeyfile, must be located in /ssl"
privkey.pem #sslkeyfile, must be located in /ssl
whitelist: whitelist:
name: whitelist name: whitelist
description: >- description: '"localhost,192.168.0.0/16" # list ip subnets that won''t need a password'
"localhost,192.168.0.0/16" # list ip subnets that won't need a password
customUI: customUI:
name: customUI name: customUI
description: >- description: >-
selection from list # alternative webUI can be set here. Latest version set at each addon start selection from list # alternative webUI can be set here. Latest version
set at each addon start
DNS_servers: DNS_servers:
name: DNS_servers name: DNS_servers
description: >- description: >-
8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to avoid spamming in case of local DNS ad-remover 8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to
avoid spamming in case of local DNS ad-remover
openvpn_alt_mode: openvpn_alt_mode:
name: openvpn_alt_mode name: openvpn_alt_mode
description: >- description: bind at container level and not app level
bind at container level and not app level
openvpn_config: openvpn_config:
name: openvpn_config name: openvpn_config
description: >- description: 'for example "config.ovpn" # name of the file located in /config/openvpn'
for example "config.ovpn" # name of the file located in /config/openvpn

View File

@@ -3,108 +3,95 @@ configuration:
PGID: PGID:
name: PGID name: PGID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
PUID: PUID:
name: PUID name: PUID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
TZ: TZ:
name: TZ name: TZ
description: >- description: >-
The timezone, as described in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones The timezone, as described in
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
cifspassword: cifspassword:
name: cifspassword name: cifspassword
description: >- description: "Your password to access your SMB share, same for all smb shares"
Your password to access your SMB share, same for all smb shares
cifsusername: cifsusername:
name: cifsusername name: cifsusername
description: >- description: "Your username to access your SMB share, same for all smb shares"
Your username to access your SMB share, same for all smb shares
cifsdomain: cifsdomain:
name: cifsdomain name: cifsdomain
description: >- description: Allow setting the domain for the smb share
Allow setting the domain for the smb share
database: database:
name: database name: database
description: >- description: Type of database to use
Type of database to use
data_location: data_location:
name: data_location name: data_location
description: >- description: Where do you want your data stored
Where do you want your data stored
localdisks: localdisks:
name: localdisks name: localdisks
description: >- description: >-
Physical name of the partition (ex. sda1) or the share (ex. SharedFiles) to mount separated by commas (ex: sda1,sdb1,MYNAS) Physical name of the partition (ex. sda1) or the share (ex. SharedFiles)
to mount separated by commas (ex: sda1,sdb1,MYNAS)
networkdisks: networkdisks:
name: networkdisks name: networkdisks
description: >- description: "list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)"
list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)
DB_HOSTNAME: DB_HOSTNAME:
name: DB_HOSTNAME name: DB_HOSTNAME
description: >- description: If using external postgresql
If using external postgresql
DB_USERNAME: DB_USERNAME:
name: DB_USERNAME name: DB_USERNAME
description: >- description: If using external postgresql
If using external postgresql
DB_PORT: DB_PORT:
name: DB_PORT name: DB_PORT
description: >- description: If using external postgresql
If using external postgresql
DB_PASSWORD: DB_PASSWORD:
name: DB_PASSWORD name: DB_PASSWORD
description: >- description: If using external postgresql
If using external postgresql
DB_DATABASE_NAME: DB_DATABASE_NAME:
name: DB_DATABASE_NAME name: DB_DATABASE_NAME
description: >- description: If using external postgresql
If using external postgresql
UPLOAD_LOCATION: UPLOAD_LOCATION:
name: UPLOAD_LOCATION name: UPLOAD_LOCATION
description: >- description: This is the location where uploaded files are stored
This is the location where uploaded files are stored
JWT_SECRET: JWT_SECRET:
name: JWT_SECRET name: JWT_SECRET
description: >- description: Used to sign the authentication keys for user login
Used to sign the authentication keys for user login
run_duration: run_duration:
name: run_duration name: run_duration
description: >- description: >-
12h #for how long should the addon run. Must be formatted as number + time unit (ex : 5s, or 2m, or 12h, or 5d...) 12h #for how long should the addon run. Must be formatted as number + time
unit (ex : 5s, or 2m, or 12h, or 5d...)
silent: silent:
name: silent name: silent
description: >- description: "true #suppresses debug messages"
true #suppresses debug messages
ssl: ssl:
name: ssl name: ssl
description: >- description: "true/false : enables ssl. Need certfile and keyfile filled"
true/false : enables ssl. Need certfile and keyfile filled
certfile: certfile:
name: certfile name: certfile
description: >- description: "fullchain.pem #ssl certificate, must be located in /ssl"
fullchain.pem #ssl certificate, must be located in /ssl
keyfile: keyfile:
name: keyfile name: keyfile
description: >- description: "privkey.pem #sslkeyfile, must be located in /ssl"
privkey.pem #sslkeyfile, must be located in /ssl
whitelist: whitelist:
name: whitelist name: whitelist
description: >- description: '"localhost,192.168.0.0/16" # list ip subnets that won''t need a password'
"localhost,192.168.0.0/16" # list ip subnets that won't need a password
customUI: customUI:
name: customUI name: customUI
description: >- description: >-
selection from list # alternative webUI can be set here. Latest version set at each addon start selection from list # alternative webUI can be set here. Latest version
set at each addon start
DNS_servers: DNS_servers:
name: DNS_servers name: DNS_servers
description: >- description: >-
8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to avoid spamming in case of local DNS ad-remover 8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to
avoid spamming in case of local DNS ad-remover
openvpn_alt_mode: openvpn_alt_mode:
name: openvpn_alt_mode name: openvpn_alt_mode
description: >- description: bind at container level and not app level
bind at container level and not app level
openvpn_config: openvpn_config:
name: openvpn_config name: openvpn_config
description: >- description: 'for example "config.ovpn" # name of the file located in /config/openvpn'
for example "config.ovpn" # name of the file located in /config/openvpn

View File

@@ -3,108 +3,95 @@ configuration:
PGID: PGID:
name: PGID name: PGID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
PUID: PUID:
name: PUID name: PUID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
TZ: TZ:
name: TZ name: TZ
description: >- description: >-
The timezone, as described in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones The timezone, as described in
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
cifspassword: cifspassword:
name: cifspassword name: cifspassword
description: >- description: "Your password to access your SMB share, same for all smb shares"
Your password to access your SMB share, same for all smb shares
cifsusername: cifsusername:
name: cifsusername name: cifsusername
description: >- description: "Your username to access your SMB share, same for all smb shares"
Your username to access your SMB share, same for all smb shares
cifsdomain: cifsdomain:
name: cifsdomain name: cifsdomain
description: >- description: Allow setting the domain for the smb share
Allow setting the domain for the smb share
database: database:
name: database name: database
description: >- description: Type of database to use
Type of database to use
data_location: data_location:
name: data_location name: data_location
description: >- description: Where do you want your data stored
Where do you want your data stored
localdisks: localdisks:
name: localdisks name: localdisks
description: >- description: >-
Physical name of the partition (ex. sda1) or the share (ex. SharedFiles) to mount separated by commas (ex: sda1,sdb1,MYNAS) Physical name of the partition (ex. sda1) or the share (ex. SharedFiles)
to mount separated by commas (ex: sda1,sdb1,MYNAS)
networkdisks: networkdisks:
name: networkdisks name: networkdisks
description: >- description: "list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)"
list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)
DB_HOSTNAME: DB_HOSTNAME:
name: DB_HOSTNAME name: DB_HOSTNAME
description: >- description: If using external postgresql
If using external postgresql
DB_USERNAME: DB_USERNAME:
name: DB_USERNAME name: DB_USERNAME
description: >- description: If using external postgresql
If using external postgresql
DB_PORT: DB_PORT:
name: DB_PORT name: DB_PORT
description: >- description: If using external postgresql
If using external postgresql
DB_PASSWORD: DB_PASSWORD:
name: DB_PASSWORD name: DB_PASSWORD
description: >- description: If using external postgresql
If using external postgresql
DB_DATABASE_NAME: DB_DATABASE_NAME:
name: DB_DATABASE_NAME name: DB_DATABASE_NAME
description: >- description: If using external postgresql
If using external postgresql
UPLOAD_LOCATION: UPLOAD_LOCATION:
name: UPLOAD_LOCATION name: UPLOAD_LOCATION
description: >- description: This is the location where uploaded files are stored
This is the location where uploaded files are stored
JWT_SECRET: JWT_SECRET:
name: JWT_SECRET name: JWT_SECRET
description: >- description: Used to sign the authentication keys for user login
Used to sign the authentication keys for user login
run_duration: run_duration:
name: run_duration name: run_duration
description: >- description: >-
12h #for how long should the addon run. Must be formatted as number + time unit (ex : 5s, or 2m, or 12h, or 5d...) 12h #for how long should the addon run. Must be formatted as number + time
unit (ex : 5s, or 2m, or 12h, or 5d...)
silent: silent:
name: silent name: silent
description: >- description: "true #suppresses debug messages"
true #suppresses debug messages
ssl: ssl:
name: ssl name: ssl
description: >- description: "true/false : enables ssl. Need certfile and keyfile filled"
true/false : enables ssl. Need certfile and keyfile filled
certfile: certfile:
name: certfile name: certfile
description: >- description: "fullchain.pem #ssl certificate, must be located in /ssl"
fullchain.pem #ssl certificate, must be located in /ssl
keyfile: keyfile:
name: keyfile name: keyfile
description: >- description: "privkey.pem #sslkeyfile, must be located in /ssl"
privkey.pem #sslkeyfile, must be located in /ssl
whitelist: whitelist:
name: whitelist name: whitelist
description: >- description: '"localhost,192.168.0.0/16" # list ip subnets that won''t need a password'
"localhost,192.168.0.0/16" # list ip subnets that won't need a password
customUI: customUI:
name: customUI name: customUI
description: >- description: >-
selection from list # alternative webUI can be set here. Latest version set at each addon start selection from list # alternative webUI can be set here. Latest version
set at each addon start
DNS_servers: DNS_servers:
name: DNS_servers name: DNS_servers
description: >- description: >-
8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to avoid spamming in case of local DNS ad-remover 8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to
avoid spamming in case of local DNS ad-remover
openvpn_alt_mode: openvpn_alt_mode:
name: openvpn_alt_mode name: openvpn_alt_mode
description: >- description: bind at container level and not app level
bind at container level and not app level
openvpn_config: openvpn_config:
name: openvpn_config name: openvpn_config
description: >- description: 'for example "config.ovpn" # name of the file located in /config/openvpn'
for example "config.ovpn" # name of the file located in /config/openvpn

View File

@@ -3,108 +3,95 @@ configuration:
PGID: PGID:
name: PGID name: PGID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
PUID: PUID:
name: PUID name: PUID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
TZ: TZ:
name: TZ name: TZ
description: >- description: >-
The timezone, as described in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones The timezone, as described in
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
cifspassword: cifspassword:
name: cifspassword name: cifspassword
description: >- description: "Your password to access your SMB share, same for all smb shares"
Your password to access your SMB share, same for all smb shares
cifsusername: cifsusername:
name: cifsusername name: cifsusername
description: >- description: "Your username to access your SMB share, same for all smb shares"
Your username to access your SMB share, same for all smb shares
cifsdomain: cifsdomain:
name: cifsdomain name: cifsdomain
description: >- description: Allow setting the domain for the smb share
Allow setting the domain for the smb share
database: database:
name: database name: database
description: >- description: Type of database to use
Type of database to use
data_location: data_location:
name: data_location name: data_location
description: >- description: Where do you want your data stored
Where do you want your data stored
localdisks: localdisks:
name: localdisks name: localdisks
description: >- description: >-
Physical name of the partition (ex. sda1) or the share (ex. SharedFiles) to mount separated by commas (ex: sda1,sdb1,MYNAS) Physical name of the partition (ex. sda1) or the share (ex. SharedFiles)
to mount separated by commas (ex: sda1,sdb1,MYNAS)
networkdisks: networkdisks:
name: networkdisks name: networkdisks
description: >- description: "list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)"
list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)
DB_HOSTNAME: DB_HOSTNAME:
name: DB_HOSTNAME name: DB_HOSTNAME
description: >- description: If using external postgresql
If using external postgresql
DB_USERNAME: DB_USERNAME:
name: DB_USERNAME name: DB_USERNAME
description: >- description: If using external postgresql
If using external postgresql
DB_PORT: DB_PORT:
name: DB_PORT name: DB_PORT
description: >- description: If using external postgresql
If using external postgresql
DB_PASSWORD: DB_PASSWORD:
name: DB_PASSWORD name: DB_PASSWORD
description: >- description: If using external postgresql
If using external postgresql
DB_DATABASE_NAME: DB_DATABASE_NAME:
name: DB_DATABASE_NAME name: DB_DATABASE_NAME
description: >- description: If using external postgresql
If using external postgresql
UPLOAD_LOCATION: UPLOAD_LOCATION:
name: UPLOAD_LOCATION name: UPLOAD_LOCATION
description: >- description: This is the location where uploaded files are stored
This is the location where uploaded files are stored
JWT_SECRET: JWT_SECRET:
name: JWT_SECRET name: JWT_SECRET
description: >- description: Used to sign the authentication keys for user login
Used to sign the authentication keys for user login
run_duration: run_duration:
name: run_duration name: run_duration
description: >- description: >-
12h #for how long should the addon run. Must be formatted as number + time unit (ex : 5s, or 2m, or 12h, or 5d...) 12h #for how long should the addon run. Must be formatted as number + time
unit (ex : 5s, or 2m, or 12h, or 5d...)
silent: silent:
name: silent name: silent
description: >- description: "true #suppresses debug messages"
true #suppresses debug messages
ssl: ssl:
name: ssl name: ssl
description: >- description: "true/false : enables ssl. Need certfile and keyfile filled"
true/false : enables ssl. Need certfile and keyfile filled
certfile: certfile:
name: certfile name: certfile
description: >- description: "fullchain.pem #ssl certificate, must be located in /ssl"
fullchain.pem #ssl certificate, must be located in /ssl
keyfile: keyfile:
name: keyfile name: keyfile
description: >- description: "privkey.pem #sslkeyfile, must be located in /ssl"
privkey.pem #sslkeyfile, must be located in /ssl
whitelist: whitelist:
name: whitelist name: whitelist
description: >- description: '"localhost,192.168.0.0/16" # list ip subnets that won''t need a password'
"localhost,192.168.0.0/16" # list ip subnets that won't need a password
customUI: customUI:
name: customUI name: customUI
description: >- description: >-
selection from list # alternative webUI can be set here. Latest version set at each addon start selection from list # alternative webUI can be set here. Latest version
set at each addon start
DNS_servers: DNS_servers:
name: DNS_servers name: DNS_servers
description: >- description: >-
8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to avoid spamming in case of local DNS ad-remover 8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to
avoid spamming in case of local DNS ad-remover
openvpn_alt_mode: openvpn_alt_mode:
name: openvpn_alt_mode name: openvpn_alt_mode
description: >- description: bind at container level and not app level
bind at container level and not app level
openvpn_config: openvpn_config:
name: openvpn_config name: openvpn_config
description: >- description: 'for example "config.ovpn" # name of the file located in /config/openvpn'
for example "config.ovpn" # name of the file located in /config/openvpn

View File

@@ -3,108 +3,95 @@ configuration:
PGID: PGID:
name: PGID name: PGID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
PUID: PUID:
name: PUID name: PUID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
TZ: TZ:
name: TZ name: TZ
description: >- description: >-
The timezone, as described in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones The timezone, as described in
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
cifspassword: cifspassword:
name: cifspassword name: cifspassword
description: >- description: "Your password to access your SMB share, same for all smb shares"
Your password to access your SMB share, same for all smb shares
cifsusername: cifsusername:
name: cifsusername name: cifsusername
description: >- description: "Your username to access your SMB share, same for all smb shares"
Your username to access your SMB share, same for all smb shares
cifsdomain: cifsdomain:
name: cifsdomain name: cifsdomain
description: >- description: Allow setting the domain for the smb share
Allow setting the domain for the smb share
database: database:
name: database name: database
description: >- description: Type of database to use
Type of database to use
data_location: data_location:
name: data_location name: data_location
description: >- description: Where do you want your data stored
Where do you want your data stored
localdisks: localdisks:
name: localdisks name: localdisks
description: >- description: >-
Physical name of the partition (ex. sda1) or the share (ex. SharedFiles) to mount separated by commas (ex: sda1,sdb1,MYNAS) Physical name of the partition (ex. sda1) or the share (ex. SharedFiles)
to mount separated by commas (ex: sda1,sdb1,MYNAS)
networkdisks: networkdisks:
name: networkdisks name: networkdisks
description: >- description: "list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)"
list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)
DB_HOSTNAME: DB_HOSTNAME:
name: DB_HOSTNAME name: DB_HOSTNAME
description: >- description: If using external postgresql
If using external postgresql
DB_USERNAME: DB_USERNAME:
name: DB_USERNAME name: DB_USERNAME
description: >- description: If using external postgresql
If using external postgresql
DB_PORT: DB_PORT:
name: DB_PORT name: DB_PORT
description: >- description: If using external postgresql
If using external postgresql
DB_PASSWORD: DB_PASSWORD:
name: DB_PASSWORD name: DB_PASSWORD
description: >- description: If using external postgresql
If using external postgresql
DB_DATABASE_NAME: DB_DATABASE_NAME:
name: DB_DATABASE_NAME name: DB_DATABASE_NAME
description: >- description: If using external postgresql
If using external postgresql
UPLOAD_LOCATION: UPLOAD_LOCATION:
name: UPLOAD_LOCATION name: UPLOAD_LOCATION
description: >- description: This is the location where uploaded files are stored
This is the location where uploaded files are stored
JWT_SECRET: JWT_SECRET:
name: JWT_SECRET name: JWT_SECRET
description: >- description: Used to sign the authentication keys for user login
Used to sign the authentication keys for user login
run_duration: run_duration:
name: run_duration name: run_duration
description: >- description: >-
12h #for how long should the addon run. Must be formatted as number + time unit (ex : 5s, or 2m, or 12h, or 5d...) 12h #for how long should the addon run. Must be formatted as number + time
unit (ex : 5s, or 2m, or 12h, or 5d...)
silent: silent:
name: silent name: silent
description: >- description: "true #suppresses debug messages"
true #suppresses debug messages
ssl: ssl:
name: ssl name: ssl
description: >- description: "true/false : enables ssl. Need certfile and keyfile filled"
true/false : enables ssl. Need certfile and keyfile filled
certfile: certfile:
name: certfile name: certfile
description: >- description: "fullchain.pem #ssl certificate, must be located in /ssl"
fullchain.pem #ssl certificate, must be located in /ssl
keyfile: keyfile:
name: keyfile name: keyfile
description: >- description: "privkey.pem #sslkeyfile, must be located in /ssl"
privkey.pem #sslkeyfile, must be located in /ssl
whitelist: whitelist:
name: whitelist name: whitelist
description: >- description: '"localhost,192.168.0.0/16" # list ip subnets that won''t need a password'
"localhost,192.168.0.0/16" # list ip subnets that won't need a password
customUI: customUI:
name: customUI name: customUI
description: >- description: >-
selection from list # alternative webUI can be set here. Latest version set at each addon start selection from list # alternative webUI can be set here. Latest version
set at each addon start
DNS_servers: DNS_servers:
name: DNS_servers name: DNS_servers
description: >- description: >-
8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to avoid spamming in case of local DNS ad-remover 8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to
avoid spamming in case of local DNS ad-remover
openvpn_alt_mode: openvpn_alt_mode:
name: openvpn_alt_mode name: openvpn_alt_mode
description: >- description: bind at container level and not app level
bind at container level and not app level
openvpn_config: openvpn_config:
name: openvpn_config name: openvpn_config
description: >- description: 'for example "config.ovpn" # name of the file located in /config/openvpn'
for example "config.ovpn" # name of the file located in /config/openvpn

View File

@@ -3,108 +3,95 @@ configuration:
PGID: PGID:
name: PGID name: PGID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
PUID: PUID:
name: PUID name: PUID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
TZ: TZ:
name: TZ name: TZ
description: >- description: >-
The timezone, as described in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones The timezone, as described in
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
cifspassword: cifspassword:
name: cifspassword name: cifspassword
description: >- description: "Your password to access your SMB share, same for all smb shares"
Your password to access your SMB share, same for all smb shares
cifsusername: cifsusername:
name: cifsusername name: cifsusername
description: >- description: "Your username to access your SMB share, same for all smb shares"
Your username to access your SMB share, same for all smb shares
cifsdomain: cifsdomain:
name: cifsdomain name: cifsdomain
description: >- description: Allow setting the domain for the smb share
Allow setting the domain for the smb share
database: database:
name: database name: database
description: >- description: Type of database to use
Type of database to use
data_location: data_location:
name: data_location name: data_location
description: >- description: Where do you want your data stored
Where do you want your data stored
localdisks: localdisks:
name: localdisks name: localdisks
description: >- description: >-
Physical name of the partition (ex. sda1) or the share (ex. SharedFiles) to mount separated by commas (ex: sda1,sdb1,MYNAS) Physical name of the partition (ex. sda1) or the share (ex. SharedFiles)
to mount separated by commas (ex: sda1,sdb1,MYNAS)
networkdisks: networkdisks:
name: networkdisks name: networkdisks
description: >- description: "list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)"
list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)
DB_HOSTNAME: DB_HOSTNAME:
name: DB_HOSTNAME name: DB_HOSTNAME
description: >- description: If using external postgresql
If using external postgresql
DB_USERNAME: DB_USERNAME:
name: DB_USERNAME name: DB_USERNAME
description: >- description: If using external postgresql
If using external postgresql
DB_PORT: DB_PORT:
name: DB_PORT name: DB_PORT
description: >- description: If using external postgresql
If using external postgresql
DB_PASSWORD: DB_PASSWORD:
name: DB_PASSWORD name: DB_PASSWORD
description: >- description: If using external postgresql
If using external postgresql
DB_DATABASE_NAME: DB_DATABASE_NAME:
name: DB_DATABASE_NAME name: DB_DATABASE_NAME
description: >- description: If using external postgresql
If using external postgresql
UPLOAD_LOCATION: UPLOAD_LOCATION:
name: UPLOAD_LOCATION name: UPLOAD_LOCATION
description: >- description: This is the location where uploaded files are stored
This is the location where uploaded files are stored
JWT_SECRET: JWT_SECRET:
name: JWT_SECRET name: JWT_SECRET
description: >- description: Used to sign the authentication keys for user login
Used to sign the authentication keys for user login
run_duration: run_duration:
name: run_duration name: run_duration
description: >- description: >-
12h #for how long should the addon run. Must be formatted as number + time unit (ex : 5s, or 2m, or 12h, or 5d...) 12h #for how long should the addon run. Must be formatted as number + time
unit (ex : 5s, or 2m, or 12h, or 5d...)
silent: silent:
name: silent name: silent
description: >- description: "true #suppresses debug messages"
true #suppresses debug messages
ssl: ssl:
name: ssl name: ssl
description: >- description: "true/false : enables ssl. Need certfile and keyfile filled"
true/false : enables ssl. Need certfile and keyfile filled
certfile: certfile:
name: certfile name: certfile
description: >- description: "fullchain.pem #ssl certificate, must be located in /ssl"
fullchain.pem #ssl certificate, must be located in /ssl
keyfile: keyfile:
name: keyfile name: keyfile
description: >- description: "privkey.pem #sslkeyfile, must be located in /ssl"
privkey.pem #sslkeyfile, must be located in /ssl
whitelist: whitelist:
name: whitelist name: whitelist
description: >- description: '"localhost,192.168.0.0/16" # list ip subnets that won''t need a password'
"localhost,192.168.0.0/16" # list ip subnets that won't need a password
customUI: customUI:
name: customUI name: customUI
description: >- description: >-
selection from list # alternative webUI can be set here. Latest version set at each addon start selection from list # alternative webUI can be set here. Latest version
set at each addon start
DNS_servers: DNS_servers:
name: DNS_servers name: DNS_servers
description: >- description: >-
8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to avoid spamming in case of local DNS ad-remover 8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to
avoid spamming in case of local DNS ad-remover
openvpn_alt_mode: openvpn_alt_mode:
name: openvpn_alt_mode name: openvpn_alt_mode
description: >- description: bind at container level and not app level
bind at container level and not app level
openvpn_config: openvpn_config:
name: openvpn_config name: openvpn_config
description: >- description: 'for example "config.ovpn" # name of the file located in /config/openvpn'
for example "config.ovpn" # name of the file located in /config/openvpn

View File

@@ -3,108 +3,95 @@ configuration:
PGID: PGID:
name: PGID name: PGID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
PUID: PUID:
name: PUID name: PUID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
TZ: TZ:
name: TZ name: TZ
description: >- description: >-
The timezone, as described in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones The timezone, as described in
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
cifspassword: cifspassword:
name: cifspassword name: cifspassword
description: >- description: "Your password to access your SMB share, same for all smb shares"
Your password to access your SMB share, same for all smb shares
cifsusername: cifsusername:
name: cifsusername name: cifsusername
description: >- description: "Your username to access your SMB share, same for all smb shares"
Your username to access your SMB share, same for all smb shares
cifsdomain: cifsdomain:
name: cifsdomain name: cifsdomain
description: >- description: Allow setting the domain for the smb share
Allow setting the domain for the smb share
database: database:
name: database name: database
description: >- description: Type of database to use
Type of database to use
data_location: data_location:
name: data_location name: data_location
description: >- description: Where do you want your data stored
Where do you want your data stored
localdisks: localdisks:
name: localdisks name: localdisks
description: >- description: >-
Physical name of the partition (ex. sda1) or the share (ex. SharedFiles) to mount separated by commas (ex: sda1,sdb1,MYNAS) Physical name of the partition (ex. sda1) or the share (ex. SharedFiles)
to mount separated by commas (ex: sda1,sdb1,MYNAS)
networkdisks: networkdisks:
name: networkdisks name: networkdisks
description: >- description: "list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)"
list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)
DB_HOSTNAME: DB_HOSTNAME:
name: DB_HOSTNAME name: DB_HOSTNAME
description: >- description: If using external postgresql
If using external postgresql
DB_USERNAME: DB_USERNAME:
name: DB_USERNAME name: DB_USERNAME
description: >- description: If using external postgresql
If using external postgresql
DB_PORT: DB_PORT:
name: DB_PORT name: DB_PORT
description: >- description: If using external postgresql
If using external postgresql
DB_PASSWORD: DB_PASSWORD:
name: DB_PASSWORD name: DB_PASSWORD
description: >- description: If using external postgresql
If using external postgresql
DB_DATABASE_NAME: DB_DATABASE_NAME:
name: DB_DATABASE_NAME name: DB_DATABASE_NAME
description: >- description: If using external postgresql
If using external postgresql
UPLOAD_LOCATION: UPLOAD_LOCATION:
name: UPLOAD_LOCATION name: UPLOAD_LOCATION
description: >- description: This is the location where uploaded files are stored
This is the location where uploaded files are stored
JWT_SECRET: JWT_SECRET:
name: JWT_SECRET name: JWT_SECRET
description: >- description: Used to sign the authentication keys for user login
Used to sign the authentication keys for user login
run_duration: run_duration:
name: run_duration name: run_duration
description: >- description: >-
12h #for how long should the addon run. Must be formatted as number + time unit (ex : 5s, or 2m, or 12h, or 5d...) 12h #for how long should the addon run. Must be formatted as number + time
unit (ex : 5s, or 2m, or 12h, or 5d...)
silent: silent:
name: silent name: silent
description: >- description: "true #suppresses debug messages"
true #suppresses debug messages
ssl: ssl:
name: ssl name: ssl
description: >- description: "true/false : enables ssl. Need certfile and keyfile filled"
true/false : enables ssl. Need certfile and keyfile filled
certfile: certfile:
name: certfile name: certfile
description: >- description: "fullchain.pem #ssl certificate, must be located in /ssl"
fullchain.pem #ssl certificate, must be located in /ssl
keyfile: keyfile:
name: keyfile name: keyfile
description: >- description: "privkey.pem #sslkeyfile, must be located in /ssl"
privkey.pem #sslkeyfile, must be located in /ssl
whitelist: whitelist:
name: whitelist name: whitelist
description: >- description: '"localhost,192.168.0.0/16" # list ip subnets that won''t need a password'
"localhost,192.168.0.0/16" # list ip subnets that won't need a password
customUI: customUI:
name: customUI name: customUI
description: >- description: >-
selection from list # alternative webUI can be set here. Latest version set at each addon start selection from list # alternative webUI can be set here. Latest version
set at each addon start
DNS_servers: DNS_servers:
name: DNS_servers name: DNS_servers
description: >- description: >-
8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to avoid spamming in case of local DNS ad-remover 8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to
avoid spamming in case of local DNS ad-remover
openvpn_alt_mode: openvpn_alt_mode:
name: openvpn_alt_mode name: openvpn_alt_mode
description: >- description: bind at container level and not app level
bind at container level and not app level
openvpn_config: openvpn_config:
name: openvpn_config name: openvpn_config
description: >- description: 'for example "config.ovpn" # name of the file located in /config/openvpn'
for example "config.ovpn" # name of the file located in /config/openvpn

View File

@@ -3,108 +3,95 @@ configuration:
PGID: PGID:
name: PGID name: PGID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
PUID: PUID:
name: PUID name: PUID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
TZ: TZ:
name: TZ name: TZ
description: >- description: >-
The timezone, as described in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones The timezone, as described in
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
cifspassword: cifspassword:
name: cifspassword name: cifspassword
description: >- description: "Your password to access your SMB share, same for all smb shares"
Your password to access your SMB share, same for all smb shares
cifsusername: cifsusername:
name: cifsusername name: cifsusername
description: >- description: "Your username to access your SMB share, same for all smb shares"
Your username to access your SMB share, same for all smb shares
cifsdomain: cifsdomain:
name: cifsdomain name: cifsdomain
description: >- description: Allow setting the domain for the smb share
Allow setting the domain for the smb share
database: database:
name: database name: database
description: >- description: Type of database to use
Type of database to use
data_location: data_location:
name: data_location name: data_location
description: >- description: Where do you want your data stored
Where do you want your data stored
localdisks: localdisks:
name: localdisks name: localdisks
description: >- description: >-
Physical name of the partition (ex. sda1) or the share (ex. SharedFiles) to mount separated by commas (ex: sda1,sdb1,MYNAS) Physical name of the partition (ex. sda1) or the share (ex. SharedFiles)
to mount separated by commas (ex: sda1,sdb1,MYNAS)
networkdisks: networkdisks:
name: networkdisks name: networkdisks
description: >- description: "list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)"
list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)
DB_HOSTNAME: DB_HOSTNAME:
name: DB_HOSTNAME name: DB_HOSTNAME
description: >- description: If using external postgresql
If using external postgresql
DB_USERNAME: DB_USERNAME:
name: DB_USERNAME name: DB_USERNAME
description: >- description: If using external postgresql
If using external postgresql
DB_PORT: DB_PORT:
name: DB_PORT name: DB_PORT
description: >- description: If using external postgresql
If using external postgresql
DB_PASSWORD: DB_PASSWORD:
name: DB_PASSWORD name: DB_PASSWORD
description: >- description: If using external postgresql
If using external postgresql
DB_DATABASE_NAME: DB_DATABASE_NAME:
name: DB_DATABASE_NAME name: DB_DATABASE_NAME
description: >- description: If using external postgresql
If using external postgresql
UPLOAD_LOCATION: UPLOAD_LOCATION:
name: UPLOAD_LOCATION name: UPLOAD_LOCATION
description: >- description: This is the location where uploaded files are stored
This is the location where uploaded files are stored
JWT_SECRET: JWT_SECRET:
name: JWT_SECRET name: JWT_SECRET
description: >- description: Used to sign the authentication keys for user login
Used to sign the authentication keys for user login
run_duration: run_duration:
name: run_duration name: run_duration
description: >- description: >-
12h #for how long should the addon run. Must be formatted as number + time unit (ex : 5s, or 2m, or 12h, or 5d...) 12h #for how long should the addon run. Must be formatted as number + time
unit (ex : 5s, or 2m, or 12h, or 5d...)
silent: silent:
name: silent name: silent
description: >- description: "true #suppresses debug messages"
true #suppresses debug messages
ssl: ssl:
name: ssl name: ssl
description: >- description: "true/false : enables ssl. Need certfile and keyfile filled"
true/false : enables ssl. Need certfile and keyfile filled
certfile: certfile:
name: certfile name: certfile
description: >- description: "fullchain.pem #ssl certificate, must be located in /ssl"
fullchain.pem #ssl certificate, must be located in /ssl
keyfile: keyfile:
name: keyfile name: keyfile
description: >- description: "privkey.pem #sslkeyfile, must be located in /ssl"
privkey.pem #sslkeyfile, must be located in /ssl
whitelist: whitelist:
name: whitelist name: whitelist
description: >- description: '"localhost,192.168.0.0/16" # list ip subnets that won''t need a password'
"localhost,192.168.0.0/16" # list ip subnets that won't need a password
customUI: customUI:
name: customUI name: customUI
description: >- description: >-
selection from list # alternative webUI can be set here. Latest version set at each addon start selection from list # alternative webUI can be set here. Latest version
set at each addon start
DNS_servers: DNS_servers:
name: DNS_servers name: DNS_servers
description: >- description: >-
8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to avoid spamming in case of local DNS ad-remover 8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to
avoid spamming in case of local DNS ad-remover
openvpn_alt_mode: openvpn_alt_mode:
name: openvpn_alt_mode name: openvpn_alt_mode
description: >- description: bind at container level and not app level
bind at container level and not app level
openvpn_config: openvpn_config:
name: openvpn_config name: openvpn_config
description: >- description: 'for example "config.ovpn" # name of the file located in /config/openvpn'
for example "config.ovpn" # name of the file located in /config/openvpn

View File

@@ -3,108 +3,95 @@ configuration:
PGID: PGID:
name: PGID name: PGID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
PUID: PUID:
name: PUID name: PUID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
TZ: TZ:
name: TZ name: TZ
description: >- description: >-
The timezone, as described in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones The timezone, as described in
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
cifspassword: cifspassword:
name: cifspassword name: cifspassword
description: >- description: "Your password to access your SMB share, same for all smb shares"
Your password to access your SMB share, same for all smb shares
cifsusername: cifsusername:
name: cifsusername name: cifsusername
description: >- description: "Your username to access your SMB share, same for all smb shares"
Your username to access your SMB share, same for all smb shares
cifsdomain: cifsdomain:
name: cifsdomain name: cifsdomain
description: >- description: Allow setting the domain for the smb share
Allow setting the domain for the smb share
database: database:
name: database name: database
description: >- description: Type of database to use
Type of database to use
data_location: data_location:
name: data_location name: data_location
description: >- description: Where do you want your data stored
Where do you want your data stored
localdisks: localdisks:
name: localdisks name: localdisks
description: >- description: >-
Physical name of the partition (ex. sda1) or the share (ex. SharedFiles) to mount separated by commas (ex: sda1,sdb1,MYNAS) Physical name of the partition (ex. sda1) or the share (ex. SharedFiles)
to mount separated by commas (ex: sda1,sdb1,MYNAS)
networkdisks: networkdisks:
name: networkdisks name: networkdisks
description: >- description: "list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)"
list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)
DB_HOSTNAME: DB_HOSTNAME:
name: DB_HOSTNAME name: DB_HOSTNAME
description: >- description: If using external postgresql
If using external postgresql
DB_USERNAME: DB_USERNAME:
name: DB_USERNAME name: DB_USERNAME
description: >- description: If using external postgresql
If using external postgresql
DB_PORT: DB_PORT:
name: DB_PORT name: DB_PORT
description: >- description: If using external postgresql
If using external postgresql
DB_PASSWORD: DB_PASSWORD:
name: DB_PASSWORD name: DB_PASSWORD
description: >- description: If using external postgresql
If using external postgresql
DB_DATABASE_NAME: DB_DATABASE_NAME:
name: DB_DATABASE_NAME name: DB_DATABASE_NAME
description: >- description: If using external postgresql
If using external postgresql
UPLOAD_LOCATION: UPLOAD_LOCATION:
name: UPLOAD_LOCATION name: UPLOAD_LOCATION
description: >- description: This is the location where uploaded files are stored
This is the location where uploaded files are stored
JWT_SECRET: JWT_SECRET:
name: JWT_SECRET name: JWT_SECRET
description: >- description: Used to sign the authentication keys for user login
Used to sign the authentication keys for user login
run_duration: run_duration:
name: run_duration name: run_duration
description: >- description: >-
12h #for how long should the addon run. Must be formatted as number + time unit (ex : 5s, or 2m, or 12h, or 5d...) 12h #for how long should the addon run. Must be formatted as number + time
unit (ex : 5s, or 2m, or 12h, or 5d...)
silent: silent:
name: silent name: silent
description: >- description: "true #suppresses debug messages"
true #suppresses debug messages
ssl: ssl:
name: ssl name: ssl
description: >- description: "true/false : enables ssl. Need certfile and keyfile filled"
true/false : enables ssl. Need certfile and keyfile filled
certfile: certfile:
name: certfile name: certfile
description: >- description: "fullchain.pem #ssl certificate, must be located in /ssl"
fullchain.pem #ssl certificate, must be located in /ssl
keyfile: keyfile:
name: keyfile name: keyfile
description: >- description: "privkey.pem #sslkeyfile, must be located in /ssl"
privkey.pem #sslkeyfile, must be located in /ssl
whitelist: whitelist:
name: whitelist name: whitelist
description: >- description: '"localhost,192.168.0.0/16" # list ip subnets that won''t need a password'
"localhost,192.168.0.0/16" # list ip subnets that won't need a password
customUI: customUI:
name: customUI name: customUI
description: >- description: >-
selection from list # alternative webUI can be set here. Latest version set at each addon start selection from list # alternative webUI can be set here. Latest version
set at each addon start
DNS_servers: DNS_servers:
name: DNS_servers name: DNS_servers
description: >- description: >-
8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to avoid spamming in case of local DNS ad-remover 8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to
avoid spamming in case of local DNS ad-remover
openvpn_alt_mode: openvpn_alt_mode:
name: openvpn_alt_mode name: openvpn_alt_mode
description: >- description: bind at container level and not app level
bind at container level and not app level
openvpn_config: openvpn_config:
name: openvpn_config name: openvpn_config
description: >- description: 'for example "config.ovpn" # name of the file located in /config/openvpn'
for example "config.ovpn" # name of the file located in /config/openvpn

View File

@@ -3,108 +3,95 @@ configuration:
PGID: PGID:
name: PGID name: PGID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
PUID: PUID:
name: PUID name: PUID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
TZ: TZ:
name: TZ name: TZ
description: >- description: >-
The timezone, as described in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones The timezone, as described in
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
cifspassword: cifspassword:
name: cifspassword name: cifspassword
description: >- description: "Your password to access your SMB share, same for all smb shares"
Your password to access your SMB share, same for all smb shares
cifsusername: cifsusername:
name: cifsusername name: cifsusername
description: >- description: "Your username to access your SMB share, same for all smb shares"
Your username to access your SMB share, same for all smb shares
cifsdomain: cifsdomain:
name: cifsdomain name: cifsdomain
description: >- description: Allow setting the domain for the smb share
Allow setting the domain for the smb share
database: database:
name: database name: database
description: >- description: Type of database to use
Type of database to use
data_location: data_location:
name: data_location name: data_location
description: >- description: Where do you want your data stored
Where do you want your data stored
localdisks: localdisks:
name: localdisks name: localdisks
description: >- description: >-
Physical name of the partition (ex. sda1) or the share (ex. SharedFiles) to mount separated by commas (ex: sda1,sdb1,MYNAS) Physical name of the partition (ex. sda1) or the share (ex. SharedFiles)
to mount separated by commas (ex: sda1,sdb1,MYNAS)
networkdisks: networkdisks:
name: networkdisks name: networkdisks
description: >- description: "list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)"
list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)
DB_HOSTNAME: DB_HOSTNAME:
name: DB_HOSTNAME name: DB_HOSTNAME
description: >- description: If using external postgresql
If using external postgresql
DB_USERNAME: DB_USERNAME:
name: DB_USERNAME name: DB_USERNAME
description: >- description: If using external postgresql
If using external postgresql
DB_PORT: DB_PORT:
name: DB_PORT name: DB_PORT
description: >- description: If using external postgresql
If using external postgresql
DB_PASSWORD: DB_PASSWORD:
name: DB_PASSWORD name: DB_PASSWORD
description: >- description: If using external postgresql
If using external postgresql
DB_DATABASE_NAME: DB_DATABASE_NAME:
name: DB_DATABASE_NAME name: DB_DATABASE_NAME
description: >- description: If using external postgresql
If using external postgresql
UPLOAD_LOCATION: UPLOAD_LOCATION:
name: UPLOAD_LOCATION name: UPLOAD_LOCATION
description: >- description: This is the location where uploaded files are stored
This is the location where uploaded files are stored
JWT_SECRET: JWT_SECRET:
name: JWT_SECRET name: JWT_SECRET
description: >- description: Used to sign the authentication keys for user login
Used to sign the authentication keys for user login
run_duration: run_duration:
name: run_duration name: run_duration
description: >- description: >-
12h #for how long should the addon run. Must be formatted as number + time unit (ex : 5s, or 2m, or 12h, or 5d...) 12h #for how long should the addon run. Must be formatted as number + time
unit (ex : 5s, or 2m, or 12h, or 5d...)
silent: silent:
name: silent name: silent
description: >- description: "true #suppresses debug messages"
true #suppresses debug messages
ssl: ssl:
name: ssl name: ssl
description: >- description: "true/false : enables ssl. Need certfile and keyfile filled"
true/false : enables ssl. Need certfile and keyfile filled
certfile: certfile:
name: certfile name: certfile
description: >- description: "fullchain.pem #ssl certificate, must be located in /ssl"
fullchain.pem #ssl certificate, must be located in /ssl
keyfile: keyfile:
name: keyfile name: keyfile
description: >- description: "privkey.pem #sslkeyfile, must be located in /ssl"
privkey.pem #sslkeyfile, must be located in /ssl
whitelist: whitelist:
name: whitelist name: whitelist
description: >- description: '"localhost,192.168.0.0/16" # list ip subnets that won''t need a password'
"localhost,192.168.0.0/16" # list ip subnets that won't need a password
customUI: customUI:
name: customUI name: customUI
description: >- description: >-
selection from list # alternative webUI can be set here. Latest version set at each addon start selection from list # alternative webUI can be set here. Latest version
set at each addon start
DNS_servers: DNS_servers:
name: DNS_servers name: DNS_servers
description: >- description: >-
8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to avoid spamming in case of local DNS ad-remover 8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to
avoid spamming in case of local DNS ad-remover
openvpn_alt_mode: openvpn_alt_mode:
name: openvpn_alt_mode name: openvpn_alt_mode
description: >- description: bind at container level and not app level
bind at container level and not app level
openvpn_config: openvpn_config:
name: openvpn_config name: openvpn_config
description: >- description: 'for example "config.ovpn" # name of the file located in /config/openvpn'
for example "config.ovpn" # name of the file located in /config/openvpn

View File

@@ -3,108 +3,95 @@ configuration:
PGID: PGID:
name: PGID name: PGID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
PUID: PUID:
name: PUID name: PUID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
TZ: TZ:
name: TZ name: TZ
description: >- description: >-
The timezone, as described in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones The timezone, as described in
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
cifspassword: cifspassword:
name: cifspassword name: cifspassword
description: >- description: "Your password to access your SMB share, same for all smb shares"
Your password to access your SMB share, same for all smb shares
cifsusername: cifsusername:
name: cifsusername name: cifsusername
description: >- description: "Your username to access your SMB share, same for all smb shares"
Your username to access your SMB share, same for all smb shares
cifsdomain: cifsdomain:
name: cifsdomain name: cifsdomain
description: >- description: Allow setting the domain for the smb share
Allow setting the domain for the smb share
database: database:
name: database name: database
description: >- description: Type of database to use
Type of database to use
data_location: data_location:
name: data_location name: data_location
description: >- description: Where do you want your data stored
Where do you want your data stored
localdisks: localdisks:
name: localdisks name: localdisks
description: >- description: >-
Physical name of the partition (ex. sda1) or the share (ex. SharedFiles) to mount separated by commas (ex: sda1,sdb1,MYNAS) Physical name of the partition (ex. sda1) or the share (ex. SharedFiles)
to mount separated by commas (ex: sda1,sdb1,MYNAS)
networkdisks: networkdisks:
name: networkdisks name: networkdisks
description: >- description: "list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)"
list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)
DB_HOSTNAME: DB_HOSTNAME:
name: DB_HOSTNAME name: DB_HOSTNAME
description: >- description: If using external postgresql
If using external postgresql
DB_USERNAME: DB_USERNAME:
name: DB_USERNAME name: DB_USERNAME
description: >- description: If using external postgresql
If using external postgresql
DB_PORT: DB_PORT:
name: DB_PORT name: DB_PORT
description: >- description: If using external postgresql
If using external postgresql
DB_PASSWORD: DB_PASSWORD:
name: DB_PASSWORD name: DB_PASSWORD
description: >- description: If using external postgresql
If using external postgresql
DB_DATABASE_NAME: DB_DATABASE_NAME:
name: DB_DATABASE_NAME name: DB_DATABASE_NAME
description: >- description: If using external postgresql
If using external postgresql
UPLOAD_LOCATION: UPLOAD_LOCATION:
name: UPLOAD_LOCATION name: UPLOAD_LOCATION
description: >- description: This is the location where uploaded files are stored
This is the location where uploaded files are stored
JWT_SECRET: JWT_SECRET:
name: JWT_SECRET name: JWT_SECRET
description: >- description: Used to sign the authentication keys for user login
Used to sign the authentication keys for user login
run_duration: run_duration:
name: run_duration name: run_duration
description: >- description: >-
12h #for how long should the addon run. Must be formatted as number + time unit (ex : 5s, or 2m, or 12h, or 5d...) 12h #for how long should the addon run. Must be formatted as number + time
unit (ex : 5s, or 2m, or 12h, or 5d...)
silent: silent:
name: silent name: silent
description: >- description: "true #suppresses debug messages"
true #suppresses debug messages
ssl: ssl:
name: ssl name: ssl
description: >- description: "true/false : enables ssl. Need certfile and keyfile filled"
true/false : enables ssl. Need certfile and keyfile filled
certfile: certfile:
name: certfile name: certfile
description: >- description: "fullchain.pem #ssl certificate, must be located in /ssl"
fullchain.pem #ssl certificate, must be located in /ssl
keyfile: keyfile:
name: keyfile name: keyfile
description: >- description: "privkey.pem #sslkeyfile, must be located in /ssl"
privkey.pem #sslkeyfile, must be located in /ssl
whitelist: whitelist:
name: whitelist name: whitelist
description: >- description: '"localhost,192.168.0.0/16" # list ip subnets that won''t need a password'
"localhost,192.168.0.0/16" # list ip subnets that won't need a password
customUI: customUI:
name: customUI name: customUI
description: >- description: >-
selection from list # alternative webUI can be set here. Latest version set at each addon start selection from list # alternative webUI can be set here. Latest version
set at each addon start
DNS_servers: DNS_servers:
name: DNS_servers name: DNS_servers
description: >- description: >-
8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to avoid spamming in case of local DNS ad-remover 8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to
avoid spamming in case of local DNS ad-remover
openvpn_alt_mode: openvpn_alt_mode:
name: openvpn_alt_mode name: openvpn_alt_mode
description: >- description: bind at container level and not app level
bind at container level and not app level
openvpn_config: openvpn_config:
name: openvpn_config name: openvpn_config
description: >- description: 'for example "config.ovpn" # name of the file located in /config/openvpn'
for example "config.ovpn" # name of the file located in /config/openvpn

View File

@@ -3,108 +3,95 @@ configuration:
PGID: PGID:
name: PGID name: PGID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
PUID: PUID:
name: PUID name: PUID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
TZ: TZ:
name: TZ name: TZ
description: >- description: >-
The timezone, as described in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones The timezone, as described in
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
cifspassword: cifspassword:
name: cifspassword name: cifspassword
description: >- description: "Your password to access your SMB share, same for all smb shares"
Your password to access your SMB share, same for all smb shares
cifsusername: cifsusername:
name: cifsusername name: cifsusername
description: >- description: "Your username to access your SMB share, same for all smb shares"
Your username to access your SMB share, same for all smb shares
cifsdomain: cifsdomain:
name: cifsdomain name: cifsdomain
description: >- description: Allow setting the domain for the smb share
Allow setting the domain for the smb share
database: database:
name: database name: database
description: >- description: Type of database to use
Type of database to use
data_location: data_location:
name: data_location name: data_location
description: >- description: Where do you want your data stored
Where do you want your data stored
localdisks: localdisks:
name: localdisks name: localdisks
description: >- description: >-
Physical name of the partition (ex. sda1) or the share (ex. SharedFiles) to mount separated by commas (ex: sda1,sdb1,MYNAS) Physical name of the partition (ex. sda1) or the share (ex. SharedFiles)
to mount separated by commas (ex: sda1,sdb1,MYNAS)
networkdisks: networkdisks:
name: networkdisks name: networkdisks
description: >- description: "list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)"
list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)
DB_HOSTNAME: DB_HOSTNAME:
name: DB_HOSTNAME name: DB_HOSTNAME
description: >- description: If using external postgresql
If using external postgresql
DB_USERNAME: DB_USERNAME:
name: DB_USERNAME name: DB_USERNAME
description: >- description: If using external postgresql
If using external postgresql
DB_PORT: DB_PORT:
name: DB_PORT name: DB_PORT
description: >- description: If using external postgresql
If using external postgresql
DB_PASSWORD: DB_PASSWORD:
name: DB_PASSWORD name: DB_PASSWORD
description: >- description: If using external postgresql
If using external postgresql
DB_DATABASE_NAME: DB_DATABASE_NAME:
name: DB_DATABASE_NAME name: DB_DATABASE_NAME
description: >- description: If using external postgresql
If using external postgresql
UPLOAD_LOCATION: UPLOAD_LOCATION:
name: UPLOAD_LOCATION name: UPLOAD_LOCATION
description: >- description: This is the location where uploaded files are stored
This is the location where uploaded files are stored
JWT_SECRET: JWT_SECRET:
name: JWT_SECRET name: JWT_SECRET
description: >- description: Used to sign the authentication keys for user login
Used to sign the authentication keys for user login
run_duration: run_duration:
name: run_duration name: run_duration
description: >- description: >-
12h #for how long should the addon run. Must be formatted as number + time unit (ex : 5s, or 2m, or 12h, or 5d...) 12h #for how long should the addon run. Must be formatted as number + time
unit (ex : 5s, or 2m, or 12h, or 5d...)
silent: silent:
name: silent name: silent
description: >- description: "true #suppresses debug messages"
true #suppresses debug messages
ssl: ssl:
name: ssl name: ssl
description: >- description: "true/false : enables ssl. Need certfile and keyfile filled"
true/false : enables ssl. Need certfile and keyfile filled
certfile: certfile:
name: certfile name: certfile
description: >- description: "fullchain.pem #ssl certificate, must be located in /ssl"
fullchain.pem #ssl certificate, must be located in /ssl
keyfile: keyfile:
name: keyfile name: keyfile
description: >- description: "privkey.pem #sslkeyfile, must be located in /ssl"
privkey.pem #sslkeyfile, must be located in /ssl
whitelist: whitelist:
name: whitelist name: whitelist
description: >- description: '"localhost,192.168.0.0/16" # list ip subnets that won''t need a password'
"localhost,192.168.0.0/16" # list ip subnets that won't need a password
customUI: customUI:
name: customUI name: customUI
description: >- description: >-
selection from list # alternative webUI can be set here. Latest version set at each addon start selection from list # alternative webUI can be set here. Latest version
set at each addon start
DNS_servers: DNS_servers:
name: DNS_servers name: DNS_servers
description: >- description: >-
8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to avoid spamming in case of local DNS ad-remover 8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to
avoid spamming in case of local DNS ad-remover
openvpn_alt_mode: openvpn_alt_mode:
name: openvpn_alt_mode name: openvpn_alt_mode
description: >- description: bind at container level and not app level
bind at container level and not app level
openvpn_config: openvpn_config:
name: openvpn_config name: openvpn_config
description: >- description: 'for example "config.ovpn" # name of the file located in /config/openvpn'
for example "config.ovpn" # name of the file located in /config/openvpn

View File

@@ -3,108 +3,95 @@ configuration:
PGID: PGID:
name: PGID name: PGID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
PUID: PUID:
name: PUID name: PUID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
TZ: TZ:
name: TZ name: TZ
description: >- description: >-
The timezone, as described in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones The timezone, as described in
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
cifspassword: cifspassword:
name: cifspassword name: cifspassword
description: >- description: "Your password to access your SMB share, same for all smb shares"
Your password to access your SMB share, same for all smb shares
cifsusername: cifsusername:
name: cifsusername name: cifsusername
description: >- description: "Your username to access your SMB share, same for all smb shares"
Your username to access your SMB share, same for all smb shares
cifsdomain: cifsdomain:
name: cifsdomain name: cifsdomain
description: >- description: Allow setting the domain for the smb share
Allow setting the domain for the smb share
database: database:
name: database name: database
description: >- description: Type of database to use
Type of database to use
data_location: data_location:
name: data_location name: data_location
description: >- description: Where do you want your data stored
Where do you want your data stored
localdisks: localdisks:
name: localdisks name: localdisks
description: >- description: >-
Physical name of the partition (ex. sda1) or the share (ex. SharedFiles) to mount separated by commas (ex: sda1,sdb1,MYNAS) Physical name of the partition (ex. sda1) or the share (ex. SharedFiles)
to mount separated by commas (ex: sda1,sdb1,MYNAS)
networkdisks: networkdisks:
name: networkdisks name: networkdisks
description: >- description: "list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)"
list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)
DB_HOSTNAME: DB_HOSTNAME:
name: DB_HOSTNAME name: DB_HOSTNAME
description: >- description: If using external postgresql
If using external postgresql
DB_USERNAME: DB_USERNAME:
name: DB_USERNAME name: DB_USERNAME
description: >- description: If using external postgresql
If using external postgresql
DB_PORT: DB_PORT:
name: DB_PORT name: DB_PORT
description: >- description: If using external postgresql
If using external postgresql
DB_PASSWORD: DB_PASSWORD:
name: DB_PASSWORD name: DB_PASSWORD
description: >- description: If using external postgresql
If using external postgresql
DB_DATABASE_NAME: DB_DATABASE_NAME:
name: DB_DATABASE_NAME name: DB_DATABASE_NAME
description: >- description: If using external postgresql
If using external postgresql
UPLOAD_LOCATION: UPLOAD_LOCATION:
name: UPLOAD_LOCATION name: UPLOAD_LOCATION
description: >- description: This is the location where uploaded files are stored
This is the location where uploaded files are stored
JWT_SECRET: JWT_SECRET:
name: JWT_SECRET name: JWT_SECRET
description: >- description: Used to sign the authentication keys for user login
Used to sign the authentication keys for user login
run_duration: run_duration:
name: run_duration name: run_duration
description: >- description: >-
12h #for how long should the addon run. Must be formatted as number + time unit (ex : 5s, or 2m, or 12h, or 5d...) 12h #for how long should the addon run. Must be formatted as number + time
unit (ex : 5s, or 2m, or 12h, or 5d...)
silent: silent:
name: silent name: silent
description: >- description: "true #suppresses debug messages"
true #suppresses debug messages
ssl: ssl:
name: ssl name: ssl
description: >- description: "true/false : enables ssl. Need certfile and keyfile filled"
true/false : enables ssl. Need certfile and keyfile filled
certfile: certfile:
name: certfile name: certfile
description: >- description: "fullchain.pem #ssl certificate, must be located in /ssl"
fullchain.pem #ssl certificate, must be located in /ssl
keyfile: keyfile:
name: keyfile name: keyfile
description: >- description: "privkey.pem #sslkeyfile, must be located in /ssl"
privkey.pem #sslkeyfile, must be located in /ssl
whitelist: whitelist:
name: whitelist name: whitelist
description: >- description: '"localhost,192.168.0.0/16" # list ip subnets that won''t need a password'
"localhost,192.168.0.0/16" # list ip subnets that won't need a password
customUI: customUI:
name: customUI name: customUI
description: >- description: >-
selection from list # alternative webUI can be set here. Latest version set at each addon start selection from list # alternative webUI can be set here. Latest version
set at each addon start
DNS_servers: DNS_servers:
name: DNS_servers name: DNS_servers
description: >- description: >-
8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to avoid spamming in case of local DNS ad-remover 8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to
avoid spamming in case of local DNS ad-remover
openvpn_alt_mode: openvpn_alt_mode:
name: openvpn_alt_mode name: openvpn_alt_mode
description: >- description: bind at container level and not app level
bind at container level and not app level
openvpn_config: openvpn_config:
name: openvpn_config name: openvpn_config
description: >- description: 'for example "config.ovpn" # name of the file located in /config/openvpn'
for example "config.ovpn" # name of the file located in /config/openvpn

View File

@@ -3,108 +3,95 @@ configuration:
PGID: PGID:
name: PGID name: PGID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
PUID: PUID:
name: PUID name: PUID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
TZ: TZ:
name: TZ name: TZ
description: >- description: >-
The timezone, as described in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones The timezone, as described in
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
cifspassword: cifspassword:
name: cifspassword name: cifspassword
description: >- description: "Your password to access your SMB share, same for all smb shares"
Your password to access your SMB share, same for all smb shares
cifsusername: cifsusername:
name: cifsusername name: cifsusername
description: >- description: "Your username to access your SMB share, same for all smb shares"
Your username to access your SMB share, same for all smb shares
cifsdomain: cifsdomain:
name: cifsdomain name: cifsdomain
description: >- description: Allow setting the domain for the smb share
Allow setting the domain for the smb share
database: database:
name: database name: database
description: >- description: Type of database to use
Type of database to use
data_location: data_location:
name: data_location name: data_location
description: >- description: Where do you want your data stored
Where do you want your data stored
localdisks: localdisks:
name: localdisks name: localdisks
description: >- description: >-
Physical name of the partition (ex. sda1) or the share (ex. SharedFiles) to mount separated by commas (ex: sda1,sdb1,MYNAS) Physical name of the partition (ex. sda1) or the share (ex. SharedFiles)
to mount separated by commas (ex: sda1,sdb1,MYNAS)
networkdisks: networkdisks:
name: networkdisks name: networkdisks
description: >- description: "list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)"
list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)
DB_HOSTNAME: DB_HOSTNAME:
name: DB_HOSTNAME name: DB_HOSTNAME
description: >- description: If using external postgresql
If using external postgresql
DB_USERNAME: DB_USERNAME:
name: DB_USERNAME name: DB_USERNAME
description: >- description: If using external postgresql
If using external postgresql
DB_PORT: DB_PORT:
name: DB_PORT name: DB_PORT
description: >- description: If using external postgresql
If using external postgresql
DB_PASSWORD: DB_PASSWORD:
name: DB_PASSWORD name: DB_PASSWORD
description: >- description: If using external postgresql
If using external postgresql
DB_DATABASE_NAME: DB_DATABASE_NAME:
name: DB_DATABASE_NAME name: DB_DATABASE_NAME
description: >- description: If using external postgresql
If using external postgresql
UPLOAD_LOCATION: UPLOAD_LOCATION:
name: UPLOAD_LOCATION name: UPLOAD_LOCATION
description: >- description: This is the location where uploaded files are stored
This is the location where uploaded files are stored
JWT_SECRET: JWT_SECRET:
name: JWT_SECRET name: JWT_SECRET
description: >- description: Used to sign the authentication keys for user login
Used to sign the authentication keys for user login
run_duration: run_duration:
name: run_duration name: run_duration
description: >- description: >-
12h #for how long should the addon run. Must be formatted as number + time unit (ex : 5s, or 2m, or 12h, or 5d...) 12h #for how long should the addon run. Must be formatted as number + time
unit (ex : 5s, or 2m, or 12h, or 5d...)
silent: silent:
name: silent name: silent
description: >- description: "true #suppresses debug messages"
true #suppresses debug messages
ssl: ssl:
name: ssl name: ssl
description: >- description: "true/false : enables ssl. Need certfile and keyfile filled"
true/false : enables ssl. Need certfile and keyfile filled
certfile: certfile:
name: certfile name: certfile
description: >- description: "fullchain.pem #ssl certificate, must be located in /ssl"
fullchain.pem #ssl certificate, must be located in /ssl
keyfile: keyfile:
name: keyfile name: keyfile
description: >- description: "privkey.pem #sslkeyfile, must be located in /ssl"
privkey.pem #sslkeyfile, must be located in /ssl
whitelist: whitelist:
name: whitelist name: whitelist
description: >- description: '"localhost,192.168.0.0/16" # list ip subnets that won''t need a password'
"localhost,192.168.0.0/16" # list ip subnets that won't need a password
customUI: customUI:
name: customUI name: customUI
description: >- description: >-
selection from list # alternative webUI can be set here. Latest version set at each addon start selection from list # alternative webUI can be set here. Latest version
set at each addon start
DNS_servers: DNS_servers:
name: DNS_servers name: DNS_servers
description: >- description: >-
8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to avoid spamming in case of local DNS ad-remover 8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to
avoid spamming in case of local DNS ad-remover
openvpn_alt_mode: openvpn_alt_mode:
name: openvpn_alt_mode name: openvpn_alt_mode
description: >- description: bind at container level and not app level
bind at container level and not app level
openvpn_config: openvpn_config:
name: openvpn_config name: openvpn_config
description: >- description: 'for example "config.ovpn" # name of the file located in /config/openvpn'
for example "config.ovpn" # name of the file located in /config/openvpn

View File

@@ -3,108 +3,95 @@ configuration:
PGID: PGID:
name: PGID name: PGID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
PUID: PUID:
name: PUID name: PUID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
TZ: TZ:
name: TZ name: TZ
description: >- description: >-
The timezone, as described in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones The timezone, as described in
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
cifspassword: cifspassword:
name: cifspassword name: cifspassword
description: >- description: "Your password to access your SMB share, same for all smb shares"
Your password to access your SMB share, same for all smb shares
cifsusername: cifsusername:
name: cifsusername name: cifsusername
description: >- description: "Your username to access your SMB share, same for all smb shares"
Your username to access your SMB share, same for all smb shares
cifsdomain: cifsdomain:
name: cifsdomain name: cifsdomain
description: >- description: Allow setting the domain for the smb share
Allow setting the domain for the smb share
database: database:
name: database name: database
description: >- description: Type of database to use
Type of database to use
data_location: data_location:
name: data_location name: data_location
description: >- description: Where do you want your data stored
Where do you want your data stored
localdisks: localdisks:
name: localdisks name: localdisks
description: >- description: >-
Physical name of the partition (ex. sda1) or the share (ex. SharedFiles) to mount separated by commas (ex: sda1,sdb1,MYNAS) Physical name of the partition (ex. sda1) or the share (ex. SharedFiles)
to mount separated by commas (ex: sda1,sdb1,MYNAS)
networkdisks: networkdisks:
name: networkdisks name: networkdisks
description: >- description: "list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)"
list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)
DB_HOSTNAME: DB_HOSTNAME:
name: DB_HOSTNAME name: DB_HOSTNAME
description: >- description: If using external postgresql
If using external postgresql
DB_USERNAME: DB_USERNAME:
name: DB_USERNAME name: DB_USERNAME
description: >- description: If using external postgresql
If using external postgresql
DB_PORT: DB_PORT:
name: DB_PORT name: DB_PORT
description: >- description: If using external postgresql
If using external postgresql
DB_PASSWORD: DB_PASSWORD:
name: DB_PASSWORD name: DB_PASSWORD
description: >- description: If using external postgresql
If using external postgresql
DB_DATABASE_NAME: DB_DATABASE_NAME:
name: DB_DATABASE_NAME name: DB_DATABASE_NAME
description: >- description: If using external postgresql
If using external postgresql
UPLOAD_LOCATION: UPLOAD_LOCATION:
name: UPLOAD_LOCATION name: UPLOAD_LOCATION
description: >- description: This is the location where uploaded files are stored
This is the location where uploaded files are stored
JWT_SECRET: JWT_SECRET:
name: JWT_SECRET name: JWT_SECRET
description: >- description: Used to sign the authentication keys for user login
Used to sign the authentication keys for user login
run_duration: run_duration:
name: run_duration name: run_duration
description: >- description: >-
12h #for how long should the addon run. Must be formatted as number + time unit (ex : 5s, or 2m, or 12h, or 5d...) 12h #for how long should the addon run. Must be formatted as number + time
unit (ex : 5s, or 2m, or 12h, or 5d...)
silent: silent:
name: silent name: silent
description: >- description: "true #suppresses debug messages"
true #suppresses debug messages
ssl: ssl:
name: ssl name: ssl
description: >- description: "true/false : enables ssl. Need certfile and keyfile filled"
true/false : enables ssl. Need certfile and keyfile filled
certfile: certfile:
name: certfile name: certfile
description: >- description: "fullchain.pem #ssl certificate, must be located in /ssl"
fullchain.pem #ssl certificate, must be located in /ssl
keyfile: keyfile:
name: keyfile name: keyfile
description: >- description: "privkey.pem #sslkeyfile, must be located in /ssl"
privkey.pem #sslkeyfile, must be located in /ssl
whitelist: whitelist:
name: whitelist name: whitelist
description: >- description: '"localhost,192.168.0.0/16" # list ip subnets that won''t need a password'
"localhost,192.168.0.0/16" # list ip subnets that won't need a password
customUI: customUI:
name: customUI name: customUI
description: >- description: >-
selection from list # alternative webUI can be set here. Latest version set at each addon start selection from list # alternative webUI can be set here. Latest version
set at each addon start
DNS_servers: DNS_servers:
name: DNS_servers name: DNS_servers
description: >- description: >-
8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to avoid spamming in case of local DNS ad-remover 8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to
avoid spamming in case of local DNS ad-remover
openvpn_alt_mode: openvpn_alt_mode:
name: openvpn_alt_mode name: openvpn_alt_mode
description: >- description: bind at container level and not app level
bind at container level and not app level
openvpn_config: openvpn_config:
name: openvpn_config name: openvpn_config
description: >- description: 'for example "config.ovpn" # name of the file located in /config/openvpn'
for example "config.ovpn" # name of the file located in /config/openvpn

View File

@@ -3,108 +3,95 @@ configuration:
PGID: PGID:
name: PGID name: PGID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
PUID: PUID:
name: PUID name: PUID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
TZ: TZ:
name: TZ name: TZ
description: >- description: >-
The timezone, as described in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones The timezone, as described in
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
cifspassword: cifspassword:
name: cifspassword name: cifspassword
description: >- description: "Your password to access your SMB share, same for all smb shares"
Your password to access your SMB share, same for all smb shares
cifsusername: cifsusername:
name: cifsusername name: cifsusername
description: >- description: "Your username to access your SMB share, same for all smb shares"
Your username to access your SMB share, same for all smb shares
cifsdomain: cifsdomain:
name: cifsdomain name: cifsdomain
description: >- description: Allow setting the domain for the smb share
Allow setting the domain for the smb share
database: database:
name: database name: database
description: >- description: Type of database to use
Type of database to use
data_location: data_location:
name: data_location name: data_location
description: >- description: Where do you want your data stored
Where do you want your data stored
localdisks: localdisks:
name: localdisks name: localdisks
description: >- description: >-
Physical name of the partition (ex. sda1) or the share (ex. SharedFiles) to mount separated by commas (ex: sda1,sdb1,MYNAS) Physical name of the partition (ex. sda1) or the share (ex. SharedFiles)
to mount separated by commas (ex: sda1,sdb1,MYNAS)
networkdisks: networkdisks:
name: networkdisks name: networkdisks
description: >- description: "list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)"
list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)
DB_HOSTNAME: DB_HOSTNAME:
name: DB_HOSTNAME name: DB_HOSTNAME
description: >- description: If using external postgresql
If using external postgresql
DB_USERNAME: DB_USERNAME:
name: DB_USERNAME name: DB_USERNAME
description: >- description: If using external postgresql
If using external postgresql
DB_PORT: DB_PORT:
name: DB_PORT name: DB_PORT
description: >- description: If using external postgresql
If using external postgresql
DB_PASSWORD: DB_PASSWORD:
name: DB_PASSWORD name: DB_PASSWORD
description: >- description: If using external postgresql
If using external postgresql
DB_DATABASE_NAME: DB_DATABASE_NAME:
name: DB_DATABASE_NAME name: DB_DATABASE_NAME
description: >- description: If using external postgresql
If using external postgresql
UPLOAD_LOCATION: UPLOAD_LOCATION:
name: UPLOAD_LOCATION name: UPLOAD_LOCATION
description: >- description: This is the location where uploaded files are stored
This is the location where uploaded files are stored
JWT_SECRET: JWT_SECRET:
name: JWT_SECRET name: JWT_SECRET
description: >- description: Used to sign the authentication keys for user login
Used to sign the authentication keys for user login
run_duration: run_duration:
name: run_duration name: run_duration
description: >- description: >-
12h #for how long should the addon run. Must be formatted as number + time unit (ex : 5s, or 2m, or 12h, or 5d...) 12h #for how long should the addon run. Must be formatted as number + time
unit (ex : 5s, or 2m, or 12h, or 5d...)
silent: silent:
name: silent name: silent
description: >- description: "true #suppresses debug messages"
true #suppresses debug messages
ssl: ssl:
name: ssl name: ssl
description: >- description: "true/false : enables ssl. Need certfile and keyfile filled"
true/false : enables ssl. Need certfile and keyfile filled
certfile: certfile:
name: certfile name: certfile
description: >- description: "fullchain.pem #ssl certificate, must be located in /ssl"
fullchain.pem #ssl certificate, must be located in /ssl
keyfile: keyfile:
name: keyfile name: keyfile
description: >- description: "privkey.pem #sslkeyfile, must be located in /ssl"
privkey.pem #sslkeyfile, must be located in /ssl
whitelist: whitelist:
name: whitelist name: whitelist
description: >- description: '"localhost,192.168.0.0/16" # list ip subnets that won''t need a password'
"localhost,192.168.0.0/16" # list ip subnets that won't need a password
customUI: customUI:
name: customUI name: customUI
description: >- description: >-
selection from list # alternative webUI can be set here. Latest version set at each addon start selection from list # alternative webUI can be set here. Latest version
set at each addon start
DNS_servers: DNS_servers:
name: DNS_servers name: DNS_servers
description: >- description: >-
8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to avoid spamming in case of local DNS ad-remover 8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to
avoid spamming in case of local DNS ad-remover
openvpn_alt_mode: openvpn_alt_mode:
name: openvpn_alt_mode name: openvpn_alt_mode
description: >- description: bind at container level and not app level
bind at container level and not app level
openvpn_config: openvpn_config:
name: openvpn_config name: openvpn_config
description: >- description: 'for example "config.ovpn" # name of the file located in /config/openvpn'
for example "config.ovpn" # name of the file located in /config/openvpn

View File

@@ -3,108 +3,95 @@ configuration:
PGID: PGID:
name: PGID name: PGID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
PUID: PUID:
name: PUID name: PUID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
TZ: TZ:
name: TZ name: TZ
description: >- description: >-
The timezone, as described in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones The timezone, as described in
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
cifspassword: cifspassword:
name: cifspassword name: cifspassword
description: >- description: "Your password to access your SMB share, same for all smb shares"
Your password to access your SMB share, same for all smb shares
cifsusername: cifsusername:
name: cifsusername name: cifsusername
description: >- description: "Your username to access your SMB share, same for all smb shares"
Your username to access your SMB share, same for all smb shares
cifsdomain: cifsdomain:
name: cifsdomain name: cifsdomain
description: >- description: Allow setting the domain for the smb share
Allow setting the domain for the smb share
database: database:
name: database name: database
description: >- description: Type of database to use
Type of database to use
data_location: data_location:
name: data_location name: data_location
description: >- description: Where do you want your data stored
Where do you want your data stored
localdisks: localdisks:
name: localdisks name: localdisks
description: >- description: >-
Physical name of the partition (ex. sda1) or the share (ex. SharedFiles) to mount separated by commas (ex: sda1,sdb1,MYNAS) Physical name of the partition (ex. sda1) or the share (ex. SharedFiles)
to mount separated by commas (ex: sda1,sdb1,MYNAS)
networkdisks: networkdisks:
name: networkdisks name: networkdisks
description: >- description: "list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)"
list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)
DB_HOSTNAME: DB_HOSTNAME:
name: DB_HOSTNAME name: DB_HOSTNAME
description: >- description: If using external postgresql
If using external postgresql
DB_USERNAME: DB_USERNAME:
name: DB_USERNAME name: DB_USERNAME
description: >- description: If using external postgresql
If using external postgresql
DB_PORT: DB_PORT:
name: DB_PORT name: DB_PORT
description: >- description: If using external postgresql
If using external postgresql
DB_PASSWORD: DB_PASSWORD:
name: DB_PASSWORD name: DB_PASSWORD
description: >- description: If using external postgresql
If using external postgresql
DB_DATABASE_NAME: DB_DATABASE_NAME:
name: DB_DATABASE_NAME name: DB_DATABASE_NAME
description: >- description: If using external postgresql
If using external postgresql
UPLOAD_LOCATION: UPLOAD_LOCATION:
name: UPLOAD_LOCATION name: UPLOAD_LOCATION
description: >- description: This is the location where uploaded files are stored
This is the location where uploaded files are stored
JWT_SECRET: JWT_SECRET:
name: JWT_SECRET name: JWT_SECRET
description: >- description: Used to sign the authentication keys for user login
Used to sign the authentication keys for user login
run_duration: run_duration:
name: run_duration name: run_duration
description: >- description: >-
12h #for how long should the addon run. Must be formatted as number + time unit (ex : 5s, or 2m, or 12h, or 5d...) 12h #for how long should the addon run. Must be formatted as number + time
unit (ex : 5s, or 2m, or 12h, or 5d...)
silent: silent:
name: silent name: silent
description: >- description: "true #suppresses debug messages"
true #suppresses debug messages
ssl: ssl:
name: ssl name: ssl
description: >- description: "true/false : enables ssl. Need certfile and keyfile filled"
true/false : enables ssl. Need certfile and keyfile filled
certfile: certfile:
name: certfile name: certfile
description: >- description: "fullchain.pem #ssl certificate, must be located in /ssl"
fullchain.pem #ssl certificate, must be located in /ssl
keyfile: keyfile:
name: keyfile name: keyfile
description: >- description: "privkey.pem #sslkeyfile, must be located in /ssl"
privkey.pem #sslkeyfile, must be located in /ssl
whitelist: whitelist:
name: whitelist name: whitelist
description: >- description: '"localhost,192.168.0.0/16" # list ip subnets that won''t need a password'
"localhost,192.168.0.0/16" # list ip subnets that won't need a password
customUI: customUI:
name: customUI name: customUI
description: >- description: >-
selection from list # alternative webUI can be set here. Latest version set at each addon start selection from list # alternative webUI can be set here. Latest version
set at each addon start
DNS_servers: DNS_servers:
name: DNS_servers name: DNS_servers
description: >- description: >-
8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to avoid spamming in case of local DNS ad-remover 8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to
avoid spamming in case of local DNS ad-remover
openvpn_alt_mode: openvpn_alt_mode:
name: openvpn_alt_mode name: openvpn_alt_mode
description: >- description: bind at container level and not app level
bind at container level and not app level
openvpn_config: openvpn_config:
name: openvpn_config name: openvpn_config
description: >- description: 'for example "config.ovpn" # name of the file located in /config/openvpn'
for example "config.ovpn" # name of the file located in /config/openvpn

View File

@@ -3,108 +3,95 @@ configuration:
PGID: PGID:
name: PGID name: PGID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
PUID: PUID:
name: PUID name: PUID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
TZ: TZ:
name: TZ name: TZ
description: >- description: >-
The timezone, as described in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones The timezone, as described in
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
cifspassword: cifspassword:
name: cifspassword name: cifspassword
description: >- description: "Your password to access your SMB share, same for all smb shares"
Your password to access your SMB share, same for all smb shares
cifsusername: cifsusername:
name: cifsusername name: cifsusername
description: >- description: "Your username to access your SMB share, same for all smb shares"
Your username to access your SMB share, same for all smb shares
cifsdomain: cifsdomain:
name: cifsdomain name: cifsdomain
description: >- description: Allow setting the domain for the smb share
Allow setting the domain for the smb share
database: database:
name: database name: database
description: >- description: Type of database to use
Type of database to use
data_location: data_location:
name: data_location name: data_location
description: >- description: Where do you want your data stored
Where do you want your data stored
localdisks: localdisks:
name: localdisks name: localdisks
description: >- description: >-
Physical name of the partition (ex. sda1) or the share (ex. SharedFiles) to mount separated by commas (ex: sda1,sdb1,MYNAS) Physical name of the partition (ex. sda1) or the share (ex. SharedFiles)
to mount separated by commas (ex: sda1,sdb1,MYNAS)
networkdisks: networkdisks:
name: networkdisks name: networkdisks
description: >- description: "list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)"
list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)
DB_HOSTNAME: DB_HOSTNAME:
name: DB_HOSTNAME name: DB_HOSTNAME
description: >- description: If using external postgresql
If using external postgresql
DB_USERNAME: DB_USERNAME:
name: DB_USERNAME name: DB_USERNAME
description: >- description: If using external postgresql
If using external postgresql
DB_PORT: DB_PORT:
name: DB_PORT name: DB_PORT
description: >- description: If using external postgresql
If using external postgresql
DB_PASSWORD: DB_PASSWORD:
name: DB_PASSWORD name: DB_PASSWORD
description: >- description: If using external postgresql
If using external postgresql
DB_DATABASE_NAME: DB_DATABASE_NAME:
name: DB_DATABASE_NAME name: DB_DATABASE_NAME
description: >- description: If using external postgresql
If using external postgresql
UPLOAD_LOCATION: UPLOAD_LOCATION:
name: UPLOAD_LOCATION name: UPLOAD_LOCATION
description: >- description: This is the location where uploaded files are stored
This is the location where uploaded files are stored
JWT_SECRET: JWT_SECRET:
name: JWT_SECRET name: JWT_SECRET
description: >- description: Used to sign the authentication keys for user login
Used to sign the authentication keys for user login
run_duration: run_duration:
name: run_duration name: run_duration
description: >- description: >-
12h #for how long should the addon run. Must be formatted as number + time unit (ex : 5s, or 2m, or 12h, or 5d...) 12h #for how long should the addon run. Must be formatted as number + time
unit (ex : 5s, or 2m, or 12h, or 5d...)
silent: silent:
name: silent name: silent
description: >- description: "true #suppresses debug messages"
true #suppresses debug messages
ssl: ssl:
name: ssl name: ssl
description: >- description: "true/false : enables ssl. Need certfile and keyfile filled"
true/false : enables ssl. Need certfile and keyfile filled
certfile: certfile:
name: certfile name: certfile
description: >- description: "fullchain.pem #ssl certificate, must be located in /ssl"
fullchain.pem #ssl certificate, must be located in /ssl
keyfile: keyfile:
name: keyfile name: keyfile
description: >- description: "privkey.pem #sslkeyfile, must be located in /ssl"
privkey.pem #sslkeyfile, must be located in /ssl
whitelist: whitelist:
name: whitelist name: whitelist
description: >- description: '"localhost,192.168.0.0/16" # list ip subnets that won''t need a password'
"localhost,192.168.0.0/16" # list ip subnets that won't need a password
customUI: customUI:
name: customUI name: customUI
description: >- description: >-
selection from list # alternative webUI can be set here. Latest version set at each addon start selection from list # alternative webUI can be set here. Latest version
set at each addon start
DNS_servers: DNS_servers:
name: DNS_servers name: DNS_servers
description: >- description: >-
8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to avoid spamming in case of local DNS ad-remover 8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to
avoid spamming in case of local DNS ad-remover
openvpn_alt_mode: openvpn_alt_mode:
name: openvpn_alt_mode name: openvpn_alt_mode
description: >- description: bind at container level and not app level
bind at container level and not app level
openvpn_config: openvpn_config:
name: openvpn_config name: openvpn_config
description: >- description: 'for example "config.ovpn" # name of the file located in /config/openvpn'
for example "config.ovpn" # name of the file located in /config/openvpn

View File

@@ -3,108 +3,95 @@ configuration:
PGID: PGID:
name: PGID name: PGID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
PUID: PUID:
name: PUID name: PUID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
TZ: TZ:
name: TZ name: TZ
description: >- description: >-
The timezone, as described in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones The timezone, as described in
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
cifspassword: cifspassword:
name: cifspassword name: cifspassword
description: >- description: "Your password to access your SMB share, same for all smb shares"
Your password to access your SMB share, same for all smb shares
cifsusername: cifsusername:
name: cifsusername name: cifsusername
description: >- description: "Your username to access your SMB share, same for all smb shares"
Your username to access your SMB share, same for all smb shares
cifsdomain: cifsdomain:
name: cifsdomain name: cifsdomain
description: >- description: Allow setting the domain for the smb share
Allow setting the domain for the smb share
database: database:
name: database name: database
description: >- description: Type of database to use
Type of database to use
data_location: data_location:
name: data_location name: data_location
description: >- description: Where do you want your data stored
Where do you want your data stored
localdisks: localdisks:
name: localdisks name: localdisks
description: >- description: >-
Physical name of the partition (ex. sda1) or the share (ex. SharedFiles) to mount separated by commas (ex: sda1,sdb1,MYNAS) Physical name of the partition (ex. sda1) or the share (ex. SharedFiles)
to mount separated by commas (ex: sda1,sdb1,MYNAS)
networkdisks: networkdisks:
name: networkdisks name: networkdisks
description: >- description: "list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)"
list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)
DB_HOSTNAME: DB_HOSTNAME:
name: DB_HOSTNAME name: DB_HOSTNAME
description: >- description: If using external postgresql
If using external postgresql
DB_USERNAME: DB_USERNAME:
name: DB_USERNAME name: DB_USERNAME
description: >- description: If using external postgresql
If using external postgresql
DB_PORT: DB_PORT:
name: DB_PORT name: DB_PORT
description: >- description: If using external postgresql
If using external postgresql
DB_PASSWORD: DB_PASSWORD:
name: DB_PASSWORD name: DB_PASSWORD
description: >- description: If using external postgresql
If using external postgresql
DB_DATABASE_NAME: DB_DATABASE_NAME:
name: DB_DATABASE_NAME name: DB_DATABASE_NAME
description: >- description: If using external postgresql
If using external postgresql
UPLOAD_LOCATION: UPLOAD_LOCATION:
name: UPLOAD_LOCATION name: UPLOAD_LOCATION
description: >- description: This is the location where uploaded files are stored
This is the location where uploaded files are stored
JWT_SECRET: JWT_SECRET:
name: JWT_SECRET name: JWT_SECRET
description: >- description: Used to sign the authentication keys for user login
Used to sign the authentication keys for user login
run_duration: run_duration:
name: run_duration name: run_duration
description: >- description: >-
12h #for how long should the addon run. Must be formatted as number + time unit (ex : 5s, or 2m, or 12h, or 5d...) 12h #for how long should the addon run. Must be formatted as number + time
unit (ex : 5s, or 2m, or 12h, or 5d...)
silent: silent:
name: silent name: silent
description: >- description: "true #suppresses debug messages"
true #suppresses debug messages
ssl: ssl:
name: ssl name: ssl
description: >- description: "true/false : enables ssl. Need certfile and keyfile filled"
true/false : enables ssl. Need certfile and keyfile filled
certfile: certfile:
name: certfile name: certfile
description: >- description: "fullchain.pem #ssl certificate, must be located in /ssl"
fullchain.pem #ssl certificate, must be located in /ssl
keyfile: keyfile:
name: keyfile name: keyfile
description: >- description: "privkey.pem #sslkeyfile, must be located in /ssl"
privkey.pem #sslkeyfile, must be located in /ssl
whitelist: whitelist:
name: whitelist name: whitelist
description: >- description: '"localhost,192.168.0.0/16" # list ip subnets that won''t need a password'
"localhost,192.168.0.0/16" # list ip subnets that won't need a password
customUI: customUI:
name: customUI name: customUI
description: >- description: >-
selection from list # alternative webUI can be set here. Latest version set at each addon start selection from list # alternative webUI can be set here. Latest version
set at each addon start
DNS_servers: DNS_servers:
name: DNS_servers name: DNS_servers
description: >- description: >-
8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to avoid spamming in case of local DNS ad-remover 8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to
avoid spamming in case of local DNS ad-remover
openvpn_alt_mode: openvpn_alt_mode:
name: openvpn_alt_mode name: openvpn_alt_mode
description: >- description: bind at container level and not app level
bind at container level and not app level
openvpn_config: openvpn_config:
name: openvpn_config name: openvpn_config
description: >- description: 'for example "config.ovpn" # name of the file located in /config/openvpn'
for example "config.ovpn" # name of the file located in /config/openvpn

View File

@@ -3,108 +3,95 @@ configuration:
PGID: PGID:
name: PGID name: PGID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
PUID: PUID:
name: PUID name: PUID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
TZ: TZ:
name: TZ name: TZ
description: >- description: >-
The timezone, as described in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones The timezone, as described in
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
cifspassword: cifspassword:
name: cifspassword name: cifspassword
description: >- description: "Your password to access your SMB share, same for all smb shares"
Your password to access your SMB share, same for all smb shares
cifsusername: cifsusername:
name: cifsusername name: cifsusername
description: >- description: "Your username to access your SMB share, same for all smb shares"
Your username to access your SMB share, same for all smb shares
cifsdomain: cifsdomain:
name: cifsdomain name: cifsdomain
description: >- description: Allow setting the domain for the smb share
Allow setting the domain for the smb share
database: database:
name: database name: database
description: >- description: Type of database to use
Type of database to use
data_location: data_location:
name: data_location name: data_location
description: >- description: Where do you want your data stored
Where do you want your data stored
localdisks: localdisks:
name: localdisks name: localdisks
description: >- description: >-
Physical name of the partition (ex. sda1) or the share (ex. SharedFiles) to mount separated by commas (ex: sda1,sdb1,MYNAS) Physical name of the partition (ex. sda1) or the share (ex. SharedFiles)
to mount separated by commas (ex: sda1,sdb1,MYNAS)
networkdisks: networkdisks:
name: networkdisks name: networkdisks
description: >- description: "list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)"
list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)
DB_HOSTNAME: DB_HOSTNAME:
name: DB_HOSTNAME name: DB_HOSTNAME
description: >- description: If using external postgresql
If using external postgresql
DB_USERNAME: DB_USERNAME:
name: DB_USERNAME name: DB_USERNAME
description: >- description: If using external postgresql
If using external postgresql
DB_PORT: DB_PORT:
name: DB_PORT name: DB_PORT
description: >- description: If using external postgresql
If using external postgresql
DB_PASSWORD: DB_PASSWORD:
name: DB_PASSWORD name: DB_PASSWORD
description: >- description: If using external postgresql
If using external postgresql
DB_DATABASE_NAME: DB_DATABASE_NAME:
name: DB_DATABASE_NAME name: DB_DATABASE_NAME
description: >- description: If using external postgresql
If using external postgresql
UPLOAD_LOCATION: UPLOAD_LOCATION:
name: UPLOAD_LOCATION name: UPLOAD_LOCATION
description: >- description: This is the location where uploaded files are stored
This is the location where uploaded files are stored
JWT_SECRET: JWT_SECRET:
name: JWT_SECRET name: JWT_SECRET
description: >- description: Used to sign the authentication keys for user login
Used to sign the authentication keys for user login
run_duration: run_duration:
name: run_duration name: run_duration
description: >- description: >-
12h #for how long should the addon run. Must be formatted as number + time unit (ex : 5s, or 2m, or 12h, or 5d...) 12h #for how long should the addon run. Must be formatted as number + time
unit (ex : 5s, or 2m, or 12h, or 5d...)
silent: silent:
name: silent name: silent
description: >- description: "true #suppresses debug messages"
true #suppresses debug messages
ssl: ssl:
name: ssl name: ssl
description: >- description: "true/false : enables ssl. Need certfile and keyfile filled"
true/false : enables ssl. Need certfile and keyfile filled
certfile: certfile:
name: certfile name: certfile
description: >- description: "fullchain.pem #ssl certificate, must be located in /ssl"
fullchain.pem #ssl certificate, must be located in /ssl
keyfile: keyfile:
name: keyfile name: keyfile
description: >- description: "privkey.pem #sslkeyfile, must be located in /ssl"
privkey.pem #sslkeyfile, must be located in /ssl
whitelist: whitelist:
name: whitelist name: whitelist
description: >- description: '"localhost,192.168.0.0/16" # list ip subnets that won''t need a password'
"localhost,192.168.0.0/16" # list ip subnets that won't need a password
customUI: customUI:
name: customUI name: customUI
description: >- description: >-
selection from list # alternative webUI can be set here. Latest version set at each addon start selection from list # alternative webUI can be set here. Latest version
set at each addon start
DNS_servers: DNS_servers:
name: DNS_servers name: DNS_servers
description: >- description: >-
8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to avoid spamming in case of local DNS ad-remover 8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to
avoid spamming in case of local DNS ad-remover
openvpn_alt_mode: openvpn_alt_mode:
name: openvpn_alt_mode name: openvpn_alt_mode
description: >- description: bind at container level and not app level
bind at container level and not app level
openvpn_config: openvpn_config:
name: openvpn_config name: openvpn_config
description: >- description: 'for example "config.ovpn" # name of the file located in /config/openvpn'
for example "config.ovpn" # name of the file located in /config/openvpn

View File

@@ -3,108 +3,95 @@ configuration:
PGID: PGID:
name: PGID name: PGID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
PUID: PUID:
name: PUID name: PUID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
TZ: TZ:
name: TZ name: TZ
description: >- description: >-
The timezone, as described in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones The timezone, as described in
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
cifspassword: cifspassword:
name: cifspassword name: cifspassword
description: >- description: "Your password to access your SMB share, same for all smb shares"
Your password to access your SMB share, same for all smb shares
cifsusername: cifsusername:
name: cifsusername name: cifsusername
description: >- description: "Your username to access your SMB share, same for all smb shares"
Your username to access your SMB share, same for all smb shares
cifsdomain: cifsdomain:
name: cifsdomain name: cifsdomain
description: >- description: Allow setting the domain for the smb share
Allow setting the domain for the smb share
database: database:
name: database name: database
description: >- description: Type of database to use
Type of database to use
data_location: data_location:
name: data_location name: data_location
description: >- description: Where do you want your data stored
Where do you want your data stored
localdisks: localdisks:
name: localdisks name: localdisks
description: >- description: >-
Physical name of the partition (ex. sda1) or the share (ex. SharedFiles) to mount separated by commas (ex: sda1,sdb1,MYNAS) Physical name of the partition (ex. sda1) or the share (ex. SharedFiles)
to mount separated by commas (ex: sda1,sdb1,MYNAS)
networkdisks: networkdisks:
name: networkdisks name: networkdisks
description: >- description: "list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)"
list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)
DB_HOSTNAME: DB_HOSTNAME:
name: DB_HOSTNAME name: DB_HOSTNAME
description: >- description: If using external postgresql
If using external postgresql
DB_USERNAME: DB_USERNAME:
name: DB_USERNAME name: DB_USERNAME
description: >- description: If using external postgresql
If using external postgresql
DB_PORT: DB_PORT:
name: DB_PORT name: DB_PORT
description: >- description: If using external postgresql
If using external postgresql
DB_PASSWORD: DB_PASSWORD:
name: DB_PASSWORD name: DB_PASSWORD
description: >- description: If using external postgresql
If using external postgresql
DB_DATABASE_NAME: DB_DATABASE_NAME:
name: DB_DATABASE_NAME name: DB_DATABASE_NAME
description: >- description: If using external postgresql
If using external postgresql
UPLOAD_LOCATION: UPLOAD_LOCATION:
name: UPLOAD_LOCATION name: UPLOAD_LOCATION
description: >- description: This is the location where uploaded files are stored
This is the location where uploaded files are stored
JWT_SECRET: JWT_SECRET:
name: JWT_SECRET name: JWT_SECRET
description: >- description: Used to sign the authentication keys for user login
Used to sign the authentication keys for user login
run_duration: run_duration:
name: run_duration name: run_duration
description: >- description: >-
12h #for how long should the addon run. Must be formatted as number + time unit (ex : 5s, or 2m, or 12h, or 5d...) 12h #for how long should the addon run. Must be formatted as number + time
unit (ex : 5s, or 2m, or 12h, or 5d...)
silent: silent:
name: silent name: silent
description: >- description: "true #suppresses debug messages"
true #suppresses debug messages
ssl: ssl:
name: ssl name: ssl
description: >- description: "true/false : enables ssl. Need certfile and keyfile filled"
true/false : enables ssl. Need certfile and keyfile filled
certfile: certfile:
name: certfile name: certfile
description: >- description: "fullchain.pem #ssl certificate, must be located in /ssl"
fullchain.pem #ssl certificate, must be located in /ssl
keyfile: keyfile:
name: keyfile name: keyfile
description: >- description: "privkey.pem #sslkeyfile, must be located in /ssl"
privkey.pem #sslkeyfile, must be located in /ssl
whitelist: whitelist:
name: whitelist name: whitelist
description: >- description: '"localhost,192.168.0.0/16" # list ip subnets that won''t need a password'
"localhost,192.168.0.0/16" # list ip subnets that won't need a password
customUI: customUI:
name: customUI name: customUI
description: >- description: >-
selection from list # alternative webUI can be set here. Latest version set at each addon start selection from list # alternative webUI can be set here. Latest version
set at each addon start
DNS_servers: DNS_servers:
name: DNS_servers name: DNS_servers
description: >- description: >-
8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to avoid spamming in case of local DNS ad-remover 8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to
avoid spamming in case of local DNS ad-remover
openvpn_alt_mode: openvpn_alt_mode:
name: openvpn_alt_mode name: openvpn_alt_mode
description: >- description: bind at container level and not app level
bind at container level and not app level
openvpn_config: openvpn_config:
name: openvpn_config name: openvpn_config
description: >- description: 'for example "config.ovpn" # name of the file located in /config/openvpn'
for example "config.ovpn" # name of the file located in /config/openvpn

View File

@@ -3,108 +3,95 @@ configuration:
PGID: PGID:
name: PGID name: PGID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
PUID: PUID:
name: PUID name: PUID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
TZ: TZ:
name: TZ name: TZ
description: >- description: >-
The timezone, as described in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones The timezone, as described in
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
cifspassword: cifspassword:
name: cifspassword name: cifspassword
description: >- description: "Your password to access your SMB share, same for all smb shares"
Your password to access your SMB share, same for all smb shares
cifsusername: cifsusername:
name: cifsusername name: cifsusername
description: >- description: "Your username to access your SMB share, same for all smb shares"
Your username to access your SMB share, same for all smb shares
cifsdomain: cifsdomain:
name: cifsdomain name: cifsdomain
description: >- description: Allow setting the domain for the smb share
Allow setting the domain for the smb share
database: database:
name: database name: database
description: >- description: Type of database to use
Type of database to use
data_location: data_location:
name: data_location name: data_location
description: >- description: Where do you want your data stored
Where do you want your data stored
localdisks: localdisks:
name: localdisks name: localdisks
description: >- description: >-
Physical name of the partition (ex. sda1) or the share (ex. SharedFiles) to mount separated by commas (ex: sda1,sdb1,MYNAS) Physical name of the partition (ex. sda1) or the share (ex. SharedFiles)
to mount separated by commas (ex: sda1,sdb1,MYNAS)
networkdisks: networkdisks:
name: networkdisks name: networkdisks
description: >- description: "list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)"
list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)
DB_HOSTNAME: DB_HOSTNAME:
name: DB_HOSTNAME name: DB_HOSTNAME
description: >- description: If using external postgresql
If using external postgresql
DB_USERNAME: DB_USERNAME:
name: DB_USERNAME name: DB_USERNAME
description: >- description: If using external postgresql
If using external postgresql
DB_PORT: DB_PORT:
name: DB_PORT name: DB_PORT
description: >- description: If using external postgresql
If using external postgresql
DB_PASSWORD: DB_PASSWORD:
name: DB_PASSWORD name: DB_PASSWORD
description: >- description: If using external postgresql
If using external postgresql
DB_DATABASE_NAME: DB_DATABASE_NAME:
name: DB_DATABASE_NAME name: DB_DATABASE_NAME
description: >- description: If using external postgresql
If using external postgresql
UPLOAD_LOCATION: UPLOAD_LOCATION:
name: UPLOAD_LOCATION name: UPLOAD_LOCATION
description: >- description: This is the location where uploaded files are stored
This is the location where uploaded files are stored
JWT_SECRET: JWT_SECRET:
name: JWT_SECRET name: JWT_SECRET
description: >- description: Used to sign the authentication keys for user login
Used to sign the authentication keys for user login
run_duration: run_duration:
name: run_duration name: run_duration
description: >- description: >-
12h #for how long should the addon run. Must be formatted as number + time unit (ex : 5s, or 2m, or 12h, or 5d...) 12h #for how long should the addon run. Must be formatted as number + time
unit (ex : 5s, or 2m, or 12h, or 5d...)
silent: silent:
name: silent name: silent
description: >- description: "true #suppresses debug messages"
true #suppresses debug messages
ssl: ssl:
name: ssl name: ssl
description: >- description: "true/false : enables ssl. Need certfile and keyfile filled"
true/false : enables ssl. Need certfile and keyfile filled
certfile: certfile:
name: certfile name: certfile
description: >- description: "fullchain.pem #ssl certificate, must be located in /ssl"
fullchain.pem #ssl certificate, must be located in /ssl
keyfile: keyfile:
name: keyfile name: keyfile
description: >- description: "privkey.pem #sslkeyfile, must be located in /ssl"
privkey.pem #sslkeyfile, must be located in /ssl
whitelist: whitelist:
name: whitelist name: whitelist
description: >- description: '"localhost,192.168.0.0/16" # list ip subnets that won''t need a password'
"localhost,192.168.0.0/16" # list ip subnets that won't need a password
customUI: customUI:
name: customUI name: customUI
description: >- description: >-
selection from list # alternative webUI can be set here. Latest version set at each addon start selection from list # alternative webUI can be set here. Latest version
set at each addon start
DNS_servers: DNS_servers:
name: DNS_servers name: DNS_servers
description: >- description: >-
8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to avoid spamming in case of local DNS ad-remover 8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to
avoid spamming in case of local DNS ad-remover
openvpn_alt_mode: openvpn_alt_mode:
name: openvpn_alt_mode name: openvpn_alt_mode
description: >- description: bind at container level and not app level
bind at container level and not app level
openvpn_config: openvpn_config:
name: openvpn_config name: openvpn_config
description: >- description: 'for example "config.ovpn" # name of the file located in /config/openvpn'
for example "config.ovpn" # name of the file located in /config/openvpn

View File

@@ -3,108 +3,95 @@ configuration:
PGID: PGID:
name: PGID name: PGID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
PUID: PUID:
name: PUID name: PUID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
TZ: TZ:
name: TZ name: TZ
description: >- description: >-
The timezone, as described in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones The timezone, as described in
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
cifspassword: cifspassword:
name: cifspassword name: cifspassword
description: >- description: "Your password to access your SMB share, same for all smb shares"
Your password to access your SMB share, same for all smb shares
cifsusername: cifsusername:
name: cifsusername name: cifsusername
description: >- description: "Your username to access your SMB share, same for all smb shares"
Your username to access your SMB share, same for all smb shares
cifsdomain: cifsdomain:
name: cifsdomain name: cifsdomain
description: >- description: Allow setting the domain for the smb share
Allow setting the domain for the smb share
database: database:
name: database name: database
description: >- description: Type of database to use
Type of database to use
data_location: data_location:
name: data_location name: data_location
description: >- description: Where do you want your data stored
Where do you want your data stored
localdisks: localdisks:
name: localdisks name: localdisks
description: >- description: >-
Physical name of the partition (ex. sda1) or the share (ex. SharedFiles) to mount separated by commas (ex: sda1,sdb1,MYNAS) Physical name of the partition (ex. sda1) or the share (ex. SharedFiles)
to mount separated by commas (ex: sda1,sdb1,MYNAS)
networkdisks: networkdisks:
name: networkdisks name: networkdisks
description: >- description: "list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)"
list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)
DB_HOSTNAME: DB_HOSTNAME:
name: DB_HOSTNAME name: DB_HOSTNAME
description: >- description: If using external postgresql
If using external postgresql
DB_USERNAME: DB_USERNAME:
name: DB_USERNAME name: DB_USERNAME
description: >- description: If using external postgresql
If using external postgresql
DB_PORT: DB_PORT:
name: DB_PORT name: DB_PORT
description: >- description: If using external postgresql
If using external postgresql
DB_PASSWORD: DB_PASSWORD:
name: DB_PASSWORD name: DB_PASSWORD
description: >- description: If using external postgresql
If using external postgresql
DB_DATABASE_NAME: DB_DATABASE_NAME:
name: DB_DATABASE_NAME name: DB_DATABASE_NAME
description: >- description: If using external postgresql
If using external postgresql
UPLOAD_LOCATION: UPLOAD_LOCATION:
name: UPLOAD_LOCATION name: UPLOAD_LOCATION
description: >- description: This is the location where uploaded files are stored
This is the location where uploaded files are stored
JWT_SECRET: JWT_SECRET:
name: JWT_SECRET name: JWT_SECRET
description: >- description: Used to sign the authentication keys for user login
Used to sign the authentication keys for user login
run_duration: run_duration:
name: run_duration name: run_duration
description: >- description: >-
12h #for how long should the addon run. Must be formatted as number + time unit (ex : 5s, or 2m, or 12h, or 5d...) 12h #for how long should the addon run. Must be formatted as number + time
unit (ex : 5s, or 2m, or 12h, or 5d...)
silent: silent:
name: silent name: silent
description: >- description: "true #suppresses debug messages"
true #suppresses debug messages
ssl: ssl:
name: ssl name: ssl
description: >- description: "true/false : enables ssl. Need certfile and keyfile filled"
true/false : enables ssl. Need certfile and keyfile filled
certfile: certfile:
name: certfile name: certfile
description: >- description: "fullchain.pem #ssl certificate, must be located in /ssl"
fullchain.pem #ssl certificate, must be located in /ssl
keyfile: keyfile:
name: keyfile name: keyfile
description: >- description: "privkey.pem #sslkeyfile, must be located in /ssl"
privkey.pem #sslkeyfile, must be located in /ssl
whitelist: whitelist:
name: whitelist name: whitelist
description: >- description: '"localhost,192.168.0.0/16" # list ip subnets that won''t need a password'
"localhost,192.168.0.0/16" # list ip subnets that won't need a password
customUI: customUI:
name: customUI name: customUI
description: >- description: >-
selection from list # alternative webUI can be set here. Latest version set at each addon start selection from list # alternative webUI can be set here. Latest version
set at each addon start
DNS_servers: DNS_servers:
name: DNS_servers name: DNS_servers
description: >- description: >-
8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to avoid spamming in case of local DNS ad-remover 8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to
avoid spamming in case of local DNS ad-remover
openvpn_alt_mode: openvpn_alt_mode:
name: openvpn_alt_mode name: openvpn_alt_mode
description: >- description: bind at container level and not app level
bind at container level and not app level
openvpn_config: openvpn_config:
name: openvpn_config name: openvpn_config
description: >- description: 'for example "config.ovpn" # name of the file located in /config/openvpn'
for example "config.ovpn" # name of the file located in /config/openvpn

View File

@@ -3,108 +3,95 @@ configuration:
PGID: PGID:
name: PGID name: PGID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
PUID: PUID:
name: PUID name: PUID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
TZ: TZ:
name: TZ name: TZ
description: >- description: >-
The timezone, as described in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones The timezone, as described in
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
cifspassword: cifspassword:
name: cifspassword name: cifspassword
description: >- description: "Your password to access your SMB share, same for all smb shares"
Your password to access your SMB share, same for all smb shares
cifsusername: cifsusername:
name: cifsusername name: cifsusername
description: >- description: "Your username to access your SMB share, same for all smb shares"
Your username to access your SMB share, same for all smb shares
cifsdomain: cifsdomain:
name: cifsdomain name: cifsdomain
description: >- description: Allow setting the domain for the smb share
Allow setting the domain for the smb share
database: database:
name: database name: database
description: >- description: Type of database to use
Type of database to use
data_location: data_location:
name: data_location name: data_location
description: >- description: Where do you want your data stored
Where do you want your data stored
localdisks: localdisks:
name: localdisks name: localdisks
description: >- description: >-
Physical name of the partition (ex. sda1) or the share (ex. SharedFiles) to mount separated by commas (ex: sda1,sdb1,MYNAS) Physical name of the partition (ex. sda1) or the share (ex. SharedFiles)
to mount separated by commas (ex: sda1,sdb1,MYNAS)
networkdisks: networkdisks:
name: networkdisks name: networkdisks
description: >- description: "list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)"
list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)
DB_HOSTNAME: DB_HOSTNAME:
name: DB_HOSTNAME name: DB_HOSTNAME
description: >- description: If using external postgresql
If using external postgresql
DB_USERNAME: DB_USERNAME:
name: DB_USERNAME name: DB_USERNAME
description: >- description: If using external postgresql
If using external postgresql
DB_PORT: DB_PORT:
name: DB_PORT name: DB_PORT
description: >- description: If using external postgresql
If using external postgresql
DB_PASSWORD: DB_PASSWORD:
name: DB_PASSWORD name: DB_PASSWORD
description: >- description: If using external postgresql
If using external postgresql
DB_DATABASE_NAME: DB_DATABASE_NAME:
name: DB_DATABASE_NAME name: DB_DATABASE_NAME
description: >- description: If using external postgresql
If using external postgresql
UPLOAD_LOCATION: UPLOAD_LOCATION:
name: UPLOAD_LOCATION name: UPLOAD_LOCATION
description: >- description: This is the location where uploaded files are stored
This is the location where uploaded files are stored
JWT_SECRET: JWT_SECRET:
name: JWT_SECRET name: JWT_SECRET
description: >- description: Used to sign the authentication keys for user login
Used to sign the authentication keys for user login
run_duration: run_duration:
name: run_duration name: run_duration
description: >- description: >-
12h #for how long should the addon run. Must be formatted as number + time unit (ex : 5s, or 2m, or 12h, or 5d...) 12h #for how long should the addon run. Must be formatted as number + time
unit (ex : 5s, or 2m, or 12h, or 5d...)
silent: silent:
name: silent name: silent
description: >- description: "true #suppresses debug messages"
true #suppresses debug messages
ssl: ssl:
name: ssl name: ssl
description: >- description: "true/false : enables ssl. Need certfile and keyfile filled"
true/false : enables ssl. Need certfile and keyfile filled
certfile: certfile:
name: certfile name: certfile
description: >- description: "fullchain.pem #ssl certificate, must be located in /ssl"
fullchain.pem #ssl certificate, must be located in /ssl
keyfile: keyfile:
name: keyfile name: keyfile
description: >- description: "privkey.pem #sslkeyfile, must be located in /ssl"
privkey.pem #sslkeyfile, must be located in /ssl
whitelist: whitelist:
name: whitelist name: whitelist
description: >- description: '"localhost,192.168.0.0/16" # list ip subnets that won''t need a password'
"localhost,192.168.0.0/16" # list ip subnets that won't need a password
customUI: customUI:
name: customUI name: customUI
description: >- description: >-
selection from list # alternative webUI can be set here. Latest version set at each addon start selection from list # alternative webUI can be set here. Latest version
set at each addon start
DNS_servers: DNS_servers:
name: DNS_servers name: DNS_servers
description: >- description: >-
8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to avoid spamming in case of local DNS ad-remover 8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to
avoid spamming in case of local DNS ad-remover
openvpn_alt_mode: openvpn_alt_mode:
name: openvpn_alt_mode name: openvpn_alt_mode
description: >- description: bind at container level and not app level
bind at container level and not app level
openvpn_config: openvpn_config:
name: openvpn_config name: openvpn_config
description: >- description: 'for example "config.ovpn" # name of the file located in /config/openvpn'
for example "config.ovpn" # name of the file located in /config/openvpn

View File

@@ -3,108 +3,95 @@ configuration:
PGID: PGID:
name: PGID name: PGID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
PUID: PUID:
name: PUID name: PUID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
TZ: TZ:
name: TZ name: TZ
description: >- description: >-
The timezone, as described in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones The timezone, as described in
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
cifspassword: cifspassword:
name: cifspassword name: cifspassword
description: >- description: "Your password to access your SMB share, same for all smb shares"
Your password to access your SMB share, same for all smb shares
cifsusername: cifsusername:
name: cifsusername name: cifsusername
description: >- description: "Your username to access your SMB share, same for all smb shares"
Your username to access your SMB share, same for all smb shares
cifsdomain: cifsdomain:
name: cifsdomain name: cifsdomain
description: >- description: Allow setting the domain for the smb share
Allow setting the domain for the smb share
database: database:
name: database name: database
description: >- description: Type of database to use
Type of database to use
data_location: data_location:
name: data_location name: data_location
description: >- description: Where do you want your data stored
Where do you want your data stored
localdisks: localdisks:
name: localdisks name: localdisks
description: >- description: >-
Physical name of the partition (ex. sda1) or the share (ex. SharedFiles) to mount separated by commas (ex: sda1,sdb1,MYNAS) Physical name of the partition (ex. sda1) or the share (ex. SharedFiles)
to mount separated by commas (ex: sda1,sdb1,MYNAS)
networkdisks: networkdisks:
name: networkdisks name: networkdisks
description: >- description: "list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)"
list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)
DB_HOSTNAME: DB_HOSTNAME:
name: DB_HOSTNAME name: DB_HOSTNAME
description: >- description: If using external postgresql
If using external postgresql
DB_USERNAME: DB_USERNAME:
name: DB_USERNAME name: DB_USERNAME
description: >- description: If using external postgresql
If using external postgresql
DB_PORT: DB_PORT:
name: DB_PORT name: DB_PORT
description: >- description: If using external postgresql
If using external postgresql
DB_PASSWORD: DB_PASSWORD:
name: DB_PASSWORD name: DB_PASSWORD
description: >- description: If using external postgresql
If using external postgresql
DB_DATABASE_NAME: DB_DATABASE_NAME:
name: DB_DATABASE_NAME name: DB_DATABASE_NAME
description: >- description: If using external postgresql
If using external postgresql
UPLOAD_LOCATION: UPLOAD_LOCATION:
name: UPLOAD_LOCATION name: UPLOAD_LOCATION
description: >- description: This is the location where uploaded files are stored
This is the location where uploaded files are stored
JWT_SECRET: JWT_SECRET:
name: JWT_SECRET name: JWT_SECRET
description: >- description: Used to sign the authentication keys for user login
Used to sign the authentication keys for user login
run_duration: run_duration:
name: run_duration name: run_duration
description: >- description: >-
12h #for how long should the addon run. Must be formatted as number + time unit (ex : 5s, or 2m, or 12h, or 5d...) 12h #for how long should the addon run. Must be formatted as number + time
unit (ex : 5s, or 2m, or 12h, or 5d...)
silent: silent:
name: silent name: silent
description: >- description: "true #suppresses debug messages"
true #suppresses debug messages
ssl: ssl:
name: ssl name: ssl
description: >- description: "true/false : enables ssl. Need certfile and keyfile filled"
true/false : enables ssl. Need certfile and keyfile filled
certfile: certfile:
name: certfile name: certfile
description: >- description: "fullchain.pem #ssl certificate, must be located in /ssl"
fullchain.pem #ssl certificate, must be located in /ssl
keyfile: keyfile:
name: keyfile name: keyfile
description: >- description: "privkey.pem #sslkeyfile, must be located in /ssl"
privkey.pem #sslkeyfile, must be located in /ssl
whitelist: whitelist:
name: whitelist name: whitelist
description: >- description: '"localhost,192.168.0.0/16" # list ip subnets that won''t need a password'
"localhost,192.168.0.0/16" # list ip subnets that won't need a password
customUI: customUI:
name: customUI name: customUI
description: >- description: >-
selection from list # alternative webUI can be set here. Latest version set at each addon start selection from list # alternative webUI can be set here. Latest version
set at each addon start
DNS_servers: DNS_servers:
name: DNS_servers name: DNS_servers
description: >- description: >-
8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to avoid spamming in case of local DNS ad-remover 8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to
avoid spamming in case of local DNS ad-remover
openvpn_alt_mode: openvpn_alt_mode:
name: openvpn_alt_mode name: openvpn_alt_mode
description: >- description: bind at container level and not app level
bind at container level and not app level
openvpn_config: openvpn_config:
name: openvpn_config name: openvpn_config
description: >- description: 'for example "config.ovpn" # name of the file located in /config/openvpn'
for example "config.ovpn" # name of the file located in /config/openvpn

View File

@@ -3,108 +3,95 @@ configuration:
PGID: PGID:
name: PGID name: PGID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
PUID: PUID:
name: PUID name: PUID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
TZ: TZ:
name: TZ name: TZ
description: >- description: >-
The timezone, as described in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones The timezone, as described in
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
cifspassword: cifspassword:
name: cifspassword name: cifspassword
description: >- description: "Your password to access your SMB share, same for all smb shares"
Your password to access your SMB share, same for all smb shares
cifsusername: cifsusername:
name: cifsusername name: cifsusername
description: >- description: "Your username to access your SMB share, same for all smb shares"
Your username to access your SMB share, same for all smb shares
cifsdomain: cifsdomain:
name: cifsdomain name: cifsdomain
description: >- description: Allow setting the domain for the smb share
Allow setting the domain for the smb share
database: database:
name: database name: database
description: >- description: Type of database to use
Type of database to use
data_location: data_location:
name: data_location name: data_location
description: >- description: Where do you want your data stored
Where do you want your data stored
localdisks: localdisks:
name: localdisks name: localdisks
description: >- description: >-
Physical name of the partition (ex. sda1) or the share (ex. SharedFiles) to mount separated by commas (ex: sda1,sdb1,MYNAS) Physical name of the partition (ex. sda1) or the share (ex. SharedFiles)
to mount separated by commas (ex: sda1,sdb1,MYNAS)
networkdisks: networkdisks:
name: networkdisks name: networkdisks
description: >- description: "list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)"
list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)
DB_HOSTNAME: DB_HOSTNAME:
name: DB_HOSTNAME name: DB_HOSTNAME
description: >- description: If using external postgresql
If using external postgresql
DB_USERNAME: DB_USERNAME:
name: DB_USERNAME name: DB_USERNAME
description: >- description: If using external postgresql
If using external postgresql
DB_PORT: DB_PORT:
name: DB_PORT name: DB_PORT
description: >- description: If using external postgresql
If using external postgresql
DB_PASSWORD: DB_PASSWORD:
name: DB_PASSWORD name: DB_PASSWORD
description: >- description: If using external postgresql
If using external postgresql
DB_DATABASE_NAME: DB_DATABASE_NAME:
name: DB_DATABASE_NAME name: DB_DATABASE_NAME
description: >- description: If using external postgresql
If using external postgresql
UPLOAD_LOCATION: UPLOAD_LOCATION:
name: UPLOAD_LOCATION name: UPLOAD_LOCATION
description: >- description: This is the location where uploaded files are stored
This is the location where uploaded files are stored
JWT_SECRET: JWT_SECRET:
name: JWT_SECRET name: JWT_SECRET
description: >- description: Used to sign the authentication keys for user login
Used to sign the authentication keys for user login
run_duration: run_duration:
name: run_duration name: run_duration
description: >- description: >-
12h #for how long should the addon run. Must be formatted as number + time unit (ex : 5s, or 2m, or 12h, or 5d...) 12h #for how long should the addon run. Must be formatted as number + time
unit (ex : 5s, or 2m, or 12h, or 5d...)
silent: silent:
name: silent name: silent
description: >- description: "true #suppresses debug messages"
true #suppresses debug messages
ssl: ssl:
name: ssl name: ssl
description: >- description: "true/false : enables ssl. Need certfile and keyfile filled"
true/false : enables ssl. Need certfile and keyfile filled
certfile: certfile:
name: certfile name: certfile
description: >- description: "fullchain.pem #ssl certificate, must be located in /ssl"
fullchain.pem #ssl certificate, must be located in /ssl
keyfile: keyfile:
name: keyfile name: keyfile
description: >- description: "privkey.pem #sslkeyfile, must be located in /ssl"
privkey.pem #sslkeyfile, must be located in /ssl
whitelist: whitelist:
name: whitelist name: whitelist
description: >- description: '"localhost,192.168.0.0/16" # list ip subnets that won''t need a password'
"localhost,192.168.0.0/16" # list ip subnets that won't need a password
customUI: customUI:
name: customUI name: customUI
description: >- description: >-
selection from list # alternative webUI can be set here. Latest version set at each addon start selection from list # alternative webUI can be set here. Latest version
set at each addon start
DNS_servers: DNS_servers:
name: DNS_servers name: DNS_servers
description: >- description: >-
8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to avoid spamming in case of local DNS ad-remover 8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to
avoid spamming in case of local DNS ad-remover
openvpn_alt_mode: openvpn_alt_mode:
name: openvpn_alt_mode name: openvpn_alt_mode
description: >- description: bind at container level and not app level
bind at container level and not app level
openvpn_config: openvpn_config:
name: openvpn_config name: openvpn_config
description: >- description: 'for example "config.ovpn" # name of the file located in /config/openvpn'
for example "config.ovpn" # name of the file located in /config/openvpn

View File

@@ -3,108 +3,95 @@ configuration:
PGID: PGID:
name: PGID name: PGID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
PUID: PUID:
name: PUID name: PUID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
TZ: TZ:
name: TZ name: TZ
description: >- description: >-
The timezone, as described in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones The timezone, as described in
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
cifspassword: cifspassword:
name: cifspassword name: cifspassword
description: >- description: "Your password to access your SMB share, same for all smb shares"
Your password to access your SMB share, same for all smb shares
cifsusername: cifsusername:
name: cifsusername name: cifsusername
description: >- description: "Your username to access your SMB share, same for all smb shares"
Your username to access your SMB share, same for all smb shares
cifsdomain: cifsdomain:
name: cifsdomain name: cifsdomain
description: >- description: Allow setting the domain for the smb share
Allow setting the domain for the smb share
database: database:
name: database name: database
description: >- description: Type of database to use
Type of database to use
data_location: data_location:
name: data_location name: data_location
description: >- description: Where do you want your data stored
Where do you want your data stored
localdisks: localdisks:
name: localdisks name: localdisks
description: >- description: >-
Physical name of the partition (ex. sda1) or the share (ex. SharedFiles) to mount separated by commas (ex: sda1,sdb1,MYNAS) Physical name of the partition (ex. sda1) or the share (ex. SharedFiles)
to mount separated by commas (ex: sda1,sdb1,MYNAS)
networkdisks: networkdisks:
name: networkdisks name: networkdisks
description: >- description: "list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)"
list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)
DB_HOSTNAME: DB_HOSTNAME:
name: DB_HOSTNAME name: DB_HOSTNAME
description: >- description: If using external postgresql
If using external postgresql
DB_USERNAME: DB_USERNAME:
name: DB_USERNAME name: DB_USERNAME
description: >- description: If using external postgresql
If using external postgresql
DB_PORT: DB_PORT:
name: DB_PORT name: DB_PORT
description: >- description: If using external postgresql
If using external postgresql
DB_PASSWORD: DB_PASSWORD:
name: DB_PASSWORD name: DB_PASSWORD
description: >- description: If using external postgresql
If using external postgresql
DB_DATABASE_NAME: DB_DATABASE_NAME:
name: DB_DATABASE_NAME name: DB_DATABASE_NAME
description: >- description: If using external postgresql
If using external postgresql
UPLOAD_LOCATION: UPLOAD_LOCATION:
name: UPLOAD_LOCATION name: UPLOAD_LOCATION
description: >- description: This is the location where uploaded files are stored
This is the location where uploaded files are stored
JWT_SECRET: JWT_SECRET:
name: JWT_SECRET name: JWT_SECRET
description: >- description: Used to sign the authentication keys for user login
Used to sign the authentication keys for user login
run_duration: run_duration:
name: run_duration name: run_duration
description: >- description: >-
12h #for how long should the addon run. Must be formatted as number + time unit (ex : 5s, or 2m, or 12h, or 5d...) 12h #for how long should the addon run. Must be formatted as number + time
unit (ex : 5s, or 2m, or 12h, or 5d...)
silent: silent:
name: silent name: silent
description: >- description: "true #suppresses debug messages"
true #suppresses debug messages
ssl: ssl:
name: ssl name: ssl
description: >- description: "true/false : enables ssl. Need certfile and keyfile filled"
true/false : enables ssl. Need certfile and keyfile filled
certfile: certfile:
name: certfile name: certfile
description: >- description: "fullchain.pem #ssl certificate, must be located in /ssl"
fullchain.pem #ssl certificate, must be located in /ssl
keyfile: keyfile:
name: keyfile name: keyfile
description: >- description: "privkey.pem #sslkeyfile, must be located in /ssl"
privkey.pem #sslkeyfile, must be located in /ssl
whitelist: whitelist:
name: whitelist name: whitelist
description: >- description: '"localhost,192.168.0.0/16" # list ip subnets that won''t need a password'
"localhost,192.168.0.0/16" # list ip subnets that won't need a password
customUI: customUI:
name: customUI name: customUI
description: >- description: >-
selection from list # alternative webUI can be set here. Latest version set at each addon start selection from list # alternative webUI can be set here. Latest version
set at each addon start
DNS_servers: DNS_servers:
name: DNS_servers name: DNS_servers
description: >- description: >-
8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to avoid spamming in case of local DNS ad-remover 8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to
avoid spamming in case of local DNS ad-remover
openvpn_alt_mode: openvpn_alt_mode:
name: openvpn_alt_mode name: openvpn_alt_mode
description: >- description: bind at container level and not app level
bind at container level and not app level
openvpn_config: openvpn_config:
name: openvpn_config name: openvpn_config
description: >- description: 'for example "config.ovpn" # name of the file located in /config/openvpn'
for example "config.ovpn" # name of the file located in /config/openvpn

View File

@@ -3,108 +3,95 @@ configuration:
PGID: PGID:
name: PGID name: PGID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
PUID: PUID:
name: PUID name: PUID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
TZ: TZ:
name: TZ name: TZ
description: >- description: >-
The timezone, as described in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones The timezone, as described in
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
cifspassword: cifspassword:
name: cifspassword name: cifspassword
description: >- description: "Your password to access your SMB share, same for all smb shares"
Your password to access your SMB share, same for all smb shares
cifsusername: cifsusername:
name: cifsusername name: cifsusername
description: >- description: "Your username to access your SMB share, same for all smb shares"
Your username to access your SMB share, same for all smb shares
cifsdomain: cifsdomain:
name: cifsdomain name: cifsdomain
description: >- description: Allow setting the domain for the smb share
Allow setting the domain for the smb share
database: database:
name: database name: database
description: >- description: Type of database to use
Type of database to use
data_location: data_location:
name: data_location name: data_location
description: >- description: Where do you want your data stored
Where do you want your data stored
localdisks: localdisks:
name: localdisks name: localdisks
description: >- description: >-
Physical name of the partition (ex. sda1) or the share (ex. SharedFiles) to mount separated by commas (ex: sda1,sdb1,MYNAS) Physical name of the partition (ex. sda1) or the share (ex. SharedFiles)
to mount separated by commas (ex: sda1,sdb1,MYNAS)
networkdisks: networkdisks:
name: networkdisks name: networkdisks
description: >- description: "list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)"
list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)
DB_HOSTNAME: DB_HOSTNAME:
name: DB_HOSTNAME name: DB_HOSTNAME
description: >- description: If using external postgresql
If using external postgresql
DB_USERNAME: DB_USERNAME:
name: DB_USERNAME name: DB_USERNAME
description: >- description: If using external postgresql
If using external postgresql
DB_PORT: DB_PORT:
name: DB_PORT name: DB_PORT
description: >- description: If using external postgresql
If using external postgresql
DB_PASSWORD: DB_PASSWORD:
name: DB_PASSWORD name: DB_PASSWORD
description: >- description: If using external postgresql
If using external postgresql
DB_DATABASE_NAME: DB_DATABASE_NAME:
name: DB_DATABASE_NAME name: DB_DATABASE_NAME
description: >- description: If using external postgresql
If using external postgresql
UPLOAD_LOCATION: UPLOAD_LOCATION:
name: UPLOAD_LOCATION name: UPLOAD_LOCATION
description: >- description: This is the location where uploaded files are stored
This is the location where uploaded files are stored
JWT_SECRET: JWT_SECRET:
name: JWT_SECRET name: JWT_SECRET
description: >- description: Used to sign the authentication keys for user login
Used to sign the authentication keys for user login
run_duration: run_duration:
name: run_duration name: run_duration
description: >- description: >-
12h #for how long should the addon run. Must be formatted as number + time unit (ex : 5s, or 2m, or 12h, or 5d...) 12h #for how long should the addon run. Must be formatted as number + time
unit (ex : 5s, or 2m, or 12h, or 5d...)
silent: silent:
name: silent name: silent
description: >- description: "true #suppresses debug messages"
true #suppresses debug messages
ssl: ssl:
name: ssl name: ssl
description: >- description: "true/false : enables ssl. Need certfile and keyfile filled"
true/false : enables ssl. Need certfile and keyfile filled
certfile: certfile:
name: certfile name: certfile
description: >- description: "fullchain.pem #ssl certificate, must be located in /ssl"
fullchain.pem #ssl certificate, must be located in /ssl
keyfile: keyfile:
name: keyfile name: keyfile
description: >- description: "privkey.pem #sslkeyfile, must be located in /ssl"
privkey.pem #sslkeyfile, must be located in /ssl
whitelist: whitelist:
name: whitelist name: whitelist
description: >- description: '"localhost,192.168.0.0/16" # list ip subnets that won''t need a password'
"localhost,192.168.0.0/16" # list ip subnets that won't need a password
customUI: customUI:
name: customUI name: customUI
description: >- description: >-
selection from list # alternative webUI can be set here. Latest version set at each addon start selection from list # alternative webUI can be set here. Latest version
set at each addon start
DNS_servers: DNS_servers:
name: DNS_servers name: DNS_servers
description: >- description: >-
8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to avoid spamming in case of local DNS ad-remover 8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to
avoid spamming in case of local DNS ad-remover
openvpn_alt_mode: openvpn_alt_mode:
name: openvpn_alt_mode name: openvpn_alt_mode
description: >- description: bind at container level and not app level
bind at container level and not app level
openvpn_config: openvpn_config:
name: openvpn_config name: openvpn_config
description: >- description: 'for example "config.ovpn" # name of the file located in /config/openvpn'
for example "config.ovpn" # name of the file located in /config/openvpn

View File

@@ -3,108 +3,95 @@ configuration:
PGID: PGID:
name: PGID name: PGID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
PUID: PUID:
name: PUID name: PUID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
TZ: TZ:
name: TZ name: TZ
description: >- description: >-
The timezone, as described in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones The timezone, as described in
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
cifspassword: cifspassword:
name: cifspassword name: cifspassword
description: >- description: "Your password to access your SMB share, same for all smb shares"
Your password to access your SMB share, same for all smb shares
cifsusername: cifsusername:
name: cifsusername name: cifsusername
description: >- description: "Your username to access your SMB share, same for all smb shares"
Your username to access your SMB share, same for all smb shares
cifsdomain: cifsdomain:
name: cifsdomain name: cifsdomain
description: >- description: Allow setting the domain for the smb share
Allow setting the domain for the smb share
database: database:
name: database name: database
description: >- description: Type of database to use
Type of database to use
data_location: data_location:
name: data_location name: data_location
description: >- description: Where do you want your data stored
Where do you want your data stored
localdisks: localdisks:
name: localdisks name: localdisks
description: >- description: >-
Physical name of the partition (ex. sda1) or the share (ex. SharedFiles) to mount separated by commas (ex: sda1,sdb1,MYNAS) Physical name of the partition (ex. sda1) or the share (ex. SharedFiles)
to mount separated by commas (ex: sda1,sdb1,MYNAS)
networkdisks: networkdisks:
name: networkdisks name: networkdisks
description: >- description: "list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)"
list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)
DB_HOSTNAME: DB_HOSTNAME:
name: DB_HOSTNAME name: DB_HOSTNAME
description: >- description: If using external postgresql
If using external postgresql
DB_USERNAME: DB_USERNAME:
name: DB_USERNAME name: DB_USERNAME
description: >- description: If using external postgresql
If using external postgresql
DB_PORT: DB_PORT:
name: DB_PORT name: DB_PORT
description: >- description: If using external postgresql
If using external postgresql
DB_PASSWORD: DB_PASSWORD:
name: DB_PASSWORD name: DB_PASSWORD
description: >- description: If using external postgresql
If using external postgresql
DB_DATABASE_NAME: DB_DATABASE_NAME:
name: DB_DATABASE_NAME name: DB_DATABASE_NAME
description: >- description: If using external postgresql
If using external postgresql
UPLOAD_LOCATION: UPLOAD_LOCATION:
name: UPLOAD_LOCATION name: UPLOAD_LOCATION
description: >- description: This is the location where uploaded files are stored
This is the location where uploaded files are stored
JWT_SECRET: JWT_SECRET:
name: JWT_SECRET name: JWT_SECRET
description: >- description: Used to sign the authentication keys for user login
Used to sign the authentication keys for user login
run_duration: run_duration:
name: run_duration name: run_duration
description: >- description: >-
12h #for how long should the addon run. Must be formatted as number + time unit (ex : 5s, or 2m, or 12h, or 5d...) 12h #for how long should the addon run. Must be formatted as number + time
unit (ex : 5s, or 2m, or 12h, or 5d...)
silent: silent:
name: silent name: silent
description: >- description: "true #suppresses debug messages"
true #suppresses debug messages
ssl: ssl:
name: ssl name: ssl
description: >- description: "true/false : enables ssl. Need certfile and keyfile filled"
true/false : enables ssl. Need certfile and keyfile filled
certfile: certfile:
name: certfile name: certfile
description: >- description: "fullchain.pem #ssl certificate, must be located in /ssl"
fullchain.pem #ssl certificate, must be located in /ssl
keyfile: keyfile:
name: keyfile name: keyfile
description: >- description: "privkey.pem #sslkeyfile, must be located in /ssl"
privkey.pem #sslkeyfile, must be located in /ssl
whitelist: whitelist:
name: whitelist name: whitelist
description: >- description: '"localhost,192.168.0.0/16" # list ip subnets that won''t need a password'
"localhost,192.168.0.0/16" # list ip subnets that won't need a password
customUI: customUI:
name: customUI name: customUI
description: >- description: >-
selection from list # alternative webUI can be set here. Latest version set at each addon start selection from list # alternative webUI can be set here. Latest version
set at each addon start
DNS_servers: DNS_servers:
name: DNS_servers name: DNS_servers
description: >- description: >-
8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to avoid spamming in case of local DNS ad-remover 8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to
avoid spamming in case of local DNS ad-remover
openvpn_alt_mode: openvpn_alt_mode:
name: openvpn_alt_mode name: openvpn_alt_mode
description: >- description: bind at container level and not app level
bind at container level and not app level
openvpn_config: openvpn_config:
name: openvpn_config name: openvpn_config
description: >- description: 'for example "config.ovpn" # name of the file located in /config/openvpn'
for example "config.ovpn" # name of the file located in /config/openvpn

View File

@@ -3,108 +3,95 @@ configuration:
PGID: PGID:
name: PGID name: PGID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
PUID: PUID:
name: PUID name: PUID
description: >- description: >-
The user group ID, as described in https://docs.linuxserver.io/general/understanding-puid-and-pgid The user group ID, as described in
https://docs.linuxserver.io/general/understanding-puid-and-pgid
TZ: TZ:
name: TZ name: TZ
description: >- description: >-
The timezone, as described in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones The timezone, as described in
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
cifspassword: cifspassword:
name: cifspassword name: cifspassword
description: >- description: "Your password to access your SMB share, same for all smb shares"
Your password to access your SMB share, same for all smb shares
cifsusername: cifsusername:
name: cifsusername name: cifsusername
description: >- description: "Your username to access your SMB share, same for all smb shares"
Your username to access your SMB share, same for all smb shares
cifsdomain: cifsdomain:
name: cifsdomain name: cifsdomain
description: >- description: Allow setting the domain for the smb share
Allow setting the domain for the smb share
database: database:
name: database name: database
description: >- description: Type of database to use
Type of database to use
data_location: data_location:
name: data_location name: data_location
description: >- description: Where do you want your data stored
Where do you want your data stored
localdisks: localdisks:
name: localdisks name: localdisks
description: >- description: >-
Physical name of the partition (ex. sda1) or the share (ex. SharedFiles) to mount separated by commas (ex: sda1,sdb1,MYNAS) Physical name of the partition (ex. sda1) or the share (ex. SharedFiles)
to mount separated by commas (ex: sda1,sdb1,MYNAS)
networkdisks: networkdisks:
name: networkdisks name: networkdisks
description: >- description: "list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)"
list of smb servers to mount, separated by commas (//xxx.xx.xx.xx/share)
DB_HOSTNAME: DB_HOSTNAME:
name: DB_HOSTNAME name: DB_HOSTNAME
description: >- description: If using external postgresql
If using external postgresql
DB_USERNAME: DB_USERNAME:
name: DB_USERNAME name: DB_USERNAME
description: >- description: If using external postgresql
If using external postgresql
DB_PORT: DB_PORT:
name: DB_PORT name: DB_PORT
description: >- description: If using external postgresql
If using external postgresql
DB_PASSWORD: DB_PASSWORD:
name: DB_PASSWORD name: DB_PASSWORD
description: >- description: If using external postgresql
If using external postgresql
DB_DATABASE_NAME: DB_DATABASE_NAME:
name: DB_DATABASE_NAME name: DB_DATABASE_NAME
description: >- description: If using external postgresql
If using external postgresql
UPLOAD_LOCATION: UPLOAD_LOCATION:
name: UPLOAD_LOCATION name: UPLOAD_LOCATION
description: >- description: This is the location where uploaded files are stored
This is the location where uploaded files are stored
JWT_SECRET: JWT_SECRET:
name: JWT_SECRET name: JWT_SECRET
description: >- description: Used to sign the authentication keys for user login
Used to sign the authentication keys for user login
run_duration: run_duration:
name: run_duration name: run_duration
description: >- description: >-
12h #for how long should the addon run. Must be formatted as number + time unit (ex : 5s, or 2m, or 12h, or 5d...) 12h #for how long should the addon run. Must be formatted as number + time
unit (ex : 5s, or 2m, or 12h, or 5d...)
silent: silent:
name: silent name: silent
description: >- description: "true #suppresses debug messages"
true #suppresses debug messages
ssl: ssl:
name: ssl name: ssl
description: >- description: "true/false : enables ssl. Need certfile and keyfile filled"
true/false : enables ssl. Need certfile and keyfile filled
certfile: certfile:
name: certfile name: certfile
description: >- description: "fullchain.pem #ssl certificate, must be located in /ssl"
fullchain.pem #ssl certificate, must be located in /ssl
keyfile: keyfile:
name: keyfile name: keyfile
description: >- description: "privkey.pem #sslkeyfile, must be located in /ssl"
privkey.pem #sslkeyfile, must be located in /ssl
whitelist: whitelist:
name: whitelist name: whitelist
description: >- description: '"localhost,192.168.0.0/16" # list ip subnets that won''t need a password'
"localhost,192.168.0.0/16" # list ip subnets that won't need a password
customUI: customUI:
name: customUI name: customUI
description: >- description: >-
selection from list # alternative webUI can be set here. Latest version set at each addon start selection from list # alternative webUI can be set here. Latest version
set at each addon start
DNS_servers: DNS_servers:
name: DNS_servers name: DNS_servers
description: >- description: >-
8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to avoid spamming in case of local DNS ad-remover 8.8.8.8,1.1.1.1 # Keep blank to use routers DNS, or set custom DNS to
avoid spamming in case of local DNS ad-remover
openvpn_alt_mode: openvpn_alt_mode:
name: openvpn_alt_mode name: openvpn_alt_mode
description: >- description: bind at container level and not app level
bind at container level and not app level
openvpn_config: openvpn_config:
name: openvpn_config name: openvpn_config
description: >- description: 'for example "config.ovpn" # name of the file located in /config/openvpn'
for example "config.ovpn" # name of the file located in /config/openvpn