Full offline mode

Use the Pdftools software fully offline with valid license keys for at least three months or more, depending on the type of your license. Your local network can stay without an internet connection, and the license keys are validated for a set period of time.

Not available in the Conversion Service

The LGS in full offline mode is not yet available for the Conversion Service. If you are interested in this feature, contact sales.
The Conversion Service comes with the LGS preinstalled. Installing the LGS on such a machine for the second time may render the Conversion Service unusable. For more details, review more about implementation of the Licensing Gateway Service in the Conversion Service licensing documentation.

Install the LGS

Install the LGS to enable fully offline configuration, download and install the package on a machine in your network that is not connected to the internet.

note

Ensure you install the LGS on an offline machine in full offline mode. However, in the connected mode, you need to install the LGS on a computer that is connected to the internet.

Windows
Linux

Download the LicensingGatewayService.msi package.
Run the installer.

The installer copies the required binary files, sets up the port and environment variables, and creates and runs a Windows service that acts as an agent to regularly synchronize the LGS with the Pdftools Licensing Server.

Download the licgwy_amd64.snap package.

Run the installer with the following command:

snap install licgwy_amd64.snap --classic --dangerous

The installer copies the required files, sets up the port and environment variables, and creates and runs a service that acts as an agent to regularly synchronize the LGS with the Pdftools Licensing Server.

Configure the LGS for offline use

To configure the LGS:

Locate the LGS configuration file appsettings.json:

Windows
Linux

For Windows, the file is in the instalation folder, for example:

C:\Program Files\Pdftools\Licensing Gateway Service\appsettings.json

For Linux systems the file is in the $SNAP_DATA directory, for example:

/var/snap/licgwy/current/appsettings.json

Example configuration file:

{
  "LicensingServicePortNumber": 9999,
  "LogFilePath": "C:/logs/pdftls/log.txt",
  "LogRetentionDays": 7
}

Enable offline mode in LGS. Update the configuration file so that IsOfflineMode property is set to true.

Example configuration file after update:
```
{
  "LicensingServicePortNumber": 9999,
  "LogFilePath": "C:/logs/pdftls/log.txt",
  "LogRetentionDays": 7,
  "IsOfflineMode": true
}
```
Optionally, you can configure these options:
- Licensing Service Port number: Set the port number used by the service. The default value is 9999.
- Log file path: Specify the desired path of the log files.
- Log retention: Define the number of days the log files are kept.
Restart the service after modifying the appsettings.json file for the changes to take effect.

Install the Licensing Gateway Activator

To start using the Licensing Gateway Activator (LGA), download and install the package on a machine in your network that is connected to the internet.

Windows
Linux

Download the LicensingGatewayActivator.msi package.
Run the installer.

The installer copies the required binary files and sets up environment variables, so that you can use LGA CLI.

Download the licgwyactivator_amd64.snap package.

Run the installer with the following command:

snap install licgwyactivator_amd64.snap --classic --dangerous

Offline license configuration

The following sections teach you how to manage your license keys offline using the LGS CLI and LGA CLI tools. Perform each step accurately to maintain the integrity of the licensing process. If you encounter any issues, please contact Pdftools support.

Prerequisites

To use the license keys offline, fulfill the following prerequisites:

The Licensing Gateway Service CLI (licgwy) is installed on a machine that is not connected to the internet (offline machine).
The Licensing Gateway Activator CLI (licgwyactivator) is installed on the machine that is connected to the internet (online machine).

Activate license key offline

Follow these steps to activate or extend a license key in the offline mode:

On the offline machine with installed Licensing Gateway Service, run the following command to generate a license request token:
```
licgwy export-activation LICENSE_KEY_VALUE
```
- Replace LICENSE_KEY_VALUE with your license key.
On the online machine with installed Licensing Gateway Activator, run the following command to generate a license activation token:
```
licgwyactivator activate LICENSE_REQUEST_TOKEN
```
- Replace LICENSE_REQUEST_TOKEN with the token from the previous step.
On the offline machine, run the following command to activate or extend the license key:
```
licgwy import-activation LICENSE_ACTIVATION_TOKEN
```
- Replace LICENSE_ACTIVATION_TOKEN with your license activation token from the previous step.

The license is now activated or extended and ready for use.

note

When you activate a license key in LGS, it is linked to the machine where you activated it. If you install LGS on another machine, deactivate the license key first so you can activate it again in LGS.

Deactivate license key offline

Why deactivate a license key? If a machine with a license key activated in an LGS becomes inaccessible, the license key will be blocked and unusable. Unfortunately, you won't be able to activate or deactivate the blocked license key and move it to another machine. This often happens with discontinued servers or removed virtual machines where our customers did not deactivate their license key in LGS before removing the machine itself.

info

If your license key became blocked, as described in the previous paragraph, contact Pdftools support to unblock the license key. Review the Support page.

If you want to remove a machine where you have activated license keys in LGS:

Deactivate the license key.
Remove the machine.
Activate the license key on another machine with LGS.

Follow these steps to deactivate a license key in the offline mode:

On the offline machine with installed LGS, run the following command to generate a license request token and locally deactivate the license key:
```
licgwy export-deactivation LICENSE_KEY_VALUE
```
- Replace LICENSE_KEY_VALUE with your license key.
- You cannot generate a new activation request token for the same license key until you complete all deactivation steps.
On the online machine with installed Licensing Gateway Activator, run the following command to generate a license deactivation token:
```
licgwyactivator deactivate LICENSE_REQUEST_TOKEN
```
- Replace LICENSE_REQUEST_TOKEN with the token from the previous step.
On the offline machine, run the following command to activate or extend the license key:
```
licgwy import-deactivation LICENSE_DEACTIVATION_TOKEN
```
- Replace LICENSE_DEACTIVATION_TOKEN with your license activation token from the previous step.

The license is now completely removed from the system. If necessary, you can generate a new activation request token for this license key.

References

The following sections list the most important LGS and Licensing Gateway Activator commands in the fully offline configuration.

LGS CLI commands

The LGS includes a command-line interface (CLI) utility for managing licenses associated with your Pdftools products.

To access a full list of available commands, use the licgwy help command.

Command	Description
`licgwy help`	Get instructions on how to use the CLI with a full list of commands.
`licgwy version`	Get the LGS version number.
`licgwy export-activation LICENSE_KEY_VALUE`	Export an activation request.
`licgwy import-activation LICENSE_ACTIVATION_TOKEN`	Import an activation response.
`licgwy export-deactivation LICENSE_KEY_VALUE`	Export a deactivation request.
`licgwy import-deactivation LICENSE_DEACTIVATION_TOKEN`	Import a deactivation response.
`licgwy status`	Check the licensing service status.
`licgwy list`	Get information about added license keys and for how long they are valid.

Licensing Gateway Activator CLI commands

The Licensing Gateway Activator is a command-line interface that you can use to get activation or deactivation tokens for your offline license keys.

To access a full list of available commands, use the licgwy help command.

Command	Description
`licgwyactivator help`	Get instructions on how to use the CLI with a full list of commands.
`licgwyactivator version`	Get the licensing gateway activator version number.
`licgwyactivator activate LICENSE_REQUEST_TOKEN`	Activate an offline token.
`licgwyactivator deactivate LICENSE_REQUEST_TOKEN`	Deactivate an offline token.

Install the LGS​

Configure the LGS for offline use​

Install the Licensing Gateway Activator​

Offline license configuration​

Prerequisites​

Activate license key offline​

Deactivate license key offline​

References​

LGS CLI commands​

Licensing Gateway Activator CLI commands​