Get a Quote   (408) 943-4100               TrueNAS Discord      VendOp_Icon_15x15px   Commercial Support Toggle between Light and Dark mode

Installing or Updating

  6 minute read.

Last Modified 2022-06-24 15:50 EDT

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

Install Options

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

Check the address spam folder if the email does not arrive within a few minutes. If the email is in the spam folder, mark it as not spam and add the account to the address book. 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.

PortalCloudSubscriptionOptions

Click Continue to proceed.

PortalCloudSubscriptionSelected

Next, fill out the payment form.

CloudSubscriptionPayment

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

PortalDashboardActiveSubscription

Select a Subnet that your network is not using.

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

After adding the client, click to download the configuration file.

CloudSubscriptionServiceDetailsWireGuardClient

Open Wireguard on your machine and click Add Tunnel.

WireGuardTunnels

Select the TrueCommand WireGuard Configuration file you downloaded.

WireGuardTCCloudInactive

Click Activate to initialize the Wireguard tunnel.

WireGuardTCCloudActivate

See the WireGuard home page for more information on WireGuard and WireGuard clients.

The TrueCommand Cloud IP address is on the iXsystems account portal.

When WireGuard is active, log in to the TrueCommand Cloud interface by clicking the TrueCommand IP address on the portal, or manually enter 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 the Discovered Systems icon and select the TrueNAS system. TrueCommand automatically fills out the IP field using the WiredGuard address. Fill in the TrueNAS system nickname and password information from the TrueNAS system, and click Add System.

NewSystemCreds

The TrueNAS instance can take 10 to 15 minutes 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

If you haven’t already installed Docker on your machine, install the Docker Engine, then install Docker Desktop.

To run TrueCommand in Docker on Linux, you must have:

  • A 64-bit Linux distro (we recommend Debian)
  • Linux Kernel Support: 4.x+
  • 1 CPU with 2 GiB RAM
  • 1 Hard Disk with 10 - 50 GiB storage space
  • Customer networking settings and internet access

Before fetching the TrueCommand docker image, create a local directory. Enter mkdir directory, replacing directory with the new name.

After creating the new directory, fetch and run the TrueCommand Docker image.

Open a terminal 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 is the 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

To install the container with the nightly TrueCommand release, replace latest with nightly:
docker run \--detach -v "/DockerDir:/data" -p 9004:80 -p 9005:443 ixsystems/truecommand:nightly

Only use the nightly version on test systems.

Although Docker containers have several run methods, TrueCommand requires-v /hostdirectory:/data to function.

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

For a list of TrueCommand versions and tags, see the Truecommand Docker page.

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.

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. 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 permanently store the IP address or DNS hostname in Firefox. Click Confirm Security Exception.

FirefoxExceptionAdd

Creating the Administrator Account

Accessing the interface for the first time prompts to create an administrator account.

Follow these steps to create a new admin user:

  • 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 TrueCommand login screen reappears and you can now use these administrator credentials to log in to the TrueCommand web interface and begin connecting TrueNAS systems, creating more login accounts, and configuring statistical reports.