Installing PlexTrac
This page explains the steps for installing PlexTrac.
For Debian based operating systems (e.g. Ubuntu): If using a Red Hat based OS, such as RHEL or Centos, please contact PlexTrac Support for instructions to proceed.

Prerequisites

  • Machine/instance with 16 GB of memory and connection to the internet
  • Minimum 256 GB of storage
  • If using Let’s Encrypt: Ensure ports 443 and 80 are open in/outbound to allow a new certificate to be obtained when the docker containers are started
  • Please delay any hardening procedures until after the installation of PlexTrac
  • If using a custom domain, the DNS A record must be created
  • CMD access to PlexTrac server

Installing Steps

Step 1: Log in to the server that will host PlexTrac.
Step 2: As a root user (or user with root privileges), run the following commands to download the PlexTrac utility from our public Github repository:
1
curl -Ls -o /tmp/plextrac https://github.com/PlexTrac/plextrac-manager-util/releases/latest/download/plextrac && sudo chmod a+x /tmp/plextrac && sudo bash /tmp/plextrac initialize -v
Copied!
The command will also initialize the script, which will then begin to perform system updates. Once complete, the shell should be returned.
Step 3: Switch user to "plextrac".
1
sudo su - plextrac
Copied!
Step 4: Run plextrac configure. A message “Error: Docker Hub key not found…” will appear at the end of the log, but this can be safely ignored the key will be added in the following steps.
1
plextrac configure
Copied!
Step 5: Edit the .env file.
1
nano .env
Copied!
Step 6: Find the following variables in the .env and make the changes listed in the table.
Variable
Action
Example
ADMIN_EMAIL=
Add a valid email address to create the initial user in the platform.
DOCKER_HUB_KEY=
Add the docker token provided by PlexTrac Support.
DOCKER_HUB_KEY=key123
DOCKER_HUB_USER=
Add "ptcustomers" to the right side of the equals sign.
DOCKER_HUB_USER=ptcustomers
CLIENT_DOMAIN_NAME=
If using a self-signed certificate, enter the IP address of the server. Otherwise, if a DNS A record was created, enter the DNS name here.
CLIENT_DOMAIN_NAME=plextrac.example.com
LETS_ENCRYPT_EMAIL=
If using Let's Encrypt, enter email to be are notified when the certificate is about to expire.
USE_CUSTOM_CERT=
If using a custom SSL certificate, set to true and follow step 7.
USE_CUSTOM_CERT=true/false
Step 7: If using a custom logo, favicon or SSL certificate, follow the instructions found here and here before continuing with Step 8.
Step 8: Run plextrac install.
1
plextrac install -y -v
Copied!
Once complete, a summary page should be printed (example below).
Step 9: Login to the platform by navigating to the DNS or IP address that was set previously. The username will be the email specified during Step 6, and the password was provided with the docker token.
Change password immediately upon login.
Click Next below to learn about adding logos and favicons.