Skip to main content
Use a self-hosted Enterprise license key to unlock Enterprise features on your OpnForm instance.

Prerequisites

Before activating a license, make sure you have:
  • A running self-hosted OpnForm installation
  • A user account that is an admin of at least one workspace
  • A self-hosted Enterprise license key
  • Network access from your API container or server to the OpnForm license API
By default, self-hosted license validation uses https://api.opnform.com.

Activate a license from the UI

1

Open user settings

Sign in as a workspace admin, then open your user settings.
2

Open Enterprise License

Go to the Enterprise License section.
3

Enter your license key

Paste your license key in the License Key field.
4

Activate the license

Click Activate License. When activation succeeds, OpnForm refreshes the instance feature flags and enables the licensed Enterprise features.
Most installations can use the default license API settings. Override these variables only when instructed by OpnForm support or when you run a custom license API endpoint.
VariableDescription
LICENSE_API_ENDPOINTBackend license API endpoint. Defaults to https://api.opnform.com.
LICENSE_CHECKOUT_SUCCESS_URLCheckout success URL used when creating self-hosted Enterprise license checkout sessions.
LICENSE_CHECKOUT_CANCEL_URLCheckout cancellation URL used when creating self-hosted Enterprise license checkout sessions.
LICENSE_PORTAL_RETURN_URLReturn URL used by the billing portal for self-hosted Enterprise licenses.
NUXT_PUBLIC_LICENSE_API_ENDPOINTFront-end license API endpoint used to start Enterprise license checkout. Defaults to https://api.opnform.com.
After changing environment variables, recreate the affected Docker containers. A simple restart does not reload Docker environment variables.

Network requirements

The API validates the installed license with the configured license API endpoint. The instance sends its license key, instance identifier, and usage metadata needed to validate the license. OpnForm caches license checks. If the license API is temporarily unavailable after a successful check, the instance can enter a short grace state and continue using licensed features while it retries validation.

License statuses

StatusMeaning
activeThe license is valid and Enterprise features are enabled.
graceThe last successful check is still within the grace window after a temporary license API failure.
expiredThe license is no longer active. Enterprise features are disabled until renewal or activation of a valid key.
activation_limit_reachedThe key is already activated on another self-hosted instance. Contact support to reset the activation.
invalidThe key is missing, invalid, or could not be validated.

Troubleshooting

Confirm that you copied the full key and that the license is active. If the key still fails, contact OpnForm support.
A self-hosted license key is tied to an instance activation. Contact support if you migrated servers or need the activation reset.
Refresh the page and sign in again. If features remain locked, confirm that the API can reach the configured LICENSE_API_ENDPOINT, then recreate containers if you changed environment variables.
Make sure a valid license key is installed and that the API can reach the license API endpoint.