Getting Started with TrueNAS Connect

Setting Up TrueNAS Connect

Begin by logging into the TrueNAS server as an administrator. After logging into your TrueNAS system as a full administrator, click on the TrueNAS Connect icon to open the TrueNAS Connect dialog.

Before you sign up for TrueNAS Connect, the dialog shows it is waiting to connect.

Click Get Connected to open the TrueNAS Connect login screen.

Choose the OAuth provider you want to use to log into TrueNAS Connect. The OAuth account used is registered as the authentication account for TrueNAS Connect.

You can use an existing OAuth account or create a new account. The option to use an email account is planned for a future update.

Follow the sign-in process for your chosen OAuth provider until you reach the Account Confirmation window. Click the link on the Account Confirmation window to view the Terms of Service.

Read the Terms of Service, then select the option to indicate that you read and agree to the Terms of Service.

Select the option to receive updates on TrueNAS Connect news, events, and offers to receive notifications from TrueNAS Connect.

Click Sign Up to open the TrueNAS Connect Dashboard.

TrueNAS Connect prompts you to complete the system registration and add the system to TrueNAS Connect. After adding the system, a system information card shows on the main Dashboard screen.

Repeat this process for each TrueNAS system you want to add to TrueNAS Connect.

After adding your system, you can customize the interface.

Registering a System

After logging into TrueNAS Connect, you are prompted to complete the system registration using the Add System dialog.

Enter a name for your system, such as the host name or a name that helps identify the purpose of the system. For example, backup1, TNserver1, etc. Click Confirm to add the system.

To register another system, begin in the TrueNAS system UI. Log into the TrueNAS system UI as an administrator with full admin privileges. Follow the instructions provided in Setting Up TrueNAS Connect to log into TrueNAS Connect using the same OAuth account used to set up TrueNAS Connect.

Repeat this for each system you want to add to TrueNAS Connect.

Adding a Keyring

Keyrings are useful for quickly authenticating your TrueNAS servers with an API key.

To add a keyring, click Create Keyring. The Create Keyring Passphrase window opens.

Enter a name for the system in Name, then enter a complex passphrase in both Passphrase and Confirm. Click Ok to add the keyring.

You can apply one keyring to all your systems. Select the Add to Keyring option on the system card where you enter the credentials to log into each system.

Unlocking a System

After logging out of TrueNAS Connect, the Unlock Keyring dialog shows when you sign in again. Enter your passphrase for the keyring to authenticate system access. If you include other systems in the keyring, each included system is authenticated with the keyring. Authenticated systems show the system cards populated with information received from the TrueNAS on the Dashboard.

Customizing the Dashboard

You can customize the main Dashboard to show the Tags and/or Inventory widgets. Click Configure at the top right of the main dashboard screen to show the Dashboard Configuration dialog.

Select Toggle Tags to show or hide the Tags widget. Tags lists system tags created in TrueNAS Connect, and an option to add tags for other systems. If you hide the Tags widget, you can add tags from the Tags option on the main menu dropdown.

Select Toggle Inventory to show or hide the Inventory widget that lists systems by name on the right side of the dashboard. Each system listed in the Inventory widget shows a Visibility visibility icon that toggles showing or hiding the system information card on the main dashboard.