UniFi-Voucher-Site

UniFi-Voucher-Site

Application Docker from grtgbln's Repository

Vue d'ensemble

UniFi Voucher Site is a web-based platform for generating and managing UniFi network guest vouchers.

Exigences


        Can be configured via an `options.json` file or via environmental variables.
    

Arguments d'exécution

Interface utilisateur Web
http://[IP]:[PORT:3000]/
Réseau
bridge
Privilégié
false

Configuration du modèle

Web UI PortPorttcp

Container Port: 3000

Cible
3000
Défaut
3000
Valeur
3000
Config FilePath

Config file. Remove to use environmental variables instead.

Cible
/data/options.json
Défaut
/mnt/user/appdata/unifi_voucher_site/options.json
Valeur
/mnt/user/appdata/unifi_voucher_site/options.json
UniFi OS Console - IP AddressVariable

IP address of the UniFi OS Console

Cible
UNIFI_IP
UniFi OS Console - PortVariable

Port of the UniFi OS Console

Cible
UNIFI_PORT
Défaut
443
Valeur
443
UniFi OS Console - TokenVariable

The API Key created on the integrations tab within UniFi OS

Cible
UNIFI_TOKEN
UniFi OS Console - Site IDVariable

Site ID for the UniFi OS Console

Cible
UNIFI_SITE_ID
Défaut
default
Valeur
default
UniFi OS Console - SSIDVariable

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

Cible
UNIFI_SSID
UniFi OS Console - SSID PasswordVariable

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

Cible
UNIFI_SSID_PASSWORD
Authentication - Web UI - EnableVariable

Enable internal authentication for the voucher portal web UI

Cible
AUTH_INTERNAL_ENABLED
Défaut
true|false
Authentication - Web UI - PasswordVariable

Password for internal authentication for the voucher portal web UI

Cible
AUTH_INTERNAL_PASSWORD
Authentication - OIDC - EnableVariable

Enable OpenID Connect authentication for the voucher portal web UI

Cible
AUTH_OIDC_ENABLED
Défaut
false|true
Authentication - OIDC - Issuer Base URLVariable

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

Cible
AUTH_OIDC_ISSUER_BASE_URL
Authentication - OIDC - App Base URLVariable

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

Cible
AUTH_OIDC_APP_BASE_URL
Authentication - OIDC - Client IDVariable

OIDC client id provided by oauth provider

Cible
AUTH_OIDC_CLIENT_ID
Authentication - OIDC - Client SecretVariable

OIDC client secret provided by oauth provider

Cible
AUTH_OIDC_CLIENT_SECRET
Authentication - API - Bearer TokenVariable

The bearer token used for the API

Cible
AUTH_INTERNAL_BEARER_TOKEN
Authentication - Limit Admins to Own OrganizationVariable

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.

Cible
PIN_OIDC_USER_TO_OWN_DOMAIN
Défaut
false|true
Voucher TypesVariable

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)

Cible
VOUCHER_TYPES
Défaut
480,1,,,;
Valeur
480,1,,,;
Allow Custom Voucher TypesVariable

Allow users to create custom vouchers types within the UI

Cible
VOUCHER_CUSTOM
Défaut
false|true
PrintersVariable

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

Cible
PRINTERS
Email - From AddressVariable

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

Cible
SMTP_FROM
Email - SMTP HostVariable

The SMTP host to use for sending emails

Cible
SMTP_HOST
Email - SMTP PortVariable

The SMTP port to use for sending emails

Cible
SMTP_PORT
Défaut
587
Valeur
587
Email - Use TLSVariable

Use TLS for the SMTP connection

Cible
SMTP_SECURE
Défaut
false|true
Email - SMTP UsernameVariable

The SMTP username to use for sending emails

Cible
SMTP_USERNAME
Email - SMTP PasswordVariable

The SMTP password to use for sending emails

Cible
SMTP_PASSWORD
Kiosk - EnableVariable

Enable/disable the kiosk page on /kiosk

Cible
KIOSK_ENABLED
Défaut
false|true
Kiosk - Voucher TypesVariable

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)

Cible
KIOSK_VOUCHER_TYPES
Défaut
480,1,,,;
Valeur
480,1,,,;
Kiosk - Guest Name RequiredVariable

Require the guest to enter their name on the kiosk page

Cible
KIOSK_NAME_REQUIRED
Défaut
false|true
Kiosk - TimeoutVariable

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

Cible
KIOSK_TIMEOUT
Défaut
60
Valeur
60
Kiosk - HomepageVariable

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

Cible
KIOSK_HOMEPAGE
Défaut
false|true
Kiosk - EmailVariable

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

Cible
KIOSK_EMAIL
Défaut
false|true
Kiosk - Printer IPVariable

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

Cible
KIOSK_PRINTER
Tasks - Cleanup Expired VouchersVariable

Enable/disable automatic cleanup of expired vouchers

Cible
TASK_CLEANUP_EXPIRED
Défaut
false|true
Tasks - Cleanup Unused VouchersVariable

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

Cible
TASK_CLEANUP_UNUSED
Défaut
false|true
Log LevelVariable

Log level for the application

Cible
LOG_LEVEL
Défaut
info|error|debug
Authentication - DisableVariable

Disable all authentication methods

Cible
AUTH_DISABLE
Défaut
false|true
Enable Web UIVariable

Enable the web UI

Cible
SERVICE_WEB
Défaut
true|false
Enable APIVariable

Enable the API

Cible
SERVICE_API
Défaut
true|false
Translation - Default LanguageVariable

Sets the default translation for dropdowns

Cible
TRANSLATION_DEFAULT
Défaut
en
Valeur
en
Translation - Hidden LanguagesVariable

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

Cible
TRANSLATION_HIDDEN_LANGUAGES
Translation - DebugVariable

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

Cible
TRANSLATION_DEBUG
Défaut
false|true

Télécharger les statistiques

39,225
Total des téléchargements
4,608
Ce mois-ci
3,068
Moyenne / Mois

Total des téléchargements au fil du temps

Chargement du graphique...

Détails

Référentiel
glenndehaan/unifi-voucher-site:latest
Dernière mise à jour2026-04-13
Première vue2025-04-25

Exécutez UniFi-Voucher-Site sur Unraid.

UniFi-Voucher-Site est listé dans Community Apps pour Unraid OS. Explorez Unraid pour créer un serveur domestique flexible, un NAS ou un laboratoire domestique.