Installing PlexTrac
Prerequisites
Machine/instance with a minimum quad-core processor, 16 GB of memory, 120 GB of storage, and connection to the internet
CLI access to the PlexTrac server
If using the built-in Let’s Encrypt SSL solution, ensure ports 443 and 80 are open in/outbound to allow a new certificate to be obtained when the docker containers are started
If using a custom domain, the DNS A record must be created
Supported Host Operating Systems
Ubuntu 20.04 or Ubuntu 22.04
Debian Linux (Version 12, Bookworm)
CentOS 8
Red Hat Linux 9
Rocky Linux 9
Delay any hardening procedures until after installation.
Installing PlexTrac
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:
The command will also initialize the script and perform system updates. Once complete, the shell should be returned.
Step 3: Switch the user to "plextrac".
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.
Step 5: Edit the .env file.
Step 6: Find the following variables in the .env and make the changes listed in the table.
Variable | Action | Example | Notes |
---|---|---|---|
DOCKER_HUB_KEY= | Add the docker token provided by PlexTrac Support. | DOCKER_HUB_KEY=key123 | |
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 an email address to be notified when the certificate is about to expire. | LETS_ENCRYPT_EMAIL=you@domain.com | |
USE_CUSTOM_CERT= | If using a custom SSL certificate, set to true and follow step 7. | USE_CUSTOM_CERT=true/false | |
ADMIN_EMAIL= | Add a valid email address to create the initial user in the platform. | ADMIN_EMAIL=you@domain.com | Optional: This will link the database to this email address and cannot be changed later. Leaving it blank will initialize the database with the admin email of |
Step 7: If using a custom logo, favicon, or SSL certificate, follow the instructions here and here and run plextrac configure
before continuing to the next step.
Step 8: Ensure that the most recent upstream version of Couchbase's database is used.
Edit the
docker-compose.override.yml
located in the installation directory of PlexTrac.Uncomment the
services:
line.Save the file.
Step 9: Run plextrac install
.
Once complete, a summary page should be printed (example below).
Step 10: Set the initial password for the global_admin account by querying the logs and extracting the URL:
An example query result:
Access the URL in the query result to set the initial password for the global_admin account.
Step 11: Log in using the password set in the previous step:
Username: global_admin
Password: [your_password]
Last updated