Captive Portal
This page describes how COD creates guest vouchers for the captive portal of an OPNsense firewall, what you need to set up and where the limits are.
What the module does is described on the module page.
As of: November 2026, COD 3.8.6
Documentation contents
- Overview
- Getting started
- Requirements
- Names and addresses
- Network devices
- Time and DNS
- Installation
- Deployment shapes
- Initial setup
- Updates
- Modules
- Network and MikroTik
- Automation
- NAC
- TACACS+
- Firewall
- Captive Portal
- Monitoring
- Backup
- Hypervisor
- OTP
- Passkeepr
- GRC
- Inventory and CMDB import
- Troubleshooting
- Security
- Versions
- Version history
- Support
Documentation
- Overview
- Getting started
- Requirements
- Names and addresses
- Network devices
- Time and DNS
- Installation
- Deployment shapes
- Initial setup
- Updates
- Modules
- Network and MikroTik
- Automation
- NAC
- TACACS+
- Firewall
- Captive Portal
- Monitoring
- Backup
- Hypervisor
- OTP
- Passkeepr
- GRC
- Inventory and CMDB import
- Troubleshooting
- Security
- Versions
- Version history
- Support
Overview
| Item | Value |
|---|---|
| Purpose | Create, hand out and invalidate guest vouchers for the firewall’s captive portal |
| Firewall | OPNsense only |
| Connection and direction | COD server to the firewall through its API. The firewall is connected in the Firewall module |
| Vouchers | Validity period, expiry time, group label. Many vouchers in one step |
| Output | QR code for guest login, QR code for joining the Wi-Fi, PDF individually or in bulk |
| Rights | Read, create, change and delete can be granted separately |
| Storage | Voucher passwords encrypted in COD’s database |
| Firewall rules | Customers and partners receive the list of connections and firewall rules as part of the project. |
Requirements
| Requirement | Where |
|---|---|
| OPNsense connected in the Firewall module, with asset type “Firewall” and API access | COD |
| Captive portal with a zone set up on the OPNsense | Firewall |
| Guest Wi-Fi with SSID and PSK | Wi-Fi |
| Voucher configuration on the firewall asset with zone, SSID, PSK, gateway and redirect | COD |
| Captive Portal module enabled for the tenant, roles for handing out vouchers | COD |
Setup
- Connect the OPNsense in the Firewall module. See Firewall.
- Set up the captive portal with a zone on the OPNsense.
- In COD, create the voucher configuration on the firewall asset. Fill in zone, SSID, PSK, gateway and redirect completely.
- Create a role for the people who hand out vouchers, for example reception. Grant only the rights needed, usually read and create.
- Create vouchers: number, validity period, expiry time and group label.
- Hand out the vouchers as QR code or PDF.
The voucher configuration then appears on the firewall asset in the “References” tab.
Technical details
| Item | Value |
|---|---|
| Expiry | Each voucher expires on the firewall by itself after its expiry time |
| Invalidate at once | “Expire” for single vouchers, “Drop Expired” for expired ones |
| Clean-up | A nightly run cleans up COD’s database |
| QR codes | one for guest login, one for joining the Wi-Fi via SSID |
| Delegation | Rights for read, create, change and delete separated. The person handing out vouchers needs no access to the firewall |
| Search | Vouchers are among the sources of the global search. The result opens the record |
Known limits
| Limit | What you can do |
|---|---|
| OPNsense only | For other firewalls use their own guest management |
| The voucher configuration needs zone, SSID, PSK, gateway and redirect | Fill in all values before you create vouchers |
| Rights apply per location, not per firewall | Anyone allowed to create vouchers can do so for all firewalls of the location. Split locations accordingly |
Further reading
- Captive Portal module page
- Connecting a firewall
- What your network needs for Firewall and Captive Portal
- Troubleshooting
- Questions about the modules
- Support: your partner is your first point of contact. Technical questions to extocode go through the helpdesk form.