On-Premise Installation

Preinstallation

Before being able to install ItemPath, we’ll need a few things first.

  • 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.

Configuration Files

Once the preinstallation information has been passed along to us, we’ll generate a couple of configuration files as part of your installation. Keep these as they will be needed during the install process.

  • docker-compose.yml - this will store all your proper boot up procedures for ItemPath, including running the web server, API, and other services
  • appdata.db - this is the initial internal database for ItemPath, such as root users, reports, and other data

Docker Installation

The installation process for ItemPath 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. Install Docker Compose 1.22 or greater. Installation instructions can be found here.
  3. Local user is created and has root/sudo permissions.

Local Files & Database

  • Once Docker and Docker-compose have been installed, you’ll want to take the docker-compose.yml file that’s been provided to you and put that in the local user directory (~/).
  • From the terminal, run the following commands to create the local folder for ItemPath:mkdir -p ~/ItemPath/files and mkdir -p ~/ItemPath/data
    After doing so, you’ll want to put the appdata.db file you received during preinstallation into the ~/ItemPath/data folder.

ItemPath Installation

From Outside the Internet
If you’re installing ItemPath from outside the Internet, you can load ItemPath’s Docker images using the Docker load syntax.

For example, docker load < itempath_api.tar

Make sure to load each image separately. There should be around 4 or images in total.

From Docker
First, you’ll need to log in to Docker to download the ItemPath images.

To do this run docker login

You’ll be prompted to enter a username and password, which has been provided in the email you received during preinstallation.

From the terminal, it’s time to download ItemPath. Navigate to the directory containing the docker-compose.yml file by typing cd ~. Then, download ItemPath using the command docker-compose pull.

ItemPath Startup

Finally, you’ll want to run ItemPath from the user directory (~/) by running from the terminal: docker-compose up -d. This should start ItemPath.

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