Applying an Enterprise License

CompassDocs Enterprise features—SSO, SCIM provisioning, Microsoft 365 directory & group sync, policy acknowledgements, training & onboarding, audit-log export, and priority support—are unlocked by a license key. Keys are offline and cryptographically signed: your server validates them locally, with no license server to call and nothing that breaks if you’re air-gapped.

See License & editions for the model. Buying is fully self-serve: purchase at compassdocs.io/pricing and the signed key is emailed to you automatically the moment payment completes (renewals email a fresh key each year).

Two things are required

Enterprise features turn on only when both are true:

1. You’re running the Enterprise build. Enterprise code ships as a separate image (ghcr.io/mattny20/compassdocs-ee). The public Community image does not contain the enterprise features at all—so a key alone won’t enable them.
2. A valid license is applied that entitles the feature.

The Settings → License page shows both: whether the build is Community or Enterprise, and the status of any applied key.

Applying a key

The easiest moment is during first-run setup — the setup wizard (on Enterprise builds) has an optional license-key field, validated as part of creating your admin account. To apply or replace a key later:

1. Sign in as an Admin and open Settings → License.
2. Paste the license token you were issued into the key field and Save.
3. The page updates to show the license status, the customer and plan it was issued to, its seat limit and expiry, and—per feature—whether it’s enabled, not licensed, or not in this build.

The raw key is stored write-only and is never shown back in full. Applying, changing, or clearing a key is recorded in the audit log.

Alternative: environment variable

Instead of the UI, you can set the key at deploy time:

COMPASSDOCS_LICENSE_KEY="<your-license-token>"

A key set in Settings takes precedence over the environment variable. This is handy for automated or immutable deployments.

Status & the grace period

The License page reports one of:

Status	Meaning
Active	Valid and within its term. Entitled features are on.
In grace	Past the expiry date but within the 14-day grace period. Features still work—renew soon.
Expired	Past the grace period. Entitled features are disabled.
Invalid	The token failed signature verification or is malformed.
None	No key applied—Community behavior.

When a license lapses, features keep working through the grace period and then switch off automatically. Your core install, your documents, and all Community features keep running normally—nothing is held hostage by an expired key.

Seats

Licenses carry a seat count (0 = unlimited). Seats count configured user accounts on your install. If you exceed the seat limit, the License page flags it; it does not lock you out. Contact us to add seats.

Renewals

Because keys are offline, renewals are handled by reissuing a key with a new expiry. When you renew, you’ll receive a fresh token—paste it into Settings → License exactly as you did the first one, and the new expiry takes effect immediately.

Note

Changing editions is a redeploy, not a toggle: to go from Community to Enterprise you switch to the Enterprise image and apply your key. Moving back to the Community image simply leaves the enterprise features unavailable again; your data is untouched.

Trying it out

Ask for a time-limited trial license to validate SSO and SCIM against your identity provider — and run a pilot training deck — before you commit. See pricing.