Skip to main content

License Management

PpRx requires a valid license to run. This page covers checking out a license, checking license status, and inspecting the currently installed license.

Customer ID vs. License ID

PpRx licensing uses two different identifiers, and either one can be supplied when checking out a license or checking license status:

  • Customer ID: identifies your organization's account as a whole. Every license is associated with a single Customer ID, and there may be multiple licenses associated with a single Customer ID.
  • License ID: the unique identifier for each license.

License Management Utilities

checkout_license and license_status are standalone executables included with the PpRx installation. Both utilities require internet access.

Checking Out a License

To check out a license from the CLI, run checkout_license:

cd <locus-lock-directory>/src/license-management
./checkout_license

checkout_license prompts for a Customer ID or License ID, then activates the license for the current machine.

note

If you'd like to check out a particular license associated with your account, input the License ID. Otherwise, use your Customer ID.

In the GUI, select HelpLicense ManagementCheckout License. Follow the prompts.

note

Always run checkout_license in the same environment PpRx will execute in. If PpRx runs in a Docker container, run checkout_license in that container rather than on the host. See Set Up PpRx in a Docker Container.

Checking License Status

To inspect the status of a particular license, or the licenses associated with a Customer ID, run license_status:

cd <locus-lock-directory>/src/license-management
./license_status

When prompted, enter the desired Customer ID or License ID.

In the GUI, license_status can be run by selecting HelpLicense ManagementLicense Status.

Viewing the Installed License

Once a license is checked out, pprx --license displays the license currently installed on the machine. This command does not require internet access:

pprx --license

This prints the License ID, Customer ID, and expiration date associated with the installed license. If applicable, the next check-in date is also displayed.

License Check-Ins

License check-ins may be required depending on the environment in which PpRx runs. This is most common in VMs and Docker containers. When check-ins are required, run checkout_license at least once every 30 days. Use pprx --license to view your next check-in date, if applicable.

Keep in mind that this licensing scheme is intended for LEO100 evaluation kits; production PpRx licensing is tailored to customer needs. Please contact Locus Lock at support@locuslock.com with questions about production licensing.