Skip to content

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:

support@identity-hub.io

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):

    Terminal window
    cp your-license.lic /opt/identity-scribe/identity-scribe.lic
  2. Custom location via environment variable:

    Terminal window
    export SCRIBE_LICENSE_FILE=/path/to/your-license.lic
  3. Custom location via command line:

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

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

MethodExample
Command line--license /path/to/license.lic
System property-DSCRIBE_LICENSE_FILE=/path/to/license.lic
Environment variableSCRIBE_LICENSE_FILE=/path/to/license.lic
Default locationidentity-scribe.lic in working directory

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

┃ License ACME Corp — expires 2027-01-01 (365d)
ColorDays RemainingMeaning
Green15+ daysHealthy
Yellow3-14 daysWarning — renewal needed soon
Red< 3 daysCritical — expires very soon

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:

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

IdentityScribe provides warnings before license expiration:

Days RemainingBehavior
> 30 daysNormal operation
7–30 daysWarning in logs at startup
< 7 daysWarning in logs every hour
ExpiredService refuses to start
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:

  1. Start IdentityScribe — it will log a new license request block
  2. Copy the license request from the console output
  3. Send to support@identity-hub.io with your renewal requirements
  4. Install the new license file as described above