/TrueCommand-install

Installation scripts for running TrueCommand on various host OS's.

Primary LanguageShellBSD 2-Clause "Simplified" LicenseBSD-2-Clause

truecommand-install

TrueCommand is available as a docker container and can run on any OS where docker is supported.

This repo provides some simple installation scripts for running a TrueCommand container as a system service, making it easier to start/stop/update the container as needed.

Installation Instructions

  1. Install your OS of choice or setup a pre-built VM image in your virtualization platform of choice.
  2. Follow the "Setup Guide" link below for your OS. Most setups are just 1-line commands.

Supported OS's

This list is not exhaustive, please feel free to submit updates for other OS's as desired.

Note: Many pre-built Linux VM Images can be found here: linuxvmimages.com.

OS VM Images Architecture Instructions Notes
Debian Linux Download Site amd64 Setup Guide Uses systemd service file
Alpine Linux Download Site x86_64 Setup Guide Uses OpenRC service file
Void Linux Download Site x86_64 Setup Guide Uses runit service file
Windows Download Site x64 Setup Guide

Managing your TrueCommand Service

TrueCommand Service Notes

The install routines from this repo does the following:

  • Setup a system service for running the TrueCommand docker container
    • This service is enabled to auto-start on system boot
    • Use your standard system service tools to manage the container (start, stop, restart, status, etc)
  • The TrueCommand image has the following configuration by default:
    • Starts the UI on ports 80 (http) and 443 (https)
    • Stores the TrueCommand database at "/data" on the host
    • Will use the "latest" TrueCommand docker image (latest official release)

Changing the TrueCommand configuration

  1. Turn off the service
  2. Edit the "start-truecommand" file (as root).
    • This could be in the "/usr/local/bin" or "/usr/bin" directory, based on your host OS.
    • All of the configuration options are right at the top of the file for easy-modification.
    • Save the new file when you are done
  3. Turn on the service

Creating new OS setup scripts

For creating a setup script for some other OS, the setup comes down to 3 pieces:

  1. Ensure that docker is installed
  2. Install the "start-truecommand" file from this repository all/start-truecommand and a service file for your OS
  3. Enable the services