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

Setup

  1. Start the server on the machine you chose:

    higx-license-server run

    It 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.

  2. Register your licence key from the purchase email, in a second terminal on the same machine:

    higx-license-server add-key XXXXXXXX-XXXXXXXX-XXXXXXXX-XXXXXXXX

    A multi-seat purchase is one key worth all its seats. Buying five seats in one checkout means one add-key and 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-key tells you which ones. Either deactivate them from their licence windows, or run add-key XXXX --takeover to pull everything into the pool at once.

  3. 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:45710

    Or, if you prefer pushing files, put the same value (yourserver:45710) on one line in:

    PlatformFile
    Windows%ProgramData%\Higx\license_server.txt
    macOS/Library/Application Support/Higx/license_server.txt
    Linux/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.

Image

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.

  1. Write an activation request on the server machine:

    higx-license-server save-request

    This writes higx_activation_request.json in the current folder; give a path or folder to write it elsewhere. It holds this machine's ID and name, nothing secret.

  2. 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 .higxlic file.

  3. Register the licence file on the server machine:

    higx-license-server import-license <the downloaded file>.higxlic

    A running server picks it up within a minute.

These three steps replace step 2 of the setup above; everything else is the same.

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

PlatformState folder
Windows%ProgramData%\Higx\LicenseServer
macOS~/Library/Application Support/HigxLicenseServer
Linux~/.local/state/higx-license-server
Image

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

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.