Licensing
Install and manage your IdentityScribe license. This guide covers obtaining, installing, and renewing licenses.
Obtaining a License
Section titled “Obtaining a License”Step 1: Generate a License Request
Section titled “Step 1: Generate a License Request”Start IdentityScribe without a license. On startup, it logs a license request block:
License verification failedRequest a new license with:
Product: identity-scribeVersion: 3.0.0Scopes: ra-ucI0CaG1AApfojU6733wtdS2CvYfJrIRWl-NXiEA
-----BEGIN LICENSE REQUEST-----eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9...(base64-encoded JWT)-----END LICENSE REQUEST-----Step 2: Send the License Request
Section titled “Step 2: Send the License Request”Copy the entire block (including the -----BEGIN and -----END markers) and send it to:
Include:
- Your organization name
- Desired license duration
- Required features (LDAP, REST, GraphQL)
Step 3: Install the License
Section titled “Step 3: Install the License”When you receive your license file (.lic), place it in one of these locations:
-
Same directory as the executable (recommended):
Terminal window cp your-license.lic /opt/identity-scribe/identity-scribe.lic -
Custom location via environment variable:
Terminal window export SCRIBE_LICENSE_FILE=/path/to/your-license.lic -
Custom location via command line:
Terminal window ./identity-scribe --license /path/to/your-license.lic
Configuration
Section titled “Configuration”The license file path can be configured in multiple ways (in priority order):
| Method | Example |
|---|---|
| Command line | --license /path/to/license.lic |
| System property | -DSCRIBE_LICENSE_FILE=/path/to/license.lic |
| Environment variable | SCRIBE_LICENSE_FILE=/path/to/license.lic |
| Default location | identity-scribe.lic in working directory |
Verifying your license
Section titled “Verifying your license”On startup, IdentityScribe displays license information in the startup banner with color-coded expiration status:
┃ License ACME Corp — expires 2027-01-01 (365d)| Color | Days Remaining | Meaning |
|---|---|---|
| Green | 15+ days | Healthy |
| Yellow | 3-14 days | Warning — renewal needed soon |
| Red | < 3 days | Critical — 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:
curl http://localhost:8080/health | jq '.checks[] | select(.name == "license")'License expiration
Section titled “License expiration”IdentityScribe provides warnings before license expiration:
| Days Remaining | Behavior |
|---|---|
| > 30 days | Normal operation |
| 7–30 days | Warning in logs at startup |
| < 7 days | Warning in logs every hour |
| Expired | Service refuses to start |
Troubleshooting
Section titled “Troubleshooting”License file not found
Section titled “License file not found”ERROR: License file not found: identity-scribe.licSolution: Ensure the license file exists at the configured path, or set SCRIBE_LICENSE_FILE.
Invalid license signature
Section titled “Invalid license signature”ERROR: License signature verification failedSolution: Contact support — your license file may be corrupted or invalid.
License expired
Section titled “License expired”ERROR: License expired on 2025-12-31Solution: Contact your account manager to renew your license.
Feature not licensed
Section titled “Feature not licensed”WARN: Feature 'graphql' is not included in your licenseSolution: Contact sales to upgrade your license if you need additional features.
Renewing a License
Section titled “Renewing a License”When your license expires or you need additional features:
- Start IdentityScribe — it will log a new license request block
- Copy the license request from the console output
- Send to support@identity-hub.io with your renewal requirements
- Install the new license file as described above