On Prem

Installation

Installation and License Activation

This section walks you through installing ZeroThreat On-Prem using the CLI and activating your license. The process is designed to be guided and interactive, with system checks and dependency installation handled automatically where possible.

Prerequisites

Before starting the installation, ensure the following requirements are met:

  • Node.js: Latest stable version installed
  • Disk space: At least 50-100 GB of free disk space for initial installation
  • Internet access: Required during installation to download system images
  • Operating system: Linux, macOS, or Windows using WSL

Note
Docker is not a direct prerequisite. If required, the ZeroThreat CLI installer can install and configure Docker as part of the setup process.

Official reference

Supported Installation Environments
ZeroThreat On-Prem can be installed on Linux, macOS, and Windows using WSL. The CLI-based installer is designed to run in these environments and will guide you through dependency checks, installation, and license activation.

For ZeroThreat On-Prem installation on a cloud VM, use the following minimum and recommended system configuration:

Minimum

  • 16 GB RAM
  • 64 GB disk
  • 4 vCPUs

Suggested example instance series for minimum sizing

  • AWS: m6i.xlarge or m7g.xlarge for general purpose, t3.xlarge or t4g.xlarge for burstable
  • Azure: Standard_D4s_v5 for general purpose, Standard_B4ms for burstable
  • GCP: n2-standard-4 for general purpose, e2-standard-4 for burstable

Recommended

  • 32 GB RAM
  • 128 GB disk
  • 8 vCPUs

Suggested example instance series for recommended sizing

  • AWS: m6i.2xlarge or m7g.2xlarge for general purpose, t3.2xlarge or t4g.2xlarge for burstable
  • Azure: Standard_D8s_v5 for general purpose, Standard_B8ms for burstable
  • GCP: n2-standard-8 for general purpose, e2-standard-8 for burstable

IMPORTANT: The instance models above are only suggested examples. Any equivalent VM with similar CPU, memory, and disk capacity will also work.

Step 1: Install ZeroThreat CLI

Install the ZeroThreat CLI globally using npm:

npm install -g @zerothreatai/cli

This command installs the CLI tool that manages installation, configuration, and lifecycle operations for On-Prem deployments.

Troubleshooting

  • If you see permission errors, ensure you have sufficient privileges
  • If npm fails due to Node version issues, upgrade to the latest stable Node.js release

Step 2: Launch the Installer

Once installation completes, start the installer by running:

zt

This opens the interactive On-Prem installer, which guides you through system checks, dependency installation, and license activation.

Thumbnail

Step 3: Install Prerequisite Software (if prompted)

If the installer detects missing system dependencies, select:

Install Prerequisite Software for [Linux] Environment

The installer will automatically install and configure required components, including Docker if needed.

Once completed, you should see a confirmation message indicating that system requirements are met.

Thumbnail

Step 4: License Activation

After system checks pass, the installer proceeds to license activation.

You will be prompted to enter:

  • The email address associated with your ZeroThreat organization
  • A valid On-Prem license key

To find these details, log in to your ZeroThreat Cloud organization and go to the Licenses section. The On-Prem license must already be purchased before it can be used during installation.

Thumbnail

During CLI installation, enter the organization email address and the license key shown in the On-Prem Licenses section of ZeroThreat Cloud version. The email address must belong to the same ZeroThreat organization where the On-Prem license was purchased. This allows the installer to verify that the license is being activated for the correct organization.

Thumbnail

After the email and license key are verified, the license is activated and the installer begins downloading the required system images, approximately 12–15 GB. This may take several minutes depending on your network speed.

Common License Activation Error

If installation is interrupted and, on restart, you encounter the following error:

Verification failed. Please check your details.

Error: License cannot be activated. Its current status is 'ClaimRequested'.

This indicates that the license was partially claimed during a previous attempt.

How to resolve

  • Log in to your ZeroThreat Cloud organization
  • Locate the license and change its status from Claim Requested by clicking on the Reset Claim Request button.
Thumbnail
Thumbnail
  • Restart the installer and activate again
Retrying activation without resetting the license state will continue to fail.

Step 5: Accessing ZeroThreat On-Prem

After successful installation and activation, the installer displays a local access URL.

Use this URL to access your ZeroThreat On-Prem instance and continue configuration.

Thumbnail

What’s Next?

Now that ZeroThreat is installed, learn how to manage licenses in our License Management guide.