Aller au contenu principal

License

Certeasy requires a valid license file (.lic) to run.
Free licenses are issued from certeasy.tech/free. Paid licenses are sent by email after trial/purchase.

License File Format​

The .lic file is a PEM-encoded text file:

-----BEGIN CERTEASY LICENSE-----
Signature: <base64 Ed25519 signature>

<base64 JSON payload>
-----END CERTEASY LICENSE-----

The payload contains your plan, the number of authorized ADCS authorities, and the expiry date. The signature is verified offline against a public key embedded in the binary.

Identifiers​

Certeasy uses two human-readable keys, both in Crockford-base32 with a built-in check digit (no I, L, O, or U):

KeyPrefixExampleWhere it comes from
License keyCRT-CRT-EAYG2Q-QQBYYQ-VZHZ4M-5GWHNJ-V96MQXIssued on your account page; pass to certeasy license register
Installation keyINST-INST-4RD63B-JE8MKM-MA5R51-DENCSA-52HJ6XGenerated locally on first start; printed in the logs

Both keys are five groups of six characters; the last character is a checksum (Luhn mod-32 over Crockford-base32). The example values above intentionally end with X and will not validate — replace them with the real key shown on your account page or printed in your server logs. A mistyped license key is rejected at certeasy license register time with a clear error message before any network call is made.

Activation Methods​

There are two ways to activate Certeasy: online registration or manual file import.

Option 1 — Online Registration​

Register directly from the command line using your license key from certeasy.tech/account.

You need:

  • Your license key — available on your account page (shape: CRT-XXXXXX-XXXXXX-XXXXXX-XXXXXX-XXXXXX)
  • A deployment environment label (prod, dev, staging, etc.)
# Windows
certeasy.exe license register -f C:\certeasy\config.yml --env prod <license-key>
# Linux
./certeasy license register -f /etc/certeasy/config.yml --env prod <license-key>

The server name defaults to the machine hostname. Override it with --env-name:

./certeasy license register -f /etc/certeasy/config.yml --env prod --env-name my-server <license-key>

Behavior of certeasy license register:

  • connects to certeasy.tech and registers the installation
  • downloads and stores the .lic in DB automatically
  • exits (does not start the ACME server)
  • --env is required; --env-name defaults to the machine hostname

If this installation is already registered under a different license, the command fails with an error asking you to migrate via the portal.

remarque

certeasy license register requires online access to certeasy.tech. For air-gapped environments, use Option 2.

Option 2 — Manual File Import​

Download the .lic from certeasy.tech/account (you will need the installation key — see Runtime Validation below) and import it:

# Windows
certeasy.exe license install -f C:\certeasy\config.yml C:\temp\certeasy.lic
# Linux
./certeasy license install -f /etc/certeasy/config.yml /tmp/certeasy.lic

Behavior of certeasy license install:

  • validates signature + expiry
  • writes the license to DB
  • exits (does not start the ACME server)

If the import fails, the process exits with a non-zero code.

Runtime Validation​

At startup, Certeasy validates the stored license offline (signature + expiry).
No internet access is required for this step.

If no license is installed, Certeasy logs your installation key and the available activation options. To activate:

  • run certeasy license register with your license key from the portal (online), or
  • import a .lic file with certeasy license install (offline-compatible)

Startup fails by default without a license. Use --grace for a first-install grace window (7 days).

If a license is expired:

  • startup is still allowed for 14 days (post-expiry grace)
  • after that, startup fails with license has expired

Online Checks and Auto-Renew​

Certeasy can optionally run online checks and auto-renew by calling the backend refresh API.

Online behavior is configured in license (see Configuration / License).

Default check cadence:

  • more than 30 days before expiry: every 30 days
  • 30 days or less before expiry: every 24h
  • after a failed online attempt: retry in 6h (or 1h near expiry)

If the refresh endpoint is unreachable, Certeasy continues with offline validation.
Only an explicit server revocation response is a hard failure.

During post-expiry startup grace, online renewal can still recover the installation automatically if online checks are enabled.

By default, online checks are enabled and target Certeasy's official backend. To force offline mode, set:

license:
  offline: true

Manual Renewal / Replacement​

To manually update a license (air-gapped, support-issued license, etc.), run certeasy license install again with the new file:

./certeasy license install -f /etc/certeasy/config.yml /tmp/new-certeasy.lic

For immediate effect on a running instance, restart the service after import.

Checking License Status​

# Windows — tail the Certeasy log
Get-Content "C:\ProgramData\certeasy\certeasy.log" -Tail 20
# Linux
tail -20 /var/lib/certeasy/certeasy.log

On startup, Certeasy logs license details (id, plan, max_cas, holder, expiry, source).

Troubleshooting​

WARNING: PRODUCT NOT REGISTERED
No license is stored in the database. The startup logs print your installation key (INST-…) and the registration URL — use it to activate via certeasy license register <license-key> or download a .lic from the portal and import it with certeasy license install. Use --grace for an initial bootstrap grace period.

invalid license: invalid license signature
The provided .lic file is corrupted or was modified.

license has expired
License is beyond the post-expiry startup grace window. Import a renewed license.

license has been revoked by the server
The server explicitly revoked the license. Contact contact@certeasy.tech.

installation already registered under a different license
The installation key is already bound to a different license on the server. Go to certeasy.tech/account to migrate the installation before running certeasy license register again.