Request a License

self-hosting licensing partner-portal deployment-id

Request a License

Every Huitzo Self-Hosted deployment runs on a signed license.json that Huitzo issues to the client for that one deployment. A partner administrator at your firm requests it in the partner portal, partners.huitzo.ai, once the deployment shows its deployment ID. Under the partner program Huitzo licenses and invoices the client; your firm refers, implements and supports.

Who can request

Only users with the partner administrator role (partner_admin) in the partner portal can request, renew or download licenses. Partner members can see your firm's clients but cannot request licenses. If nobody at your firm has the role, ask your Huitzo partner contact to assign it.

Your firm must have accepted the current published Partner Agreement in the portal. Until it has, every license request is refused (403).

Before you request

You need:

Item Where it comes from
The client The end customer the license is for: a client your firm owns or holds an active grant for in the portal. You can create a new client in the form.
The deployment ID The deployment itself, after its first start (Find the deployment ID).
The purpose and term Purposes and term caps, below.
Options White-label branding, if the client needs it (White-label branding). It must be in the license; it cannot be switched on later without a new file.
End-customer legal name and country The client's legal entity, for the license record.
Export-control attestation A checkbox on every request: your firm attests that it screened the end customer.
Invoice For NFR, Paid and every renewal: an invoice linked when you submit, billed to your firm or the client and not void. Whether it is paid is checked when the license is released, not at submit. A Paid request needs an invoice with a paid-through date.
License agreement signer For Pilot and Paid: the client contact who accepts the license agreement (License agreement).
Deal registration Optional: your firm's own deal registration, for referral attribution.

Find the deployment ID

A license names the deployment ID it is for, and a deployment ID exists only after the deployment's first start. Install the release first, without a license (Quick start); the deployment boots in setup mode and shows its ID. It has the form hzd_ followed by 26 letters and digits. Read it from any of these:

  • the last lines of the first install.sh run, which print it in groups of four for reading aloud;
  • the dashboard's setup page, https://<your host>/setup (on the host itself, http://127.0.0.1:3000/setup while in setup mode), with a copy button;
  • the license card under the dashboard's admin settings, once an admin is signed in;
  • GET /api/v1/setup/status (deployment_id), which needs no sign-in;
  • huitzo license id, on a Huitzo CLI that includes the license id command.

Enter the ID without spaces. Each deployment (production, staging, training) has its own ID and needs its own license. Restoring a backup keeps the ID; rebuilding from an empty database creates a new one and needs a reissued license (Deployment ID on restore).

Purposes and term caps

Every license carries a signed purpose. The deployment refuses a file whose term is longer than its purpose allows, so ask for a term within the cap.

Purpose Edition Maximum term Limits Grace after expiry Use
Demo or proof of concept (demo_poc) Core Preview 90 days per file 1 team, 3 users per team, 3 Packs, 500 runs per 30 days; a "not for production" banner 7 days Evaluation by a prospective client
Pilot (pilot) Core Licensed 90 days per file; 365 days in total per deployment ID None by default 14 days A defined pilot under a pilot agreement
Not for resale (nfr) Core Licensed 366 days (12 months, so a leap day fits); at most 2 active per partner, on your firm's own clients only None by default 14 days Your firm's own demo and training environment
Paid (paid) Core Licensed 1096 days (3 years, so a leap day fits), never past the invoice's paid-through date None by default 14 days Production use under contract

The form defaults the term to the cap; the term counts from signing. The editions are described in Core editions. After expiry and its grace, the deployment stops serving until a renewed file is placed; request renewals at least 30 days before expiry (Renew).

License agreement

The client accepts the Huitzo Self-Hosted license agreement with Huitzo before a Pilot or Paid license is issued; a Paid license also needs the client's paid invoice. Demo/POC and NFR licenses are covered by your firm's partner agreement and need no client acceptance. The license agreement allows one deployment per license and prohibits changing or bypassing license checks.

A Demo/POC license is signed as soon as you submit. A Pilot license is signed automatically when the client accepts the agreement. NFR and Paid licenses wait for a Huitzo approval and an offline signature (Paid also for the paid invoice and the client's acceptance), so allow more time for them.

Submit the request

  1. Sign in to partners.huitzo.ai as a partner administrator and open Licenses.
  2. Fill in the request form: the client, the deployment ID, the purpose and term, the white-label option, the end customer's legal name and country, the export-control attestation, and, where the purpose needs them, the invoice and the license agreement signer (Before you request).
  3. Follow the request's state on the Licenses page until it is issued.

One deployment ID has one active license. A request for an ID that already has an open request or a live license is refused (409) and points you to renewal. A renewal replaces the deployment's live license; it does not add a second one. An edition change or a reissue after a restore goes the same way.

Request states

State Meaning
Submitted Received.
Awaiting approval NFR or Paid: waiting for Huitzo's approval.
Awaiting customer acceptance Pilot or Paid: waiting for the client to accept the license agreement.
Awaiting payment The linked invoice is not paid yet.
Signing paused Automatic signing is paused on Huitzo's side; the request resumes without action from you.
Issued Signed; ready to download.
Delivered Downloaded.
Rejected Refused by Huitzo, with a reason.
Cancelled Cancelled.
Request expired (request_expired) The acceptance or approval arrived after the requested expiry date; nothing was signed. Submit a new request.

Download and install

The issued license appears on the portal's Licenses page as a signed license.json download. The portal records every download. Copy the file to the host unchanged: any edit, including reformatting, breaks its signature. Then install it:

# pseudocode: on the host, from the directory holding the release assets
./install.sh --license license.json

install.sh checks the file offline against this deployment's ID before it places it, then starts the HTTPS profile (Install). The platform verifies the license on the host and never contacts a Huitzo license server.