search

glenndehaan / unifi-voucher-site

UniFi Voucher Site is a web-based platform for generating and managing UniFi network guest vouchers
MIT License
51 stars 9 forks source link
express home-assistant nodejs unifi unifi-voucher-site

readme

UniFi Voucher Site

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

GitHub last commit Docker image size Crowdin

Vouchers Overview - Desktop

Upgrading from 3.x to 4.x? Please take a look at the migration guide

Features

Structure

Prerequisites

Follow this guide to set up the Hotspot Portal, then continue with the installation below

Ensure voucher authentication is enabled within the Hotspot Portal

Attention!: We recommend only using Local UniFi accounts due to short token lengths provided by UniFi Cloud Accounts. Also, UniFi Cloud Accounts using 2FA are not supported!

Note: When creating a Local UniFi account ensure you give 'Full Management' access rights to the Network controller. The 'Hotspot Role' won't give access to the API and therefore the application will throw errors.

Installation

Docker

You can easily run UniFi Voucher Site using Docker. We provide two release tracks to ensure you have flexibility in how you manage your deployments:

Below is an example docker-compose.yml file that can help you get started:

version: '3'
services:
  app:
    image: glenndehaan/unifi-voucher-site:latest
    ports:
      - "3000:3000"
    environment:
      # The IP address to your UniFi OS Console
      UNIFI_IP: '192.168.1.1'
      # The port of your UniFi OS Console, this could be 443 or 8443
      UNIFI_PORT: 443
      # The username of a local UniFi OS account
      UNIFI_USERNAME: 'admin'
      # The password of a local UniFi OS account
      UNIFI_PASSWORD: 'password'
      # The UniFi Site ID
      UNIFI_SITE_ID: 'default'
      # The UniFi SSID where guests need to connect to (Used within templating and 'Scan to Connect')
      UNIFI_SSID: ''
      # The UniFi SSID WPA/WPA2/WPA3 Password (Can be ignored for 'Open' networks) (Used within templating and 'Scan to Connect')
      UNIFI_SSID_PASSWORD: ''
      # Toggle to enable/disable internal authentication
      AUTH_INTERNAL_ENABLED: 'true'
      # The password used to log in to the voucher portal Web UI
      AUTH_INTERNAL_PASSWORD: '0000'
      # The Bearer token used for the API
      AUTH_INTERNAL_BEARER_TOKEN: '00000000-0000-0000-0000-000000000000'
      # Toggle to enable/disable OIDC authentication
      AUTH_OIDC_ENABLED: 'false'
      # OIDC issuer base url provided by oauth provider. Example: https://auth.example.com/.well-known/openid-configuration
      AUTH_OIDC_ISSUER_BASE_URL: ''
      # OIDC UniFi Voucher base url (This application). Example: https://voucher.example.com
      AUTH_OIDC_APP_BASE_URL: ''
      # OIDC client id provided by oauth provider
      AUTH_OIDC_CLIENT_ID: ''
      # OIDC client secret provided by oauth provider
      AUTH_OIDC_CLIENT_SECRET: ''
      # Disables the login/authentication for the portal and API
      AUTH_DISABLE: 'false'
      # Voucher Types, format: expiration in minutes (required),single-use or multi-use vouchers value - '0' is for multi-use - '1' is for single-use (optional),upload speed limit in kbps (optional),download speed limit in kbps (optional),data transfer limit in MB (optional)
      # To skip a parameter just but nothing in between the comma's
      # After a voucher type add a semicolon, after the semicolon you can start a new voucher type
      VOUCHER_TYPES: '480,1,,,;'
      # Allow users to create custom vouchers types within the UI
      VOUCHER_CUSTOM: 'true'
      # Enable/disable the Web UI
      SERVICE_WEB: 'true'
      # Enable/disable the API
      SERVICE_API: 'false'
      # Enable/disable the printer and set the preferred type, currently supported types: pdf, escpos
      PRINTER_TYPE: ''
      # IP address to your network enabled ESC/POS compatible printer (Only required when using PRINTER_TYPE: 'escpos')
      PRINTER_IP: '192.168.1.1'
      # SMTP Mail from email address (optional)
      SMTP_FROM: ''
      # SMTP Mail server hostname/ip (optional)
      SMTP_HOST: ''
      # SMTP Mail server port (optional)
      SMTP_PORT: ''
      # SMTP Mail use TLS? (optional)
      SMTP_SECURE: 'false'
      # SMTP Mail username (optional)
      SMTP_USERNAME: ''
      # SMTP Mail password (optional)
      SMTP_PASSWORD: ''
      # Sets the application Log Level (Valid Options: error|warn|info|debug|trace)
      LOG_LEVEL: 'info'
      # Enables/disables translation debugging, when enabled only translation keys are shown
      TRANSLATION_DEBUG: 'false'

Home Assistant Add-on

For users of Home Assistant, we provide a dedicated add-on to seamlessly integrate the UniFi Voucher Site with your Home Assistant instance. This add-on simplifies the setup process and allows you to manage UniFi vouchers directly from your Home Assistant dashboard.

Open your Home Assistant instance and show the add add-on repository dialog with a specific repository URL pre-filled.

Manual Installation

To install the UniFi Voucher Site add-on for Home Assistant, follow these steps:

  1. Open the Supervisor panel in your Home Assistant instance.
  2. Navigate to the "Add-on Store."
  3. Add our repository to the list of repositories by clicking the three dots in the upper-right corner, then selecting "Repositories," and entering the URL of our repository: https://github.com/glenndehaan/ha-addons.
  4. Once the repository is added, you will find the "UniFi Voucher Site" add-on in the add-on store. Click on it.
  5. Click "Install" and wait for the installation to complete.

Development

Then open up your favorite browser and go to http://localhost:3000/

Services

The project consists of two main services: Web and API.

Web Service

The Web service is a user interface accessible through a web browser. It provides functionality for generating, viewing, and managing vouchers within the UniFi system.

API Service

The API service allows programmatic access to voucher-related functionalities. It is designed for developers who wish to integrate voucher management into their applications or automate voucher generation processes. Below are the details of the different endpoints available in the API:

Endpoints

  1. /api
    • Method: GET
    • Description: Retrieves information about the API and its endpoints.
    • Access: Open
    • Response Example:
{
  "error": null,
  "data": {
    "message": "OK",
    "endpoints": [
      "/api",
      "/api/types",
      "/api/voucher/:type",
      "/api/vouchers"
    ]
  }
}
  1. /api/types
    • Method: GET
    • Description: Retrieves a list of available voucher types supported by the system.
    • Response Format: JSON
    • Access: Open
    • Response Example:
{
  "error": null,
  "data": {
    "message": "OK",
    "types": [
      {
        "expiration": "480",
        "usage": "0",
        "raw": "480,0,,,"
      }
    ]
  }
}
  1. /api/voucher/:type
    • Method: GET
    • Description: Generates a voucher of the specified type.
    • Parameters:
      • type (string): The type of voucher to generate.
    • Response Format: JSON
    • Access: Protected by Bearer Token
    • Response Example:
{
  "error": null,
  "data": {
    "message": "OK",
    "voucher": "12345-67890"
  }
}

This endpoint is protected by a security mechanism. To access it, users need to include a bearer token in the request authorization header. The token must match the value of the AUTH_INTERNAL_BEARER_TOKEN environment variable. Without this token, access to the endpoint will be denied.

  1. /api/vouchers
    • Method: GET
    • Description: Retrieves a list of available vouchers.
    • Response Format: JSON
    • Access: Protected by Bearer Token
    • Response Example:
{
  "error": null,
  "data": {
    "message": "OK",
    "vouchers": [
      {
        "code": "15695-53133",
        "type": "multi",
        "duration": 60,
        "data_limit": "200",
        "download_limit": "5000",
        "upload_limit": "2000"
      },
      {
        "code": "03004-59449",
        "type": "single",
        "duration": 480,
        "data_limit": null,
        "download_limit": null,
        "upload_limit": null
      }
    ],
    "updated": 1712934667937
  }
}

This endpoint is protected by a security mechanism. To access it, users need to include a bearer token in the request authorization header. The token must match the value of the AUTH_INTERNAL_BEARER_TOKEN environment variable. Without this token, access to the endpoint will be denied.

Authentication

The UniFi Voucher Site provides three options for authenticating access to the web service.

Note that these options only affect the web service; the API service uses a different authentication method, which is explained above.

1. Internal Authentication (Default)

By default, the UniFi Voucher Site uses an internal authentication method. You can set the password for this internal authentication using the AUTH_INTERNAL_PASSWORD environment variable.

AUTH_INTERNAL_PASSWORD: '0000'

To enable/disable internal authentication use the AUTH_INTERNAL_ENABLED environment variable

2. OpenID Connect (OIDC) Authentication

The UniFi Voucher Site allows seamless integration with OpenID Connect (OIDC), enabling users to authenticate through their preferred identity provider (IdP). Configuration is easy using environment variables to align with your existing OIDC provider.

Configuration

To enable OIDC authentication, set the following environment variables in your application’s environment:

Ensure your idP supports Confidential Clients with the Authorization Code Flow

Determine Supported Client Types

To identify which client types your OpenID Connect (OIDC) provider supports, you can check the .well-known/openid-configuration endpoint. This endpoint contains metadata about the OIDC provider, including the supported flows and grant types.

  1. Access the .well-known/openid-configuration URL:

    The URL is typically structured like this:

    https://auth.example.com/.well-known/openid-configuration

  2. Look for the grant_types_supported Field:

    In the returned JSON, the grant_types_supported field will indicate the flows your provider supports: Check if your response contains authorization_code.

    Example snippet:

    {
 "grant_types_supported": [
   "authorization_code",
   "implicit",
   "refresh_token",
   "client_credentials"
 ]
}

OIDC IdP Integration Guides

This section provides integration guides for configuring the UniFi Voucher Site with various OIDC (OpenID Connect) Identity Providers (IdPs). These guides cover the necessary steps for setting up the IdP, configuring client credentials, and integrating the IdP with the UniFi Voucher Site.

Below is a list of tested Identity Providers (IdPs) with detailed integration instructions:

Integrated with an IdP that is not on the list? Feel free to create a guide for others and contribute it to the project

3. Disabling Authentication

If you prefer not to use any authentication for the web and api service, you can disable it entirely by setting the AUTH_DISABLE environment variable.

AUTH_DISABLE: 'true'

Note: This disables the token based authentication on the API

Print Functionality

The UniFi Voucher Site application includes built-in support for printing vouchers using 80mm receipt printers, offering a convenient way to distribute vouchers in physical format.

Compatibility

The print functionality is compatible with most 80mm thermal receipt printers commonly used in various industries. These printers typically use thermal printing technology, eliminating the need for ink cartridges and ensuring efficient and cost-effective voucher printing.

Configuration

To enable the print feature, you need to set the following environment variables:

PRINTER_TYPE: ''
PRINTER_IP: ''

Here’s what each variable represents:

Usage

PDF

If you're using the PDF option, once your 80mm receipt printer is configured and connected to your local client, you can easily export vouchers to pdf from the UniFi Voucher Site application. Simply navigate to the voucher within the interface and click on the "Print" button.

The application will automatically format the voucher for 80mm paper width, ensuring optimal printing results. Depending on your printer settings and preferences, you may adjust print quality, paper type, and other printing parameters to suit your needs.

Example PDF

Example PDF

ESC/POS

For network-enabled ESC/POS compatible printers, set the PRINTER_TYPE to escpos and provide the printer's IP address in the PRINTER_IP variable. Once configured, you can print vouchers directly to your network printer from the UniFi Voucher Site application.

Just like with PDF printing, navigate to the voucher and click on the "Print" button. The application will send the print job directly to the ESC/POS printer over the network, ensuring quick and seamless voucher printing. Make sure your printer supports ESC/POS commands and is correctly configured to accept print jobs over the network.

Tested Printers
Example Print

Example Print

Email Functionality

The UniFi Voucher Site includes a convenient email feature that allows you to send vouchers directly to users from the web interface. By configuring the SMTP settings, you can enable email sending and make it easy to distribute vouchers digitally.

Configuration

To enable the email feature, you need to set the following environment variables with your SMTP server details:

SMTP_FROM: ''
SMTP_HOST: ''
SMTP_PORT: ''
SMTP_SECURE: ''
SMTP_USERNAME: ''
SMTP_PASSWORD: ''

Here’s what each variable represents:

These settings allow the application to connect to your SMTP server and send emails on your behalf.

Usage

Once the SMTP environment variables are configured, the email feature will be available within the UniFi Voucher Site interface. After generating a voucher, you will see an option to send the voucher via email. Enter the recipient's email address, and the application will send the voucher details directly to their inbox.

Example Email

Example Email

Translations

The UniFi Voucher Site supports multiple languages, and we're actively working to expand the list of available translations. To facilitate this, we use Crowdin, a platform that allows people from around the world to help translate and improve the localization of the project.

How to help

If you'd like to contribute by translating the UniFi Voucher Site into your language or improve existing translations, you're welcome to join our project on Crowdin. Even small contributions can make a big difference!

Simply visit our Crowdin project page by clicking the badge below:

Crowdin

Once you're there, you can choose your language and start contributing immediately. Crowdin provides an intuitive interface to help you suggest translations, review them, or vote on others' contributions.

Getting Started

  1. Create a Crowdin account (if you don't have one already).
  2. Join the UniFi Voucher Site project by visiting our Crowdin page.
  3. Choose the language you want to contribute to or suggest improvements for.
  4. Start translating or reviewing!

Your contributions will be automatically included in the next release after review.

Screenshots

Login (Desktop)

Login - Desktop

Vouchers Overview (Desktop)

Vouchers Overview - Desktop

Create Voucher (Desktop)

Create Voucher - Desktop

Voucher Details (Desktop)

Voucher Details - Desktop

Login (Mobile)

Login - Mobile

Vouchers Overview (Mobile)

Voucher Overview - Mobile

Create Voucher (Mobile)

Create Voucher - Mobile

Voucher Details (Mobile)

Voucher Details - Mobile

Release Notes

Detailed information on the changes in each release can be found on the GitHub Releases page. It is highly recommended to review the release notes before updating or deploying a new version, especially if you are upgrading from a previous version.

Migration Guide

Migration from 3.x to 4.x

When upgrading from 3.x to 4.x, the following changes need to be made:

  1. OIDC Public Flow Removal

    • The OIDC public flow has been removed in v4. Only the confidential flow is now supported.
    • Users must migrate to the confidential flow. Updated integration guides are available to help with this migration: OIDC IdP Integration Guides.

  2. OIDC Endpoints Update

    • OIDC endpoints have been moved to dedicated paths.
    • Update the IdP callback URL from /callback to /oidc/callback in your IdP configuration.

  3. Environment Variable Changes

    • AUTH_OIDC_CLIENT_TYPE has been removed. It is no longer required.
    • AUTH_OIDC_ENABLED has been introduced. If you are using OIDC, you must set AUTH_OIDC_ENABLED to true in your environment configuration.
    • AUTH_INTERNAL_ENABLED has been introduced.
      • If you are using internal authentication, set AUTH_INTERNAL_ENABLED to true.
      • If you are using OIDC and want to disable internal authentication, set AUTH_INTERNAL_ENABLED to false.

  4. Password Variable Rename

    • AUTH_PASSWORD has been renamed to AUTH_INTERNAL_PASSWORD.
    • Update your environment variable to use AUTH_INTERNAL_PASSWORD if you rely on internal authentication.

  5. Bearer Token Variable Rename

    • AUTH_TOKEN has been replaced by AUTH_INTERNAL_BEARER_TOKEN.
    • Update your environment variable to use AUTH_INTERNAL_BEARER_TOKEN for api bearer token authentication.

Migration from 2.x to 3.x

When upgrading from 2.x to 3.x, the following changes need to be made:

  1. SECURITY_CODE has been replaced by AUTH_PASSWORD.

    • Update your environment variables configuration to use AUTH_PASSWORD instead of SECURITY_CODE.

  2. DISABLE_AUTH has been replaced by AUTH_DISABLE.

    • Replace DISABLE_AUTH with AUTH_DISABLE in your environment variables.

  3. The API bearer token now uses a dedicated variable AUTH_TOKEN.

    • Ensure that your API token is now stored under the AUTH_TOKEN variable and update your implementations to use this new token instead of the SECURITY_CODE.

Migration from 1.x to 2.x

No migration steps are required.

Migration from Versions Prior to v1

Versions before v1 do not have a direct migration path. If you are using a version earlier than v1, a fresh installation is required. Be sure to back up any important data before proceeding with a re-install.

License

MIT