Concepts
Machines and fingerprints
How Portcullis identifies an installation and counts it against the license.
A machine is one activated installation of a product. Portcullis identifies it by a
fingerprint, and each license allows at most max_machines active machines at a time.
Fingerprint
installationId = PORTCULLIS_INSTALLATION_ID environment variable
?? contents of <dataDir>/installation-id
?? a new random UUID, written to <dataDir>/installation-id
fingerprint = hex( sha256( "portcullis:" + productCode + ":" + installationId ) )- The fingerprint is 64 hex characters. It is salted with the product code, so the raw installation ID never leaves the site.
- The data directory must be on persistent storage (a Docker volume or Kubernetes persistent volume). If it is lost, the installation gets a new ID and looks like a new machine.
- A product may choose the operating system's machine ID instead (
/etc/machine-id, WindowsMachineGuid, macOSIOPlatformUUID). That binds more strongly on bare metal but is fragile in containers. The formula stays the same.
Counting machines
- Activating the same fingerprint again is free: it refreshes the existing machine instead of using another seat.
- Activating a new fingerprint when the license already has
max_machinesactive machines fails withMACHINE_LIMIT_REACHED. Deactivate an old machine first. - If the same installation ID is copied to another host (for example a cloned volume), Digicom sees the same fingerprint reported from a different hostname or IP.
Deactivation
A machine is released when:
- the product deactivates it (online) from its admin screen, for example when decommissioning a server,
- Digicom staff deactivate it (offline installations, or a host that no longer exists), or
- the license is configured to auto-release machines that have not checked in for a number of days.
A machine that has stopped checking in past its lease and grace is shown to Digicom as stale.