Advanced Topics

Licensing

Create and manage dxflow licenses and understand the available permissions

dxflow uses a permission-based licensing system to control access to features. Licenses are JSON files signed with RSA, verified at engine startup against an embedded public key: a valid license starts the engine, an invalid one stops it, and a missing license falls back to the built-in General license. No custom license is required to start.

Default license (General)

The built-in General License needs no registration and is valid until January 1, 2030. It grants the core modules shell, artifact, runtime, workflow, and agent. The proxy and bridge modules require a signed license.

The auth and engine controllers (and console when started with --console) are always served regardless of license.

Permissions

ModuleDescription
shellTerminal access and command execution
artifactFile storage and management
runtimeDocker, Podman, Singularity, and Apptainer integrations
workflowCompose workflow orchestration
agentAI agent sessions and workflow assistance
bridgeNetwork bridge connections (with traffic limits)
proxyProxy configurations and tunnels (with traffic limits)

Comparing licenses

GeneralFreeCustom
How to get itBuilt into the binarydxflow license createinfo@dxflow.ai
RegistrationNoneGoogle or Stripe verificationContact us
CostFreeFreeContact us
Valid forUntil January 1, 20301 year from issueYour term
Runs onAny machineThe Identity it was issued forThe Identities you need
shell, artifact, runtime, workflow, agent
proxy1 connection, 1 GB trafficYour limits, or unlimited
bridge1 connection, 1 GB trafficYour limits, or unlimited

The Free license is the one to reach for when you need proxy or bridge — that is the only capability difference from General. Everything else is identical, so an engine that never opens a tunnel or a bridge runs happily on General forever.

Getting your identity

Licenses are tied to your machine's unique Identity and cannot be transferred between machines. Get it with:

dxflow engine info
Identity:    cc2bcf4a9fc3fa056189533df3ee3af6
Directory:   /home/user/.dxflow
Profile:     default

License commands

CommandDescription
dxflow license infoView active license details
dxflow license createCreate a license via dxflow Cloud in your browser (alias: license issue)
dxflow license activateDownload and activate this engine's license (alias: license active)
dxflow license activate --name <NAME>Activate a license issued under a custom name
dxflow license activate --no-downloadActivate a license file already in the dxflow directory
dxflow license deactivateRevert to the built-in General license (alias: license deactive)

dxflow license create opens your browser to dxflow Cloud with your Identity and name pre-filled, guides you through authentication, and generates the license file. Activating downloads the license from dxflow Cloud, stores it as license-<identity>.json (identity truncated to 8 chars), and updates the license config setting.

activate reads your Identity from the machine and the name from your hostname — the value dxflow license create pre-fills — and the download is authorized by that pair. Pass --name when you renamed the license in dxflow Cloud.

Creating a custom license

Run the create command

dxflow license create

Your browser opens with your details pre-filled.

Authenticate

Choose Google (verified via email) or Stripe (verified with any payment card — no charges, the card is used only for identity verification and is not stored).

Configure

The license name is pre-filled with your hostname — keep it so activation resolves it for you. Other settings are automatic: validity 1 year, all core modules enabled, and proxy and bridge each with 1 connection and 1 GB traffic.

Download and activate

dxflow license activate

The engine downloads the signed license from dxflow Cloud and activates it. Add --name <NAME> when you renamed the license.

Authentication ties each license to a verified identity to prevent abuse; no payment or personal data is collected beyond what verification needs.

License format

{
  "identity": "your-machine-identity",
  "name": "License Name",
  "owner": "Anonymous",
  "starts": "Mon, 01 Jan 2025 00:00:00 GMT",
  "expires": "Mon, 01 Jan 2030 00:00:00 GMT",
  "permission": {
    "shell": {},
    "artifact": {},
    "runtime": {},
    "workflow": {},
    "agent": {},
    "proxy": {
      "count": 1,
      "traffic": 1024000000
    },
    "bridge": {
      "count": 1,
      "traffic": 1024000000
    }
  },
  "signature": "cryptographic-signature",
  "issued": "Mon, 01 Jan 2025 00:00:00 GMT"
}

Need a different license

The Free license fits a single engine with light tunnelling. Write to info@dxflow.ai when you need any of:

  • Higher or unlimited proxy / bridge limits — more connections, more traffic, or no cap at all
  • A longer term — beyond the 1 year a Free license carries
  • Several engines — one license per Identity, issued together
  • Compliance requirements — a named owner, an agreed term, or a signed agreement

Tell us your engine Identity (dxflow engine info), the modules and limits you need, and the term. Licenses arrive the same way as any other: dxflow license activate picks them up.

When a Free license expires, run dxflow license create again and re-activate.

Troubleshooting

ProblemFix
License not verifiedConfirm the file is unmodified, the license identity matches your machine, and the system date/time is correct
License expiredCheck the expiration date with dxflow license info, then run dxflow license create
Invalid license signatureThe file may be corrupted — download a fresh copy
License not found on activateThe name must match the one used at issue time — check it in the Cloud license list and pass --name

Check current status with dxflow license info, and report issues at GitHub.