Activating your licence key

Updated

Apply your Enterprise licence key in Settings → License and fix the most common reasons a key doesn't activate.

Your Enterprise licence key arrives by email when payment completes. Enterprise features switch on only when both of these are true:

  1. You're running the Enterprise image (ghcr.io/mattny20/compassdocs-ee). The Community image doesn't contain the Enterprise features, so a key alone won't enable them.
  2. A valid licence key is applied.

Apply your key

  1. Sign in as an Admin and open Settings → License.
  2. Paste the key from your email into the key field and choose Save.
  3. The page now shows the licence status, who it was issued to, its seats, its Helpdesk agents allowance, its expiry, and whether each feature is enabled, not licensed or not in this build.
Tip

On a fresh Enterprise install, the setup wizard has an optional licence-key field, so you can paste the key while creating your admin account. You can also set it with the COMPASSDOCS_LICENSE_KEY environment variable. A key saved in Settings takes priority over the variable.

If it doesn't activate

Decision tree: "image" has no choices — add "- Answer -> target" lines.

Quick checks

  • I'm signed in as an Admin.
  • Settings → License shows Enterprise as the build.
  • I pasted the key from my most recent licence email (renewals and agent changes send a new key).
  • I pasted the whole key, with nothing added or missing.

Still stuck? Raise a CompassDocs: Licence & billing request at docs.felixazsolutions.com/support and choose The key won't activate. Include the email address the licence was sent to and a screenshot of Settings → License.

Full details: Applying an Enterprise licence and Enterprise deployment.

Still need help?

Raise a request and we'll get back to you by email.

New request