Container Port: 3000

Ziel

3000

Standard

3000

Wert

3000

Config file. Remove to use environmental variables instead.

Ziel

/data/options.json

Standard

/mnt/user/appdata/unifi_voucher_site/options.json

Wert

/mnt/user/appdata/unifi_voucher_site/options.json

IP address of the UniFi OS Console

Ziel

UNIFI_IP

Port of the UniFi OS Console

Ziel

UNIFI_PORT

Standard

443

Wert

443

The API Key created on the integrations tab within UniFi OS

Ziel

UNIFI_TOKEN

Site ID for the UniFi OS Console

Ziel

UNIFI_SITE_ID

Standard

default

Wert

default

The UniFi SSID where guests need to connect to (Used within templating and 'Scan to Connect')

Ziel

UNIFI_SSID

The UniFi SSID WPA/WPA2/WPA3 Password (Can be ignored for 'Open' networks) (Used within templating and 'Scan to Connect')

Ziel

UNIFI_SSID_PASSWORD

Enable internal authentication for the voucher portal web UI

Ziel

AUTH_INTERNAL_ENABLED

Standard

true|false

Password for internal authentication for the voucher portal web UI

Ziel

AUTH_INTERNAL_PASSWORD

Enable OpenID Connect authentication for the voucher portal web UI

Ziel

AUTH_OIDC_ENABLED

Standard

false|true

OIDC issuer base url provided by oauth provider. Example: https://auth.example.com/.well-known/openid-configuration

Ziel

AUTH_OIDC_ISSUER_BASE_URL

OIDC UniFi Voucher base url (This application). Example: https://voucher.example.com

Ziel

AUTH_OIDC_APP_BASE_URL

OIDC client id provided by oauth provider

Ziel

AUTH_OIDC_CLIENT_ID

OIDC client secret provided by oauth provider

Ziel

AUTH_OIDC_CLIENT_SECRET

The bearer token used for the API

Ziel

AUTH_INTERNAL_BEARER_TOKEN

Limit voucher administrators to managing only vouchers associated with their own organization. If enabled, system automatically assigns the administrator’s email domain as a note to each created voucher.

Ziel

PIN_OIDC_USER_TO_OWN_DOMAIN

Standard

false|true

A semi-colon-separated list of voucher types in the following format: expiration in minutes (required),single-use or multi-use vouchers value - '0' is for multi-use (unlimited) - '1' is for single-use - 'N' is for multi-use (Nx) (optional),upload speed limit in kbps (optional),download speed limit in kbps (optional),data transfer limit in MB (optional)

Ziel

VOUCHER_TYPES

Standard

480,1,,,;

Wert

480,1,,,;

Allow users to create custom vouchers types within the UI

Ziel

VOUCHER_CUSTOM

Standard

false|true

A comma-separated list of printer formats and IPs. Example: 'pdf,192.168.1.10'

Ziel

PRINTERS

The email address that will be used as the sender of the emails

Ziel

SMTP_FROM

The SMTP host to use for sending emails

Ziel

SMTP_HOST

The SMTP port to use for sending emails

Ziel

SMTP_PORT

Standard

587

Wert

587

Use TLS for the SMTP connection

Ziel

SMTP_SECURE

Standard

false|true

The SMTP username to use for sending emails

Ziel

SMTP_USERNAME

The SMTP password to use for sending emails

Ziel

SMTP_PASSWORD

Enable/disable the kiosk page on /kiosk

Ziel

KIOSK_ENABLED

Standard

false|true

A semi-colon-separated list of voucher types in the following format: expiration in minutes (required),single-use or multi-use vouchers value - '0' is for multi-use (unlimited) - '1' is for single-use - 'N' is for multi-use (Nx) (optional),upload speed limit in kbps (optional),download speed limit in kbps (optional),data transfer limit in MB (optional)

Ziel

KIOSK_VOUCHER_TYPES

Standard

480,1,,,;

Wert

480,1,,,;

Require the guest to enter their name on the kiosk page

Ziel

KIOSK_NAME_REQUIRED

Standard

false|true

Sets the Kiosk timeout in seconds (Returns the user back to the starting page after inactivity)

Ziel

KIOSK_TIMEOUT

Standard

60

Wert

60

Enable/disable an override to redirect to the Kiosk on the / url (Also enables a link from the Kiosk back to the Admin UI)

Ziel

KIOSK_HOMEPAGE

Standard

false|true

Enable/disable the email voucher button (Requires SMTP to be setup)

Ziel

KIOSK_EMAIL

Standard

false|true

Enable a printer for Kiosk Vouchers (this automatically prints vouchers), e.g. an ESC/POS-compatible printer

Ziel

KIOSK_PRINTER

Enable/disable automatic cleanup of expired vouchers

Ziel

TASK_CLEANUP_EXPIRED

Standard

false|true

Enable/disable automatic cleanup of unused (> 1 day) vouchers

Ziel

TASK_CLEANUP_UNUSED

Standard

false|true

Log level for the application

Ziel

LOG_LEVEL

Standard

info|error|debug

Disable all authentication methods

Ziel

AUTH_DISABLE

Standard

false|true

Enable the web UI

Ziel

SERVICE_WEB

Standard

true|false

Enable the API

Ziel

SERVICE_API

Standard

true|false

Sets the default translation for dropdowns

Ziel

TRANSLATION_DEFAULT

Standard

en

Wert

en

A comma-separated list of language codes to hide from the language selection dropdown

Ziel

TRANSLATION_HIDDEN_LANGUAGES

Enables/disables translation debugging, when enabled only translation keys are shown

Ziel

TRANSLATION_DEBUG

Standard

false|true