UniFi-Voucher-Site

UniFi-Voucher-Site

Docker 应用程序 from grtgbln's Repository

概述

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

要求


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

运行时参数

网络用户界面
http://[IP]:[PORT:3000]/
网络
bridge
特权
false

模板配置

Web UI PortPorttcp

Container Port: 3000

目标
3000
默认值
3000
价值
3000
Config FilePath

Config file. Remove to use environmental variables instead.

目标
/data/options.json
默认值
/mnt/user/appdata/unifi_voucher_site/options.json
价值
/mnt/user/appdata/unifi_voucher_site/options.json
UniFi OS Console - IP AddressVariable

IP address of the UniFi OS Console

目标
UNIFI_IP
UniFi OS Console - PortVariable

Port of the UniFi OS Console

目标
UNIFI_PORT
默认值
443
价值
443
UniFi OS Console - TokenVariable

The API Key created on the integrations tab within UniFi OS

目标
UNIFI_TOKEN
UniFi OS Console - Site IDVariable

Site ID for the UniFi OS Console

目标
UNIFI_SITE_ID
默认值
default
价值
default
UniFi OS Console - SSIDVariable

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

目标
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')

目标
UNIFI_SSID_PASSWORD
Authentication - Web UI - EnableVariable

Enable internal authentication for the voucher portal web UI

目标
AUTH_INTERNAL_ENABLED
默认值
true|false
Authentication - Web UI - PasswordVariable

Password for internal authentication for the voucher portal web UI

目标
AUTH_INTERNAL_PASSWORD
Authentication - OIDC - EnableVariable

Enable OpenID Connect authentication for the voucher portal web UI

目标
AUTH_OIDC_ENABLED
默认值
false|true
Authentication - OIDC - Issuer Base URLVariable

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

目标
AUTH_OIDC_ISSUER_BASE_URL
Authentication - OIDC - App Base URLVariable

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

目标
AUTH_OIDC_APP_BASE_URL
Authentication - OIDC - Client IDVariable

OIDC client id provided by oauth provider

目标
AUTH_OIDC_CLIENT_ID
Authentication - OIDC - Client SecretVariable

OIDC client secret provided by oauth provider

目标
AUTH_OIDC_CLIENT_SECRET
Authentication - API - Bearer TokenVariable

The bearer token used for the API

目标
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.

目标
PIN_OIDC_USER_TO_OWN_DOMAIN
默认值
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)

目标
VOUCHER_TYPES
默认值
480,1,,,;
价值
480,1,,,;
Allow Custom Voucher TypesVariable

Allow users to create custom vouchers types within the UI

目标
VOUCHER_CUSTOM
默认值
false|true
PrintersVariable

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

目标
PRINTERS
Email - From AddressVariable

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

目标
SMTP_FROM
Email - SMTP HostVariable

The SMTP host to use for sending emails

目标
SMTP_HOST
Email - SMTP PortVariable

The SMTP port to use for sending emails

目标
SMTP_PORT
默认值
587
价值
587
Email - Use TLSVariable

Use TLS for the SMTP connection

目标
SMTP_SECURE
默认值
false|true
Email - SMTP UsernameVariable

The SMTP username to use for sending emails

目标
SMTP_USERNAME
Email - SMTP PasswordVariable

The SMTP password to use for sending emails

目标
SMTP_PASSWORD
Kiosk - EnableVariable

Enable/disable the kiosk page on /kiosk

目标
KIOSK_ENABLED
默认值
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)

目标
KIOSK_VOUCHER_TYPES
默认值
480,1,,,;
价值
480,1,,,;
Kiosk - Guest Name RequiredVariable

Require the guest to enter their name on the kiosk page

目标
KIOSK_NAME_REQUIRED
默认值
false|true
Kiosk - TimeoutVariable

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

目标
KIOSK_TIMEOUT
默认值
60
价值
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)

目标
KIOSK_HOMEPAGE
默认值
false|true
Kiosk - EmailVariable

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

目标
KIOSK_EMAIL
默认值
false|true
Kiosk - Printer IPVariable

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

目标
KIOSK_PRINTER
Tasks - Cleanup Expired VouchersVariable

Enable/disable automatic cleanup of expired vouchers

目标
TASK_CLEANUP_EXPIRED
默认值
false|true
Tasks - Cleanup Unused VouchersVariable

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

目标
TASK_CLEANUP_UNUSED
默认值
false|true
Log LevelVariable

Log level for the application

目标
LOG_LEVEL
默认值
info|error|debug
Authentication - DisableVariable

Disable all authentication methods

目标
AUTH_DISABLE
默认值
false|true
Enable Web UIVariable

Enable the web UI

目标
SERVICE_WEB
默认值
true|false
Enable APIVariable

Enable the API

目标
SERVICE_API
默认值
true|false
Translation - Default LanguageVariable

Sets the default translation for dropdowns

目标
TRANSLATION_DEFAULT
默认值
en
价值
en
Translation - Hidden LanguagesVariable

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

目标
TRANSLATION_HIDDEN_LANGUAGES
Translation - DebugVariable

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

目标
TRANSLATION_DEBUG
默认值
false|true

下载统计数据

39,225
下载总数
4,608
本月
3,068
平均每月

长期下载总量

加载图表...

详细信息

存储库
glenndehaan/unifi-voucher-site:latest
最后更新2026-04-13
初见2025-04-25

在Unraid 上运行 UniFi-Voucher-Site 。

UniFi-Voucher-Site 已被列入Unraid OS 的社区应用程序。探索Unraid ,构建灵活的家庭服务器、NAS 或家庭实验室。