← Clientexec integration
Installation guide
Connect Clientexec to VPN Dashboard.
Install the server plugin, add the connection and attach it to a Clientexec package.
Packagevpn-dashboard-clientexec.zip
Install inplugins/server/vpndashboard
Provider keyclientexec
01
Install
Put the module in the right place.
- Download the Clientexec ZIP from Integration downloads in your VPN Dashboard account.
- Extract it and copy vpndashboard into plugins/server in your Clientexec installation.
- Add a server using the VPN Dashboard server plugin.
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.
- Enter the HTTPS address of your hosted dashboard.
- Enter the billing API token, SSO signing secret and webhook signing secret from the matching billing connection in VPN Dashboard.
- Set the provider key to clientexec, run Test Connection and add the Clientexec 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 clientexec.
03
Product
Set up the VPN product.
- Select the VPN Dashboard plugin for the Clientexec package.
- Set Default Profiles, Minimum Profiles, Maximum Profiles and Server Access Type.
- If your order form supplies a quantity, use profile_limit, vpn_profiles, profiles or profile_count.
04
Customer access
Add the customer-area link.
Clientexec exposes a direct customer action that opens the customer VPN area through a signed link.
Keep the SSO signing secret private. Change it in both systems if it is ever exposed.
Configuration reference
Settings used by Clientexec.
Connection settings apply to the module. Product settings apply to each plan.
Connection settings5 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 keyclientexec
- Must match the provider key on the billing connection and customer sign-in settings.
Product settings5 fields
- Default profiles50 by default
- Used when the order does not supply a custom quantity.
- Minimum profiles1 by default
- The lowest profile quantity the plugin accepts.
- Maximum profiles10,000 by default
- The highest profile quantity the plugin accepts.
- Server accessShared or dedicated; shared by default
- Dedicated services wait for dedicated VPN server capacity.
- Order-form quantityOptional profile quantity
- Clientexec can supply the quantity through a recognised field such as profile_limit or vpn_profiles.
Service lifecycle
What Clientexec sends.
Create package serviceCreates VPN access for the customer.
Update package serviceUpdates the existing service and profile allowance.
Suspend package serviceSuspends VPN access.
Unsuspend package serviceRestores VPN access.
Delete package serviceCancels VPN access.
Before launch
Check the complete order path.
- The module connection check succeeds.
- The product creates the expected profile allowance and server access type.
- The customer link opens the correct branded VPN area.
- Suspension and restoration update the same service.
- Cancellation removes access from the same service.
Module notes
Details specific to Clientexec.
- Clientexec must support encryptable server-plugin password fields.
- The plugin uses the package service ID as the stable external service reference.
- Run the built-in connection check before using the package for orders.
Ready to install?
Download the Clientexec module from your account.
The package and its version details are kept under Integration downloads.
