• Configuration
  • Cloud
    • Requirements
  • On-Premise
    • System Requirements
    • Installation
• Using ItemPath
  • The Dashboard
    • Creating a Dashboard
  • Reports
    • Creating New Reports
    • Editing Reports
    • Deleting Reports
    • Filtering Reports
    • Sorting Reports
    • Exporting Reports
  • Report Conclusions
    • Creating Conclusions
  • Workflows
    • Creating a New Workflow
    • Setting Triggers
    • Viewing Workflows
    • Testing Workflows
  • API
    • Authentication
    • API Reference
    • Viewing Logs
    • ItemPath API for PPG -- Explained

Installation

Configuration Files

Once the Requirements 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.

• config.ini - this will store your database connection information, license, and any other customized info
• 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
• access.txt - this will temporarily give you the username and password needed to download ItemPath core files.

Installation Steps

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. 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 user directory (the user should be the same one provided during preinstallation).
4. 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”. You’ll be prompted to enter a username and password, which has been provided in the access.txt file you received during preinstallation.
5. From the terminal, run the following commands to create the local folder for ItemPath: mkdir -p ~/ItemPath/files and mkdir -p ~/ItemPath/data”
6. After doing so, you’ll want to put both the config.ini and appdata.db files you received during preinstallation into the ~/ItemPath/data folder.