Licensing¶

Sapsan supports online licensing and licensing with a USB key for isolated networks.

Feature availability¶

The license may determine which functions and features are available. This documentation may therefore cover more capabilities than are available in a particular customer delivery.

Online licensing¶

Online licensing uses a license file issued at purchase. You can download the license key from the client area at my.flussonic.com.

Verification uses the Flussonic licensing servers, so this mode requires internet access.

USB license key for isolated networks¶

An isolated network without internet access uses a hardware USB license key. The key is supplied for the chosen solution; connection and activation instructions are provided with the delivery documentation.

Online license files¶

In online licensing mode, the license file is stored next to the configuration. Sapsan creates the other files in the state directory during activation.

Environment variables control where Sapsan looks for files:

• State directory — SAPSAN_STATE_DIR, else the parent of SERVER_ID_PATH, else the current working directory. The deb package and Docker image set SERVER_ID_PATH=/var/lib/sapsan/server.id, so the state directory is /var/lib/sapsan.
• License file — LICENSE_PATH, else {dirname(CONFIG_PATH)}/license.txt, else {state_dir}/license.txt. With CONFIG_PATH=/etc/sapsan/sapsan.yaml this is /etc/sapsan/license.txt.

See Installation for choosing a licensing mode during deployment.

States¶

The current license status is served by the API: GET /streamer/api-v4/license/status.

Next steps¶

• Admin API