(408) 943-4100               V   Commercial Support

Install

  10 minute read.

Last Modified 2021-03-26 11:48 EDT

TrueCommand is incredibly versatile and offers several different install options. TrueCommand Cloud is the preferred method for using TrueCommand, as this option requires no local resources or specific hardware requirements to get started!

Install Options

Click one of the tabs below to see instructions for your preferred deployment method.

TrueCommand Cloud is a SaaS offering of TrueCommand with a WireGuard VPN capability to connect TrueNAS systems through firewalls. TrueCommand Cloud is compatible with TrueNAS version v12.0 and newer.

Register an iXsystems Account

Open https://portal.ixsystems.com and click Register.

PortalLogin

Fill out the form using the email address you want to use.

PortalAccountCreate

This email account must be verified. Check the address spam folder if the email does not arrive within a few minutes. When the email is in the spam folder, mark it as not spam and add the account to the address book so future emails arrive at the inbox. After receiving the verification email, open the link provided to verify the account.

Create a New Subscription

Log in to the verified account and click New Subscription.

PortalDashboard

PortalCloudSubscription

Select the TrueCommand Cloud option and choose the subscription plan that best fits your current needs. This can be changed later.

PortalCloudSubscriptionOptions

Click Continue to proceed.

PortalCloudSubscriptionSelected

Next, fill the payment form.

CloudSubscriptionPayment

Submit and wait for the form to be accepted. When ready, click Provision Now.

PortalDashboardActiveSubscription

Select a Subnet that is not currently used on the network.

TrueCommandProvisionSubnet

Managing a TrueCommand Cloud Account

From the account home page, click Manage. Add a client for desktop or laptop to obtain a TrueCommand WireGuard Config file.

CloudSubscriptionServiceDetails

When the client account is created, click to download the configuration file.

CloudSubscriptionServiceDetailsWireGuardClient

Open Wireguard on your machine and click Add Tunnel.

WireGuardTunnels

Select the TrueCommand WireGuard Configuration file that was downloaded from the portal. the configuration file into WireGuard on your machine and activate the tunnel.

WireGuardTCCloudInactive

Click Activate to initialize the Wireguard tunnel.

WireGuardTCCloudActivate

Further information on WireGuard and WireGuard clients is found on the WireGuard home page. The TrueCommand Cloud IP address displays in the iXsystems Account Portal page.

After WireGuard is active, log in to the TrueCommand Cloud Interface by clicking the TrueCommand IP address listed on the portal, or manually entering the TrueCommand Cloud IP in a browser.

Connecting Systems to a TrueCommand Cloud Instance

Log into the ixSystems cloud account and click Manage. Under Service Details, copy the TrueCommand API Key.

CloudSubscriptionServiceDetailsWireGuardClient

Log into a TrueNAS system and click the TrueCommand icon in the upper right.

Paste the TrueCommand API Key copied from the iXsystems Account Portal into the TrueNAS dialog window.

TrueCommandCloudConnectAPIKey

When the True Command logo starts moving, check the TrueCommand Cloud email address for a verification message. The email contains a link to the Portal to confirm the connection and activate the TrueNAS system.

Click on the New System alert, fill in the information from the TrueNAS system, and click Add System.

NewSystemCreds

It can take 10 to 15 minutes for the TrueNAS instance to fully sync up with TrueCommand Cloud. When all systems are connected to TrueCommand Cloud, refer to the TrueCommand Administration articles for more instructions about setting up configuration backups, alerts, reports, and role-based access control.

Installing the TrueCommand Container

Docker Desktop for Windows uses Hyper-V. This interferes with other virtualization applications. For example, Docker Desktop and VMware Workstation Player cannot simultaneously run.

Before fetching the TrueCommand docker image, create a local directory. Enter mkdir {DIRECTORY}, where {DIRECTORY} is the new name.

After creating the new directory, fetch and run the TrueCommand Docker image. Open a Command Line Interface (CLI) and enter docker run \--detach -v "/{HOSTDIR}:/data" -p {PORT}:80 -p {SSL}:443 ixsystems/truecommand:latest. {HOSTDIR} is a directory on the host machine for Docker container data, {PORT} is the TrueCommand web interface port number, and {SSL} port number for secure web interface access.

To install the container with an earlier TrueCommand release, replace latest with the desired TrueCommand version tag:

docker run \--detach -v "/DockerDir:/data" -p 9004:80 -p 9005:443 ixsystems/truecommand:1.3.2
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 Windows Documents folder, the docker command would be: docker run \--detach -v C:\Users\\Example\\Documents\\DockerDir. In this command C is the drive letter, Example is the current user name, and DockerDir is the TrueCommand image directory.

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

Do not try to use the same hostdirectory for two different containers! This results in file conflicts and database corruption.

Accessing the TrueCommand Web Interface

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

DockerContainerList

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.

When a connection to the web interface cannot be established, add the container ports as an exception to the host system firewall.

The requirements to run TrueCommand in Docker Desktop for Windows are:

  • Windows 10 Enterprise, Pro, or Education editions.
  • 64-bit Processor with Second Level Address Translation (SLAT).
  • CPU support for VM Monitor Mode Extension (VT-c on Intel CPUs).
  • Hyper-V is enabled in Windows 10.
  • 4 GB memory at minimum.
  • Docker Desktop needs to be installed in Windows.

Enable Hyper-V

To enable Hyper-V, click on Windows Start button and select or search for Apps & Features. Select Programs and Features under Related settings and Turn Windows Features on or off (Administrator action). Set the Hyper-V option and click Ok. You will need to restart your restart your computer for the change to take effect.

EnableHyperV

Alternatively, Hyper-V can be enabled with the Powershell. To do this, run Powershell as a Windows Administrator and enter Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Hyper-V -All. If an error is returned that says the command could not be found, verify that you are running PowerShell as the Administrator. After the command successfully runs, reboot the computer.

PowershellHyperVCLI

Install Docker Desktop

Open Docker Hub and click Get Docker.

DownloadDockerDesktop

Run the installer after the download completes. When the installer is finished, reboot the system.

If the admin account is different from your Windows user account, the user must be added to the docker-users group. Run Computer Management as an administrator and go to Local Users and Groups > Groups > docker-users to add the user to the group. Changes take effect after logging out and back in.

If this error message appears after rebooting, install the Linux Kernel Update Package:

DockerDesktopError

The update package is downloaded from a Windows storage location.

DockerDesktopInstallWSL

Microsoft has additional documentation available for assistance with downloading the Linux kernel update.

After installing the kernel update, set the WSL default version to version 2 by opening the Powershell and entering wsl --set-default-version 2.

DockerDesktopSetWSLDefault

The system must be rebooted after changing the default version.

Installing the TrueCommand Docker Container

Open the Docker Hub in a browser and search for ixsystems/truecommand.

DockerHubSearchResults

DockerHubTrueCommand

Verify the pull command required and run it from a command line. Example: docker pull ixsystems/truecommand:latest.

DockerHubCLIInstallTrueCommand

When the container is downloaded, open the Docker Desktop and select Images. Hover over the ixsystems/truecommand entry to show the Run button, then click it.

DockerDesktopImages

Open the Optional Settings drop down menu, name the container, and set the following port values. Investigate your network environment or check with your IT department to ensure that these ports will not conflict with any other running services.

  • Local Host Port: 9005
  • Container Port 443

Click the + sign to add a second set of ports.

  • Local Host Port 9004
  • Container Port 80/tcp

DockerDesktopTrueCommandConfig

Setting the Volume is not usually required for TrueCommand. Click RUN after configuring the settings.

When Docker Desktop shows the container status as RUNNING, open a new browser tab and go to https://127.0.0.1:9005.

DockerDesktopTrueCommandRunning

TrueCommand has both VMDK and VHDX files for virtual machine installs available from https://pkg.truecommand.io/. Most virtual machine applications, including VMware and VirtualBox, support TrueCommand VMDK files. Hyper-V users should use a TrueCommand VHDX file.

These are the minimum specifications for a TrueCommand virtual machine:

  • RAM: at least 2GB
  • Storage: at least 20GB
  • CPU: at least 2 cores
  • Network: Use NAT, Bridged, or Host-only depending on your host networking configuration.

After downloading the appropriate TrueCommand file, extract the TrueCommand VMDK or VHDX file to a location on your system that is accessible by your virtual machine application. Launch your virtual machine application. In this example, VMware Workstation Player on Windows is being used.

When VMware Player is open, click Create a New Virtual Machine.

VMwareInstallerStart

Select I will install the operating system later and click Next. Select Linux as the guest operating system and Debian 10.x 64-bit as the version. Click Next.

The virtual machine can be given a name and the location can be selected. To keep the default values, click Next. Enter the maximum size of the disk to be used for storage and set Store virtual disk as a single file. The recommended disk size is at least 20GB. Click Next. Review the settings for the virtual machine and click Finish.

VmwareInstallerVMCreate

Now that the virtual machine is created, we need to add our TrueCommand virtual image to the machine. Select the virtual machine from the list and click Edit virtual machine settings.

VMwareInstallerVMCreateSummary

Next, click Add…. The TrueCommand file downloaded earlier is a virtual hard disk. Select Hard Disk from the list of options and click Next. Select SCSI and click Next. Ensure that Use an existing virtual disk is set and click Next.

It then prompts to select an existing virtual disk from the host system. Click Browse… and select the TrueCommand virtual disk (.vmdk file) that was downloaded earlier. Click Finish. If VMware player prompts to convert the virtual disk to a new format, click Keep Existing Format.

The final step is to remove the initial hard disk that was created when the virtual machine was created. Select the virtual machine from the list and click Edit virtual machine settings. Select the first hard disk and click Remove.

The TrueCommand virtual machine is now ready to be used. To boot the TrueCommand virtual machine, select it from the list of virtual machines and click Play virtual machine.

Adding Browser Security Exceptions

TrueCommand uses a self signed certificate for a secure connection. Because of this, many Internet browsers 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.

Click Advanced to view information about the error code. Click Proceed to {hostname} (unsafe).

ChromeWarning

Click Advanced to view information about the error code.

FirefoxWarning

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

FirefoxExceptionAdd

Creating the Administrator Account

When accessing the interface for the first time, or when there aren’t any users in the TrueCommand database, default credentials are available. However, an administrator account is required for subsequent logins.

Follow these steps to create a new admin user:

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

LoginAdmin

  • 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.

FirstLogin

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