Installing and Accessing the TrueCommand Interface

How to install TrueCommand and access the web interface for the first time.

  4 minute read

Installing the TrueCommand Container

TrueCommand is built as a Docker container. This has the benefit of a smaller footprint and simpler upgrades. Use the appropriate Operating System Docker installation instructions and install Docker. Make sure that the Docker service is started.

Before fetching the TrueCommand docker image, create a local directory for the image to mount to for storage. This can be done by running mkdir nameOfDirectory where nameOfDirectory is the name of choice for the new directory.

After creating the new directory, fetch and run the TrueCommand Docker image. This is done in the Command Line Interface (CLI) by typing docker run --detach -v “/hostdirectory:/data” -p portnumber:80 -p sslport:443 ixsystems/truecommand:latest where hostdirectory is a directory on the host machine that is used as the data directory for the Docker container, portnumber is the desired port number to access the web interface, and sslportnumber is the desired port number to securely access the web interface through SSL. Do not forget to use Windows compatible syntax when specifying paths in the Windows file system. For example, if the created directory for the TrueCommand image was created in the Documents folder in the Windows file system, the docker command would look like: docker run --detach -v driveLetter:\Users\username\Documents\directoryName. In this command driveLetter is the letter associated with the drive that contains the new directory, username is the username of the current user, and directoryName is the name of the directory created for the TrueCommand image.

Although there are different ways to run a Docker container, using -v /hostdirectory:/data is required for TrueCommand to function.

To install a container with a previous release of TrueCommand, replace latest with the desired TrueCommand version tag.

Accessing the TrueCommand Web Interface

After fetching the TrueCommand Docker container, run docker ps to see details about running containers.



Use the port assigned to the container to access the web interface. The list from docker ps contains a PORTS column. Find the port associated with the ixsystems/truecommand:latest IMAGE. The PORTS entry is listed as 0.0.0.0:port->80/tcp, 0.0.0.0:sslport->443/tcp where port and sslport are the ports specified earlier.

To access the web interface with no encryption, enter hostsystemIPaddress:port in a browser address bar, where hostsystemIPaddress is the IP address of the host system that is running the TrueCommand Docker container. To access the web interface with standard SSL encryption, enter https://hostsystemIPaddress:sslport in a browser address bar. If a connection to the web interface cannot be established, add the container ports as an exception to the host system firewall.

Adding Browser Security Exceptions

TrueCommand uses a self signed certificate for a secure connection. Because of this, many Internet browsers can consider the IP address or DNS hostname untrustworthy. In these cases, the IP address or DNS hostname must be added as an exception to the browser to access the web interface. The process of adding an exception is shown here for two different browsers, but the procedure is similar for most browsers.

Firefox

Click Advanced to view information about the error code.



Click Add Exception…. Set Permanently store this exception to keep the IP address or DNS hostname permanently stored in Firefox. Click Confirm Security Exception.



Chrome

Click Advanced to view information about the error code.

Click Proceed to hostname (unsafe).



Creating the Administrator Account

When accessing the interface for the first time, or when there aren’t any users in the TrueCommand database, you can log in with default credentials but will need to create an administrator account for subsequent logins.

Follow these steps to create a new admin user:

  • Log in using the default username (admin) and password (admin).


  • Enter a username and password. Read the Terms of Service, set I have read and agree to the terms of service, and click SIGN UP.


  • The default login credentials are disabled and you can now log in to the TrueCommand web interface with the new administrator account credentials.

Last modified August 31, 2020: Update install.md (147c7837)