Enterprise features
Single sign-on, directory sync and the tamper-evident audit log, from the source-available ee/ directory. How licensing works and how to set each one up.
Admin, governance and scale features live in the ee/ directory under the source-available OCVSAL license. Everything an operator uses day to day is in the Apache 2.0 core. See License and open core for the split.
| Feature | Edition |
|---|---|
| Audit log: recording, and the last 90 days in Settings → Audit log | Apache 2.0 |
| Audit chain: hash chain, Verify, exports, retention up to seven years | Enterprise |
| Single sign-on: OIDC and SAML 2.0, required per domain | Enterprise |
| Directory sync: SCIM 2.0, roles from groups | Enterprise |
License key
- Outside production (
NODE_ENVisn'tproduction), every enterprise feature can be set up without a key, as the license allows for development and testing. - In production, a feature can be set up only when
OPENDASH_LICENSE_KEYcovers it. The key is checked offline against the licensor's public keys, so air-gapped instances work. Owners see what it covers in Settings → License. - A lapsed key never switches security off. What's already set up keeps running (SSO sign-in, requiring it, directory sync, audit recording). Only changes wait for a valid key. Disabling a provider, issuing a directory token and disconnecting a directory always work, because they only take access away.
To get a key, write to hello@sureshkumar.dev.
Single sign-on
OIDC and SAML 2.0 identity providers, per workspace, under Settings → Single sign-on (owners and admins).
- Two proofs. A DNS TXT record,
_opendash-verification-<provider id>.<domain>, proves the workspace may claim the domain. A validated ID token or SAML assertion proves the person. Only both together create or link an account, and only at exactly that domain. - Lifecycle: draft, verified, active (a test sign-in passed after its last change), required for its domain, disabled.
- Requiring it applies to everyone with an email at the domain, on the whole instance: their other sessions end, their API keys are revoked, and password and email-link sign-in are refused. Sessions must be younger than
OPENDASH_SSO_MAX_AUTH_AGE_HOURS(12 by default). - Newcomers join as viewers, or with the role a pending invitation gave them.
What to paste into your identity provider is built from BETTER_AUTH_URL:
| Protocol | Value |
|---|---|
| OIDC redirect URI | <BETTER_AUTH_URL>/api/auth/sso/callback/<provider id> |
| SAML ACS URL | <BETTER_AUTH_URL>/api/auth/sso/saml2/sp/acs/<provider id> |
| SAML entity ID | <BETTER_AUTH_URL>/api/auth |
Your address is part of every provider's setup
Changing BETTER_AUTH_URL breaks every identity provider and directory configured against it.
An identity provider's issuer and metadata must be HTTPS on a public address. To trust one on your own network, list its origin in OPENDASH_SSO_TRUSTED_IDP_ORIGINS.
Break-glass
If a required provider fails and nobody can sign in, disable it from the server:
pnpm sso:disable --provider <provider-id>Its sessions end, the requirement lifts, and people at its domain can sign in by email again. The audit log records it.
Directory sync
SCIM 2.0, one connection per workspace, under Settings → Directory sync. Your directory calls <BETTER_AUTH_URL>/api/auth/scim/v2 with a token that is shown once and lasts a year.
- Only at verified domains, so a directory can't claim strangers.
- Roles from groups. Each group can map to admin, member or viewer; a person gets the highest. Owner is never assigned by the directory.
- Deprovisioning. A deactivated or deleted person leaves the workspace and loses their sessions. A workspace's last owner is always kept.
- Okta and Microsoft Entra request shapes are covered.
Tokens are stored only as digests under a key derived from BETTER_AUTH_SECRET. Changing that secret ends every directory's token.
Audit chain
The Apache 2.0 core records the audit log on every instance. With a license that covers audit:
- Hash chain. Each row's hash covers the previous hash and the row, so changing, removing or reordering a sealed row breaks every link after it.
- Verify walks the chain, from Settings → Audit log or from the server:
pnpm audit:verify --org <organization-id>. - Exports as CSV or JSON Lines, with each row's place and hash.
- Retention up to seven years via
OPENDASH_AUDIT_RETENTION_DAYS. A lapsed key never shortens it.