How to license the groundSwXtch

  • Published on Oct 16, 2026
  • 1 minute(s) read
Prev Next

WHAT TO EXPECT

In this article, users will learn the appropriate steps for licensing their groundSwXtch instance via a License File provided by swXtch.io.

Locating the Fingerprint and Requesting a License

In order to receive a license file from swXtch.io Support, users will need to provide a groundSwXtch Fingerprint. This is something that can be found in the groundSwXtch User Interface.

  1. Open the groundSwXtch User Interface. Replace <groundSwXtch-IP> with the IP address of the groundSwXtch:

    http://<groundSwXtch-IP>/

  2. Select the Configure tab and select the groundSwXtch that needs a license (if it does not appear, see Add groundSwXtch).

  3. Select Copy, and send the groundSwXtch fingerprint to support@swxtch.io.

Adding the License File to the groundSwXtch

After receiving a license file from swXtch.io, users will now need to upload it to their groundSwXtch.

  1. Copy the contents of the license file.

  2. Open the groundSwXtch User Interface. Replace <groundSwXtch-IP> with the IP address of the groundSwXtch:

    http://<groundSwXtch-IP>/

  3. Select the groundSwXtch and select the Configure tab (if it does not appear, see Add groundSwXtch).

  4. Paste the license into the Install/replace license section and select Preview and Apply License:

  5. The License Preview page will display showing current and proposed license entitlements.

  6. If changes are acceptable, select Apply; else, Cancel.

  7. The license entitlements are now shown.

  8. On the main groundSwXtch page the green icon also shows that it is licensed.

Alternative: license from the command line

Without a browser (for example, on an air-gapped host), run these commands on the groundSwXtch host:

  1. Get the fingerprint and send it to support@swxtch.io:

    curl http://127.0.0.1/api/v1/license/fingerprint

  2. Copy the license file you receive into place:

    sudo cp license.key /var/lib/groundswxtch/license.key

  3. Load the license. No container restart is needed:

    curl -X POST http://127.0.0.1/api/v1/license/reload

The installer can also add the license during the installation with --license-dir <dir>: it copies <dir>/license.key into /var/lib/groundswxtch when no license is installed yet.