Licensing
License server for studios
The Higx License Server lets a studio pool all of its seats on one machine and share them across every workstation and render node on the network. Register your key once; machines borrow a seat while a Higx host is running and return it when they close.
One seat covers a whole machine, however many host applications it runs at once. Workstations and render nodes never need internet access and never see a key. The server itself behaves like a single activated workstation: it confirms the licence with Higx about once a week and keeps serving seats for up to 30 days without any internet at all.
Download the license server for Windows, macOS or Linux from the downloads page. It is a single console program with no installer: unpack it anywhere on the server machine.
Requirements
- One always-on machine on your network. Windows, macOS or Linux; a small virtual machine is fine, the load is negligible.
- Outbound HTTPS from that machine to
license.higx.net: once when you register a key, then about weekly. Through a proxy is fine. If the machine may not connect out at all, register it offline instead; see No internet on the server machine. - Inbound TCP port 45710 open on that machine's firewall, from your LAN.
Setup
-
Start the server on the machine you chose:
higx-license-server runIt is a single console program with no installer to run. Before you go live, set it to start on boot; that is its own section below.
-
Register your licence key from the purchase email, in a second terminal on the same machine:
higx-license-server add-key XXXXXXXX-XXXXXXXX-XXXXXXXX-XXXXXXXXA multi-seat purchase is one key worth all its seats. Buying five seats in one checkout means one
add-keyand a five-seat pool. Several keys pool into one seat count.A key registered on the server cannot at the same time be activated on an individual machine, and vice versa. If some machines already have the key activated on their own,
add-keytells you which ones. Either deactivate them from their licence windows, or runadd-key XXXX --takeoverto pull everything into the pool at once. -
Point your machines at the server. Set one environment variable machine-wide, through group policy, your management tooling, or the render-job environment:
HIGX_LICENSE_SERVER=yourserver:45710Or, if you prefer pushing files, put the same value (
yourserver:45710) on one line in:Platform File Windows %ProgramData%\Higx\license_server.txtmacOS /Library/Application Support/Higx/license_server.txtLinux /etc/higx/license_server
That is the whole setup. Plugins on those machines lease from the pool automatically. Artists see Licensed (floating) in the status line and never deal with keys.
A terminal on the server machine after add-key, showing the key accepted and the seat count.
images/license-server-add-key.png
No internet on the server machine
If your security policy does not allow the server machine any outbound connection, not even through a proxy, register your key offline. You need one other machine with a web browser and internet access. The licence key never has to be typed on the server.
-
Write an activation request on the server machine:
higx-license-server save-requestThis writes
higx_activation_request.jsonin the current folder; give a path or folder to write it elsewhere. It holds this machine's ID and name, nothing secret. -
Turn it into a licence file on the online machine: open license.higx.net/offline, drop the request file on the page, enter your licence key, and the page downloads a
.higxlicfile. -
Register the licence file on the server machine:
higx-license-server import-license <the downloaded file>.higxlicA running server picks it up within a minute.
These three steps replace step 2 of the setup above; everything else is the same.
- A server registered this way never contacts
license.higx.netfor that key, not even to check in. - The licence file is valid for one year, or until your licence ends if that is sooner.
higx-license-server statusand the status page show the date, and the server log warns daily in the last 30 days. To renew, bring the same request file to the page again and import the new licence file. The old one keeps working until it expires or the new one is imported. - Bought more seats? Make a licence file for the new key the same way and import it. The pool grows within a minute.
- A licence file only works on the machine whose request it was made from. Moving the server means a new request from the new machine. If the page then lists the old server as holding the key, click Free seat next to it first.
remove-keyon an offline server takes the key out of the pool but cannot tell us. If you later register that key somewhere else, the old server still shows as holding it: click Free seat next to it on the page, or useadd-key --takeoveron a server with internet.
Make it start on boot
Worth doing before you go live. If the server is not running, plugins do not error: they render with the unlicensed banner. So a server machine that came back from a reboot without it looks like a licensing fault rather than a stopped program.
Run it as the same account you registered the key with, and it finds its keys where it left them.
Linux (systemd)
Put this in /etc/systemd/system/higx-license-server.service:
[Unit]
Description=Higx License Server
Wants=network-online.target
After=network-online.target
[Service]
ExecStart=/usr/local/bin/higx-license-server run
User=<the account you ran add-key as>
Restart=always
[Install]
WantedBy=multi-user.target
sudo systemctl enable --now higx-license-server
macOS (launchd)
A LaunchDaemon in /Library/LaunchDaemons/net.higx.licenseserver.plist with RunAtLoad and KeepAlive true, the binary plus run as its ProgramArguments, and UserName set to the account you ran add-key as. A LaunchDaemon runs as root otherwise, and root has no keys. Then:
sudo launchctl bootstrap system /Library/LaunchDaemons/net.higx.licenseserver.plist
Windows (Task Scheduler)
A task with an At startup trigger running higx-license-server.exe run, set to run whether or not anyone is logged on. sc create will not do: this is a console program, not a service binary.
Then prove it
Reboot the machine once on purpose and check that the startup line in the log still reports your real seat count:
higx-license-server starting: product higxbokeh, 1 key(s), 2 seat(s), port 45710
If it says 0 key(s), the server is running as a different account than the one you registered the key with. Fix User= or UserName, or give both commands the same --state DIR.
Monitoring
- Status page:
http://yourserver:45710/shows the seats in use, which machines hold them, the health of each registered key, and the newest published Higx build with its download link. Start the server withrun --privateif the page should only be visible on the server machine itself. - Command line:
higx-license-server statuson the server machine shows the same.higx-license-server free <machine-name>force-releases the seat of a crashed or retired machine. - Log: every grant, release and denial is written to
server.login the server's state folder, and to the console. "Why did nobody have seats at 3 am" is answerable from that file.
| Platform | State folder |
|---|---|
| Windows | %ProgramData%\Higx\LicenseServer |
| macOS | ~/Library/Application Support/HigxLicenseServer |
| Linux | ~/.local/state/higx-license-server |
The server's status page in a browser: seat count, the lease table with machine names, key health.
images/license-server-status-page.png
Behaviour worth knowing
- A seat is held while any Higx-using host runs on a machine, and frees itself about five minutes after the last one closes or crashes. A render that takes hours per frame holds its seat the whole time: seats time out on silence, never on being busy.
- If the server machine reboots, running machines coast through it for about two hours and re-lease automatically. Leases live in memory; there is nothing to back up except your licence keys.
- If the pool is ever full, the plugin keeps rendering. The output passes through with the unlicensed banner instead of failing the render, the status line says all seats are in use, and the denial is in the server log with the machine's name.
- A laptop that leaves the network loses its lease about two hours after it last reached the server. It shows the banner until it is back on the network, unless it also has its own activation with a different key.
- Leased machines get no update notices. The status page shows the newest published build, and you decide when the studio moves.
Render nodes
Nothing special. A node boots, the plugin leases a seat from the pool, and the seat frees itself by silence after the job. Render seats come from the same paid pool as workstation seats, and one node is one seat however many frames it renders in parallel.
Buying more seats
Buy on the store as normal, then add-key the new key on the server. The pool grows within a minute, with no restart and without touching any workstation or render node.
Moving the server
Gracefully: remove-key each key on the old machine, then add-key on the new one. If the old server is dead or wiped, run add-key XXXX --takeover on the new machine. Possession of the licence key is your proof of ownership, so the takeover reclaims the key without anyone at Higx being involved.
Command summary
higx-license-server run [--port N] [--private] serve seats (default port 45710)
higx-license-server add-key <KEY> [--takeover] register a key; --takeover reclaims a held key
higx-license-server remove-key <KEY> return a key to normal per-machine use
higx-license-server save-request [FILE] no internet: write this machine's activation request
higx-license-server import-license <FILE> no internet: register the .higxlic licence file
higx-license-server status keys, pool and the live lease table
higx-license-server free <MACHINE> force-free the seat of a dead machine
--state DIR any command: keep keys and log in DIR instead of the default state folder
Questions or trouble: contact support with your licence key. That is all that is needed to see exactly what the key entitles and where its seats are.