Installing PlexTrac
- Machine/instance with a minimum quad-core processor, 16 GB of memory, 250 GB of storage, and connection to the internet
- Ubuntu 20.04 or Ubuntu 22.04 host operating system (others are not supported)
- CMD access to the PlexTrac server
- 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
- If using a custom domain, the DNS A record must be created
Delay any hardening procedures until after installation.
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:
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
The command will also initialize the script, which will then perform system updates. Once complete, the shell should be returned.
Step 3: Switch the user to "plextrac".
sudo su - 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.plextrac configure
Step 5: Edit the .env file.
nano .env
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 |
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. | |
USE_CUSTOM_CERT= | If using a custom SSL certificate, set to true and follow step 7. | USE_CUSTOM_CERT=true/false |
Step 8: Run
plextrac install. plextrac install -y -v
Once complete, a summary page should be printed (example below).
Step 9: Log in to the platform by navigating to the DNS or IP address set previously. The username will be the email specified during Step 6, and the password was provided with the docker token.
Change the password immediately upon login.
Last modified 1mo ago