Licensing

Install and manage your IdentityScribe license. This guide covers obtaining, installing, and renewing licenses.

Start IdentityScribe without a license. On startup, it logs a license request block:

License verification failed
Request a new license with:

Product: identity-scribe
Version: 3.0.0
Scopes: ra-ucI0CaG1AApfojU6733wtdS2CvYfJrIRWl-NXiEA

-----BEGIN LICENSE REQUEST-----
eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9...
(base64-encoded JWT)
-----END LICENSE REQUEST-----

Copy the entire block (including the -----BEGIN and -----END markers) and send it to:

scribe@kenoxa.de

Include:

• Your organization name
• Desired license duration
• Required features (LDAP, REST, GraphQL)

When you receive your license file (.lic), place it in one of these locations:

1. Same directory as the executable (recommended):

   cp your-license.lic /opt/identity-scribe/identity-scribe.lic

2. Custom location via environment variable:

   export SCRIBE_LICENSE_FILE=/path/to/your-license.lic

3. Custom location via command line:

   ./identity-scribe --license /path/to/your-license.lic

The license file path can be configured in multiple ways (in priority order):

On startup, IdentityScribe displays license information in the startup banner with color-coded expiration status:

┃ License     ACME Corp — expires 2027-01-01 (365d)

License details are also logged:

License loaded: customer=ACME Corp, expires=2027-01-01, features=[ldap, rest, graphql]

Check the /health endpoint for license status:

curl http://localhost:8080/health | jq '.checks[] | select(.name == "license")'

The Operator UI provides a visual dashboard for license management at /ui/observe/license.

What you can do:

• View license status (valid, expiring soon, or expired)
• See days remaining with a visual progress bar
• View detected products (database and LDAP servers)
• Copy a license renewal request to your clipboard
• Send a renewal request via email

Access the dashboard:

1. Open the Operator UI at http://localhost:8080/ui
2. Navigate to Observe → License

Or go directly to http://localhost:8080/ui/observe/license.

The License card also appears on the main Observe dashboard for at-a-glance status.

IdentityScribe provides warnings before license expiration:

ERROR: License file not found: identity-scribe.lic

Solution: Ensure the license file exists at the configured path, or set SCRIBE_LICENSE_FILE.

ERROR: License signature verification failed

Solution: Contact support — your license file may be corrupted or invalid.

ERROR: License expired on 2025-12-31

Solution: Contact your account manager to renew your license.

WARN: Feature 'graphql' is not included in your license

Solution: Contact sales to upgrade your license if you need additional features.

When your license expires or you need additional features:

Option A: Using the Operator UI (recommended)

1. Open the License dashboard at /ui/observe/license
2. Click Copy Request or Email Request
3. If emailing, the request is pre-filled — just send it
4. Install the new license file when you receive it

Option B: From console output

1. Start IdentityScribe — it logs a license request block
2. Copy the license request from the console output
3. Send to scribe@kenoxa.de with your renewal requirements
4. Install the new license file as described above

• Configuration — HOCON, env vars, inheritance patterns
• Deployment — Installation and platform-specific setup