starred/unifi-voucher-site
1
0
Fork 0
mirror of https://github.com/glenndehaan/unifi-voucher-site.git synced 2026-04-05 00:44:18 -04:00
Code Issues Packages Projects Releases Wiki Activity

Updated README.md. Added Prerequisites section. Implemented OIDC IdP Integration Guides. Added Keycloak OIDC implementation guide. Added Authentik OIDC implementation guide. Updated .dockerignore

Browse Source
This commit is contained in:
Glenn de Haan
2024-08-27 19:11:41 +02:00
parent 3725698c46
commit d6b2071a98
15 changed files with 201 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
README.md
View File

@@ -28,11 +28,25 @@ UniFi Voucher Site is a web-based platform for generating and managing UniFi net
- NodeMailer
- PDFKit
## Prerequisites
- UniFi Network Controller (Cloud Key, Dream Machine, or Controller software)
- UniFi Access Point (AP)
- UniFi Local Account with 'Full Management' access
[Follow this guide to set up the Hotspot Portal](https://help.ui.com/hc/en-us/articles/115000166827-UniFi-Hotspot-Portal-and-Guest-WiFi), 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
- Code from master is build by Docker Hub
- Code from master is build by GitHub actions
- Builds can be pulled by using this command: `docker pull glenndehaan/unifi-voucher-site`
- An example docker compose file can be found below:
@@ -98,10 +112,6 @@ services:
LOG_LEVEL: 'info'
```
> Attention!: We recommend only using Local UniFi accounts due to short token lengths provided by UniFi Cloud Accounts. Also, UniFi Cloud Accounts using 2FA won't work!
> 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.
### 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.
@@ -390,6 +400,19 @@ To identify which client types your OpenID Connect (OIDC) provider supports (Pub
For confidential clients, confirm that the `token_endpoint_auth_methods_supported` field lists options like `client_secret_post` or `client_secret_basic`, which indicate that the provider supports client secret authentication.
### 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.
#### Available Guides
Below is a list of tested Identity Providers (IdPs) with detailed integration instructions:
- [Keycloak Integration](.docs/oidc/keycloak/README.md)
- [Authentik Integration](.docs/oidc/authentik/README.md)
> Integrated with an IdP that is not on the list? Feel free to create a guide for others and contribute it to the project
## Screenshots
### Login (Desktop)