Installation and Operation

OnPremPDF is operated entirely on your own infrastructure. The software is designed for use in internal networks and does not require an internet connection after installation.

System Requirements

  • Linux VM or physical server
  • Debian or Ubuntu (LTS recommended)
  • At least 2 GB RAM (4 GB recommended)
  • At least 1 CPU core (2 recommended)

The installation script automatically installs the required Java Runtime (OpenJDK 17), configures the Apache Tomcat web server, and deploys the OnPremPDF web application. No internet access is required after installation.

Installation

Install once · Upgrade later via license file

Two installation methods are available. For production environments and security-conscious users, installation via Git is recommended.

Recommended

Installation via Git (transparent & auditable)

Recommended installation method for production environments. The installation script can be reviewed and audited before execution.

sudo apt update
sudo apt install -y git
git clone https://github.com/onprem-pdf/onprempdf.git
cd onprempdf
sudo bash install.sh
Quick Install

Installation via cURL

Fast installation using an automated installation script. This option is suitable for testing and evaluation purposes.

sudo apt update
sudo apt install -y curl
curl -fL https://raw.githubusercontent.com/onprem-pdf/onprempdf/main/install.txt | sudo bash

What does the installer do?

The installation script prepares a minimal and self-contained On-Prem environment. All steps are deterministic and can be reviewed before execution.

  • Installs OpenJDK 17 (headless)
  • Installs Apache Tomcat 9.x (latest stable)
  • Creates a dedicated tomcat system user
  • Deploys the OnPremPDF WAR file
  • Configures local admin authentication

After installation, the system runs fully offline. No telemetry, no tracking, and no external network calls are performed by the application.

The installation script can be reviewed and audited before execution.

Post-installation Output

After a successful installation, a summary of the configured components is displayed in the terminal:

==========================================================
Installation completed!

----------------------------------------------------------
Security notice:
Tomcat is listening on port 8080 for internal access.
Ensure this port is not exposed to public networks.
Restrict access via firewall or network configuration.
----------------------------------------------------------

PDFGuard API:
http://SERVER-IP:8080/pdfguard/api/v1/render

Administration interface:
http://SERVER-IP:8080/pdfguard/

Admin login:
Username: pdfguard
Password: <generated during installation>

The password is generated randomly during installation.

Credentials are stored locally in:
/opt/tomcat/conf/tomcat-users.xml
(permissions: 600, readable only by the tomcat user)

Please store this password securely.
==========================================================

The administration interface is automatically secured with a randomly generated password. There are no default credentials.

Local API Endpoint

After installation, the API is available locally at:

http://server-ip:8080/pdfguard/api/v1/render

This endpoint is accessible only within the local network and is not publicly exposed.

Administration Interface

After installation, a local administration interface is available. It is used to monitor the system and manage the license.

Access:

http://SERVER-IP:8080/pdfguard/
  • PDF service status
  • Active license type
  • Version information
  • Local API endpoint

The interface is accessible only locally and protected by HTTP Basic Authentication.

License Activation

After purchasing a license, you will receive a license key which is entered once via the administration interface.

The software will automatically switch from Lite mode to the licensed edition. No restart is required.

Operation & Offline Capability

  • Fully offline operation supported
  • No telemetry or usage analytics
  • No external API calls
  • Suitable for isolated networks

Installation script (install.sh)

The installer is shown in full for transparency. You are encouraged to review it before execution.