VPN Dashboard
← FOSSBilling integration

Installation guide

Connect FOSSBilling to VPN Dashboard.

Enable the product module, add the connection settings and configure the VPN product type.

Packagevpn-dashboard-fossbilling.zip
Install inmodules/Servicevpndashboard
Provider keyfossbilling
01

Install

Put the module in the right place.

  1. Download the FOSSBilling ZIP from Integration downloads in your VPN Dashboard account.
  2. Extract it and copy Servicevpndashboard into the modules directory in your FOSSBilling installation.
  3. Enable VPN Dashboard Product in FOSSBilling.
Download it from your account.Module packages are private and the current ZIP is available under Integration downloads after sign-in.
02

Connect

Add the dashboard connection.

  1. Open the extension settings and enter the HTTPS address of your hosted dashboard.
  2. Enter the billing API token, webhook signing secret and SSO signing secret from the matching billing connection in VPN Dashboard.
  3. Keep the provider key as fossbilling, use Test connection and add the FOSSBilling server public IP to the billing API allow-list.
Use one matching provider key.The module, billing connection and customer sign-in settings must use fossbilling.
03

Product

Set up the VPN product.

  1. Create or edit a FOSSBilling product and select the VPN Dashboard product type.
  2. Set the profile allowance, protocols and shared or dedicated server access.
  3. Set traffic allowance, profile rotation, support tier or dedicated server count only when the product needs them.
04

Customer access

Add the customer-area link.

FOSSBilling provides a short-lived signed link from the order to the customer VPN area.

Keep the SSO signing secret private. Change it in both systems if it is ever exposed.

Configuration reference

Settings used by FOSSBilling.

Connection settings apply to the module. Product settings apply to each plan.

Connection settings7 fields
Dashboard URLRequired HTTPS address
The address of your hosted VPN Dashboard, without an API path.
Billing API tokenRequired secret
Copy the token from the matching billing connection in VPN Dashboard.
SSO signing secretRequired, at least 32 characters
Signs the short-lived link that takes a customer from their billing account to the VPN area.
Webhook signing secretBlank or at least 32 characters
Signs write requests from the module. Leave it blank only when the billing server IP is enforced through the API allow-list.
Provider keyfossbilling
Must match the provider key on the billing connection and customer sign-in settings.
Connection timeout5 seconds by default; 1 to 30
How long FOSSBilling waits to establish the connection.
Request timeout15 seconds by default; 1 to 60
The total time FOSSBilling allows for an API request.
Product settings7 fields
Profile limit50 by default; 1 to 10,000
The profile allowance sent for this product.
Server accessShared or dedicated; shared by default
Controls whether the service uses your shared VPN server pool or waits for dedicated capacity.
Dedicated servers1 by default
Used only when Server access is set to dedicated.
VPN protocolsBoth, WireGuard only or OpenVPN only
Sets which profile types the customer can create. Both protocols are enabled by default.
Monthly traffic (GB)Optional
Leave blank to use the dashboard default.
Profile rotation (days)Optional
Leave blank when profiles should not expire automatically.
Support tierstandard by default
A lowercase plan key sent with the service. Change it only when matching tiers exist in your dashboard.

Service lifecycle

What FOSSBilling sends.

Activate serviceCreates VPN access and records the service against the order.
Renew serviceUpdates the existing active service.
Suspend serviceSuspends VPN access.
Unsuspend serviceRestores VPN access.
Cancel serviceCancels VPN access.

Before launch

Check the complete order path.

  1. The module connection check succeeds.
  2. The product creates the expected profile allowance and server access type.
  3. The customer link opens the correct branded VPN area.
  4. Suspension and restoration update the same service.
  5. Cancellation removes access from the same service.

Module notes

Details specific to FOSSBilling.

  • The module stores its own service record using the immutable FOSSBilling order ID.
  • The module requires a valid customer email before it can create access.
  • Use Test connection before assigning the product type to a live product.

Ready to install?

Download the FOSSBilling module from your account.

The package and its version details are kept under Integration downloads.

Sign in to download