Skip to main content

Set up full offline mode

To set up full offline mode, install the LGS on a machine without internet access, and configure it for offline use. For the CLI workflow, also install the Pdftools Licensing Shell (ptl) on a machine with internet access.

note

Full offline mode needs a license key that supports it, and isn’t available for free trial license keys. For details, refer to Before you start. For Docker deployments, refer to Full offline mode in Docker.

Install the LGS​

Install the LGS to set up fully offline configuration. Download and install the package on a machine in your network that is not connected to the internet.

LGS is installed with the Conversion Service on Windows Server
  • The Conversion Service comes with the LGS preinstalled on Windows. Installing the LGS on such a machine for the second time may render the Conversion Service unusable. For more details, review the implementation of the Licensing Gateway Service in the Conversion Service licensing documentation.
  • The full offline mode is available in the Conversion Service version 6+. Configure the full offline mode using steps described in Full offline mode license activation section.
Conversion Service and LGS on another machine

If you want to install the LGS on another machine than the one where you run the Conversion Service, follow the steps in this section Install the LGS, and then continue with Full offline mode license activation section.

  1. Download the LicensingGatewayService.msi package.
  2. Run the installer.

The installer also creates a Windows 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:

  1. Find the LGS configuration file appsettings.json:

    For Windows, the configuration file is in the installation folder, for example:

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

    Example configuration file:

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

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

    Example configuration file after update:

    {
      "LicensingServicePortNumber": 9999,
      "LogFilePath": "C:/logs/pdftls/log.txt",
      "LogRetentionDays": 7,
      "IsOfflineMode": true,
      "Endpoints": []
    }

  3. 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. For the DEB and RPM packages and the archive, keep the path that the installation sets.
    • Log retention: Define the number of days the log files remain.
    • Endpoints: An array of stored LGS endpoint URLs for batch commands. Managed through ptl endpoints-add and ptl endpoints-remove, but you can also edit this field manually.

  4. Restart the service after modifying the appsettings.json file so the changes take effect.

Install the Pdftools Licensing Shell on the online machine​

To use the CLI-based activation and deactivation workflows, install the Pdftools Licensing Shell (ptl) on a machine in your network that is connected to the internet.

info

The online machine runs the same ptl CLI as the offline machine. Install the package that contains only the CLI, as described in the following steps.

  1. Download the LicensingShell.msi package.
  2. Run the installer.

After the setup, activate your license keys as described in Activate license keys offline.