1. Docs
    2. arrow-right
  2. On-Premise Installation - Linux
Matches version: 3.5.6

On-Premise Installation - Linux

ItemPath is available as an on-premise application that can be installed and run on a server owned and operated by your company. 

The main reason for doing this is improved security by running ItemPath inside of your network. This does limit the level of support ItemPath can provide. You will be responsible for conducting your own installation and software updates.

If you have purchased the on-premise version of ItemPath, using a Linux server is strongly recommended, though ItemPath also supports installation onto Windows desktop. Windows Server is not officially supported (it doesn't support Docker Desktop, though some customers have reported success installing into Windows Server).

Hardware requirements

  • A dedicated machine or virtual machine (preferably Ubuntu Linux)
  • Ubuntu Linux 18 or greater (UI Linux isn't required)
  • A dual core CPU or greater
  • 4 GB RAM or greater
  • 50GB SSD or greater
  • Outbound Port 80/443 access for remote assistance, monitoring, and support of email outputs
  • A dedicated static (not dynamic) IP address for the machine
  • VPN and SSH access to this machine, with a local user with admin permissions

Software requirements

ItemPath is run using Docker containers: a container includes everything the software needs to run and simplifies the process of getting software to run reliably without having to worry about the environment it’s running in. See Why Docker for more information about using containers.

  • Docker Engine 19 or greater and Docker Compose 2 or greater.

Pre-Installation Checklist

Before being able to install ItemPath, you'll need a few things in place.

  • PPG SQL Server username, password, database name, dedicated IP address, and port number (if changed from the default port 1433).
  • PPG SQL Server will need to be able to accept remote connections via IP. The port should also be static, not dynamic. For more details on how to set this up, go here.

Initial setup

Once you’ve signed your purchase agreement, and ItemPath has processed your order, the ItemPath team will send you installation instructions, your license, a configuration file along with a username and password that will be needed during the install process:

  • install-deployment-manager.sh

Next, install Docker (if it isn't already available).

Installation via Docker

IMPORTANT: Do not install Docker via Snap on Ubuntu. Snap installations run in a restricted environment (sandboxed) that often causes permission issues with ItemPath. Always follow the official Docker Engine Installation Guide to add the official Docker repository to your system.

Docker is the recommended container solution for installing and running ItemPath, and can be broken down into a few simple steps:

  1. Confirm Docker 19 or greater is installed on the virtual machine by running docker version in the terminal. If Docker is not installed, instructions can be found here. 
  2. Required Post-Installation steps: Once Docker is installed, you must configure your Linux user to manage Docker without using sudo. This prevents file ownership conflicts when ItemPath creates its local database and log folders. Post-Installation steps can be found here.
  3. Install Docker Compose 2 or greater. Installation instructions can be found here.

Local Files

Once Docker and Docker Compose have been installed, you’ll want to take the install-deployment-manager.sh file that’s been provided to you and put that in the local user directory (~/).

  1. Ensure that a local user exists with root permissions. Use this user to install and run ItemPath (not under sudo).
  2. Copy the file provided by the ItemPath team to the following locations:
    1. Add install-deployment-manager.sh to your local user directory (~/).
  3. Run bash ./install-deployment-manager.sh latest in Terminal.

ItemPath Installation

Before you begin, check the latest release version here. 

  1. Log in to Docker to download the ItemPath images. To do this, run docker login.
  2. You'll be prompted to enter the username and password provided by ItemPath support.
  3. From the terminal, it’s time to download ItemPath. Navigate to the root  directory by typing cd ~. 
  4. Run ItemPath from the user directory (~/) by running this command from the terminal (NOTE: Replace [version number] with your desired version. Eg., 3.3.0): 
    itempath-deploy bootstrap [version number] --platform on-premise --yes

You can confirm ItemPath is running by visiting localhost in a browser, or by visiting the IP address of the host machine.

If you need to install ItemPath without a connection to the internet, please reach out to support@itempath.com for next steps.

ItemPath Startup & Shutdown

To start up ItemPath: Run ItemPath from the user directory (~/) by running from the terminal: itempath-deploy start.

To shut down ItemPath: Stop ItemPath from the user directory (~/) by running from the terminal: itempath-deploy stop.

To restart ItemPath: You can stop and restart ItemPath at the same time from the user directory (~/) by running from the terminal: itempath-deploy restart. This should stop ItemPath and all of its running containers, then relaunch each one.