Self-hosted licensing
Licence checks, the five reported fields, licence states, audit logs and proxy settings.
Test-environment key
One test key per account is available from your account page. Test keys need version 0.1.2 or later. It is valid while your production licence is valid. You are billed on the larger of your production and test installs each day, independently for human and non-human identities. A test install cannot be switched to production: use a new install to change environment. Requesting the test key again replaces its key and releases its install. Only an operator can restore an operator-revoked test key.
Activation, recurring checks and audit log
At activation and every six hours on schedule, the install sends its licence key, install ID and app version. Scheduled checks also send human and non-human identity counts. The licensing service sees the source IP and stores a salted hash for abuse control when IP hashing is configured. Open /licence inside the install to see the check audit log, reported version and counts, result and pass expiry. It shows the key prefix, never the full key.
Field | Value sent |
|---|---|
| Licence key | Your licence key |
| Install id | The identifier of this installation |
| App version | The installed app version |
| Count of human identities | The human identity count |
| Count of non-human identities | The non-human identity count |
Your identity data, findings, reports and cloud credentials stay in your environment. You create your own app registration in your own tenant. There is no third-party app with standing access to your directory.
Set PERMAFROST_LICENSE_KEY in the install environment and apply changes with Docker Compose up -d, which recreates containers with new settings; Docker Compose restart does not re-read the environment file. Before setup is complete, open /setup and select Check again. After setup, open /licence and select Check now. Manual and scheduled checks share a one-minute limit. The app checks once at process boot even after a recent failure, and the scheduler checks every six hours, including before setup. The boot attempt runs at most once per process; vendor-side rate limits still apply.
A successful check returns a signed pass valid for 72 hours. The install verifies it with public keys shipped in the image and stores it in your database. Keep the server clock correct. Network errors do not replace a still-valid pass.
The Licence page shows the install id, key prefix, state, reason, remaining days, last check, last success and pass expiry. Its paginated audit log records check time, kind, version, counts, result, HTTP status and detail. Activation has no counts. The full key is not shown in the audit log.
Trial, billing and licence states
Start with a 30-day trial licence. After the trial, billing is monthly in arrears from the two reported counts, at the same rates as hosted: $3.50 per human identity and $0.50 per non-human identity.
If the trial ends unpaid, payment fails, the licence is revoked, or the licensing service cannot be reached for 72 hours, the portal becomes read-only and syncs pause. A notice explains why. After 30 days it stops working until the licence is restored. We never delete data in your database.
Register and verify your company email for one 30-day trial per company. Save the key when it is shown once. Manage the production key in your account. Billing is set up with you before your trial ends. Contact us from your account page.
After setup, an active administrator can view the Licence page and its audit log or run a manual check. Other members cannot manage the licence.
- Unactivated: there is no verifiable pass. Setup and licence recovery remain available. Sign-in and claiming the first administrator require a valid licence.
- Valid: the signed pass permits normal access and collection.
- Problem: an unpaid trial expiry, payment failure, revocation or expired 72-hour pass makes the portal read-only. Existing data and exports remain available. Syncs and other writes stop. Security reductions such as removing members and revoking keys remain available.
- Stopped: after 30 days in the problem state, normal portal access stops. Licence recovery and sign-out remain available. Restoring a valid licence restores access. Licence enforcement does not delete your data.
New registry pull tokens require a valid licence. Replacing a production key invalidates the old credential and preserves its install binding. Replacing a test key releases its install. Release the install in your account before moving it. Already-issued signed passes can remain usable until their 72-hour expiry; key replacement and release do not cancel them immediately.
Read the Self-Hosted Licence Agreement.
Outbound access and proxy settings
The default licensing address is https://permafrostepm.com/api/licensing/v1. Customers behind an outbound proxy must allow HTTPS to the licensing host (port 443 for the default address), as well as to the Microsoft APIs used for sign-in and collection. The client posts to /activate and /heartbeat and refuses redirects. PERMAFROST_LICENSING_URL accepts only HTTPS URLs, or HTTP to exactly localhost or 127.0.0.1; credentials, query strings and fragments are rejected. An internal plain-HTTP relay is not supported.
The image enables native Node environment proxy support with NODE_USE_ENV_PROXY=1. Licensing requests and Microsoft API requests use it. For Compose, set HTTPS_PROXY, HTTP_PROXY and NO_PROXY in the environment file. Include localhost,127.0.0.1,app,db in NO_PROXY. Mount a custom PEM bundle read-only if needed and set NODE_EXTRA_CA_CERTS to its container path. Recreate the app after changing environment settings; restart after changing the mounted certificate bundle. Never disable TLS certificate validation.
For Helm, use proxy.httpsProxy and proxy.noProxy. Use either customCA.configMap or customCA.secret, with customCA.key naming the PEM entry. The chart mounts it read-only and sets NODE_EXTRA_CA_CERTS. These settings apply to Node HTTPS, not database TLS. Configure license.url only when overriding the licensing address.
Installs with no internet connection are by special request. Pricing may differ. Contact us to discuss a separate arrangement.
Next stop
Self-hosted overview
Deployment options, data boundaries and responsibilities for self-hosted Permafrost.
Next stop
Self-hosted Docker Compose
Get your licence, configure Docker Compose and complete setup through the first sync.
Next stop
Self-hosted Kubernetes
Install the Permafrost Helm chart with cluster values, secrets, an external database and TLS ingress.
Next stop
Self-hosted operations
Backups, upgrades, supported versions, health checks and logs for your Permafrost installation.
