UniFi-Voucher-Site
UniFi-Voucher-Site
Docker app from grtgbln's Repository
Overview
Requirements
Can be configured via an `options.json` file or via environmental variables.
Runtime arguments
- Web UI
http://[IP]:[PORT:3000]/- Network
bridge- Privileged
- false
Template configuration
Container Port: 3000
- Target
- 3000
- Default
- 3000
- Value
- 3000
Config file. Remove to use environmental variables instead.
- Target
- /data/options.json
- Default
- /mnt/user/appdata/unifi_voucher_site/options.json
- Value
- /mnt/user/appdata/unifi_voucher_site/options.json
IP address of the UniFi OS Console
- Target
- UNIFI_IP
Port of the UniFi OS Console
- Target
- UNIFI_PORT
- Default
- 443
- Value
- 443
The API Key created on the integrations tab within UniFi OS
- Target
- UNIFI_TOKEN
Site ID for the UniFi OS Console
- Target
- UNIFI_SITE_ID
- Default
- default
- Value
- default
The UniFi SSID where guests need to connect to (Used within templating and 'Scan to Connect')
- Target
- UNIFI_SSID
The UniFi SSID WPA/WPA2/WPA3 Password (Can be ignored for 'Open' networks) (Used within templating and 'Scan to Connect')
- Target
- UNIFI_SSID_PASSWORD
Enable internal authentication for the voucher portal web UI
- Target
- AUTH_INTERNAL_ENABLED
- Default
- true|false
Password for internal authentication for the voucher portal web UI
- Target
- AUTH_INTERNAL_PASSWORD
Enable OpenID Connect authentication for the voucher portal web UI
- Target
- AUTH_OIDC_ENABLED
- Default
- false|true
OIDC issuer base url provided by oauth provider. Example: https://auth.example.com/.well-known/openid-configuration
- Target
- AUTH_OIDC_ISSUER_BASE_URL
OIDC UniFi Voucher base url (This application). Example: https://voucher.example.com
- Target
- AUTH_OIDC_APP_BASE_URL
OIDC client id provided by oauth provider
- Target
- AUTH_OIDC_CLIENT_ID
OIDC client secret provided by oauth provider
- Target
- AUTH_OIDC_CLIENT_SECRET
The bearer token used for the API
- Target
- 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.
- Target
- PIN_OIDC_USER_TO_OWN_DOMAIN
- Default
- 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)
- Target
- VOUCHER_TYPES
- Default
- 480,1,,,;
- Value
- 480,1,,,;
Allow users to create custom vouchers types within the UI
- Target
- VOUCHER_CUSTOM
- Default
- false|true
A comma-separated list of printer formats and IPs. Example: 'pdf,192.168.1.10'
- Target
- PRINTERS
The email address that will be used as the sender of the emails
- Target
- SMTP_FROM
The SMTP host to use for sending emails
- Target
- SMTP_HOST
The SMTP port to use for sending emails
- Target
- SMTP_PORT
- Default
- 587
- Value
- 587
Use TLS for the SMTP connection
- Target
- SMTP_SECURE
- Default
- false|true
The SMTP username to use for sending emails
- Target
- SMTP_USERNAME
The SMTP password to use for sending emails
- Target
- SMTP_PASSWORD
Enable/disable the kiosk page on /kiosk
- Target
- KIOSK_ENABLED
- Default
- 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)
- Target
- KIOSK_VOUCHER_TYPES
- Default
- 480,1,,,;
- Value
- 480,1,,,;
Require the guest to enter their name on the kiosk page
- Target
- KIOSK_NAME_REQUIRED
- Default
- false|true
Sets the Kiosk timeout in seconds (Returns the user back to the starting page after inactivity)
- Target
- KIOSK_TIMEOUT
- Default
- 60
- Value
- 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)
- Target
- KIOSK_HOMEPAGE
- Default
- false|true
Enable/disable the email voucher button (Requires SMTP to be setup)
- Target
- KIOSK_EMAIL
- Default
- false|true
Enable a printer for Kiosk Vouchers (this automatically prints vouchers), e.g. an ESC/POS-compatible printer
- Target
- KIOSK_PRINTER
Enable/disable automatic cleanup of expired vouchers
- Target
- TASK_CLEANUP_EXPIRED
- Default
- false|true
Enable/disable automatic cleanup of unused (> 1 day) vouchers
- Target
- TASK_CLEANUP_UNUSED
- Default
- false|true
Log level for the application
- Target
- LOG_LEVEL
- Default
- info|error|debug
Disable all authentication methods
- Target
- AUTH_DISABLE
- Default
- false|true
Enable the web UI
- Target
- SERVICE_WEB
- Default
- true|false
Enable the API
- Target
- SERVICE_API
- Default
- true|false
Sets the default translation for dropdowns
- Target
- TRANSLATION_DEFAULT
- Default
- en
- Value
- en
A comma-separated list of language codes to hide from the language selection dropdown
- Target
- TRANSLATION_HIDDEN_LANGUAGES
Enables/disables translation debugging, when enabled only translation keys are shown
- Target
- TRANSLATION_DEBUG
- Default
- false|true
Download Statistics
Total Downloads Over Time
Details
glenndehaan/unifi-voucher-site:latestRun UniFi-Voucher-Site on Unraid.
UniFi-Voucher-Site is listed in Community Apps for Unraid OS. Explore Unraid to build a flexible home server, NAS, or homelab.