diff --git a/docs/docs/deployment-self-hosting/core-configuration/licence.md b/docs/docs/deployment-self-hosting/core-configuration/licence.md new file mode 100644 index 000000000000..973936af1441 --- /dev/null +++ b/docs/docs/deployment-self-hosting/core-configuration/licence.md @@ -0,0 +1,56 @@ +--- +title: "Enterprise Licence" +description: "How to upload and manage your Enterprise licence in a self-hosted Flagsmith deployment." +sidebar_position: 35 +--- + +Enterprise Edition deployments require a valid licence to activate seat and project limits for your organisation. Your Flagsmith account team will provide you with two files: + +- **Licence file** — contains your organisation's licence details (seats, projects, expiry) +- **Signature file** — a cryptographic signature used to verify the licence + +## Prerequisites + +- A running [Enterprise Edition](/deployment-self-hosting/enterprise-edition) deployment +- Organisation admin access +- Both licence and signature files from your Flagsmith account team + +## Uploading via the Dashboard + +1. Log in to your Flagsmith dashboard as an organisation admin. +2. Navigate to **Organisation Settings**. +3. Select the **Licensing** tab. +4. Click **Select Licence File** and choose your licence file. +5. Click **Select Signature File** and choose your signature file. +6. Click **Upload Licensing Files**. + +A success notification confirms the licence has been applied. Your organisation's seat and project limits will be updated immediately. + +## Uploading via the API + +You can also upload the licence programmatically using the REST API. This is useful for automated deployments or infrastructure-as-code workflows. + +```bash +curl -X PUT \ + https:///api/v1/organisations//licence \ + -H "Authorization: Token " \ + -F "licence=@/path/to/licence-file" \ + -F "licence_signature=@/path/to/signature-file" +``` + +Replace: + +- `` with your Flagsmith API domain +- `` with your organisation ID +- `` with a valid API token for an organisation admin +- The file paths with the actual paths to your licence and signature files + +## Troubleshooting + +| Symptom | Cause | Resolution | +| --- | --- | --- | +| "No licence file provided" | The licence file was not included in the upload | Select a licence file before clicking Upload. | +| "No licence signature file provided" | The signature file was not included in the upload | Select a signature file before clicking Upload. | +| "Signature failed for licence" | The signature does not match the licence file | Ensure you are using the correct pair of files provided by your Flagsmith account team. Contact support if the issue persists. | +| Licensing tab not visible | Deployment is not running the Enterprise Edition image | The licensing tab only appears on Enterprise Edition deployments. See [Enterprise Edition](/deployment-self-hosting/enterprise-edition) for setup instructions. | +| "You do not have permission to view this page" on Organisation Settings | Insufficient access | Only organisation admins can access Organisation Settings and upload licence files. Check your role with an existing admin. | diff --git a/docs/docs/deployment-self-hosting/enterprise-edition.md b/docs/docs/deployment-self-hosting/enterprise-edition.md index e26adf26db1b..c991e439e323 100644 --- a/docs/docs/deployment-self-hosting/enterprise-edition.md +++ b/docs/docs/deployment-self-hosting/enterprise-edition.md @@ -53,6 +53,12 @@ This image includes additions from the SaaS image above: - MySQL Support - AppDynamics Integration +## Licensing + +Enterprise Edition deployments require a valid licence to configure seat and project limits for your organisation. See +[Enterprise Licence](/deployment-self-hosting/core-configuration/licence) for instructions on uploading your licence via +the dashboard or API. + ## Environment Variables ### Frontend Environment Variables