This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Essentials

The main content areas for TrueNAS Connect documentation.

1 - Getting Started

Learn how to get up and running with TrueNAS Connect in just a few simple steps.

Introduction

TrueNAS Connect simplifies system management with a unified web interface for monitoring and controlling your TrueNAS software. Getting started requires only administrator access to your systems and an OAuth account—no additional hardware or complex setup.

The setup process guides you through system registration and security configuration, then provides a centralized dashboard for day-to-day tasks with convenient access to system information from a single location.

Contents

Tutorial Hands-on introduction for new users or those looking to deepen their knowledge

Getting Started with TrueNAS Connect

TrueNAS Connect quickstart guide.

Tutorial Hands-on introduction for new users or those looking to deepen their knowledge

Managing the Keyring

Learn how to create, manage, and use the TrueNAS Connect keyring for secure API key storage and automatic system authentication.

How-To Step-by-step guides covering key operations and common tasks

Customize Your Account

How to view your profile information and customize your avatar in TrueNAS Connect.

Reference Description of UI screens and fields, including technical information like requirements and specifications

Dashboard Screen

Description of the TrueNAS Connect main Dashboard screen, system cards, tag and inventory quick views, dialogs, and fields.

Reference Description of UI screens and fields, including technical information like requirements and specifications

Top Toolbar

Description of the TrueNAS Connect top toolbar and main menu options..

Reference Description of UI screens and fields, including technical information like requirements and specifications

Profile Screen

Reference guide for the TrueNAS Connect Profile screen interface elements and functionality.

Reference Description of UI screens and fields, including technical information like requirements and specifications

Keyring Screen

Reference guide for the TrueNAS Connect Keyring screen interface elements and operations.

Reference Description of UI screens and fields, including technical information like requirements and specifications

End User License Agreement (EULA)

TrueNAS Connect Terms of Service (EU GDPR-Compliant)

2 - Health Reporting

Monitor your system(s) status, alerts, and performance with built-in health features.

Overview

TrueNAS Connect delivers comprehensive health reporting with real-time visibility into system status, performance metrics, and critical events. Track key metrics including CPU usage, temperature, disk I/O, memory utilization, and storage capacity while highlighting critical alerts and offline disk conditions—giving you peace of mind that your infrastructure is healthy.

Stay ahead of potential issues with customizable alerts that deliver notifications via email, SMS, Slack, or PagerDuty. With historical data retention for paid accounts, you can analyze trends over time, while all users benefit from immediate alert visibility without manually checking individual systems.

Contents

Tutorial Hands-on introduction for new users or those looking to deepen their knowledge

Health Reporting

Monitor your system(s) status, alerts, and performance with built-in health features.

How-To Step-by-step guides covering key operations and common tasks

Add Notification Tasks

How to configure notification tasks in TrueNAS Connect for proactive monitoring.

Reference Description of UI screens and fields, including technical information like requirements and specifications

Historical Data Screen

Description of the TrueNAS Connect Historical Data screen, graphs, dialogs, and fields.

Reference Description of UI screens and fields, including technical information like requirements and specifications

Notification Tasks Screen

Reference guide for the TrueNAS Connect Notification Tasks screen interface elements and functionality.

3 - TrueNAS Management

Configure, manage, and fine-tune your TrueNAS system(s) through the TrueNAS Connect web interface.

Introduction

TrueNAS Connect provides centralized monitoring and coordination for your TrueNAS software from a single web interface. While detailed configuration happens in individual system interfaces, TrueNAS Connect gives you convenient visibility into hardware inventory, system health, and key metrics across all your systems.

Monitor real-time system status, track storage devices across multiple systems, manage alert notifications for critical events, and export detailed inventory reports. These tools provide streamlined oversight for day-to-day operations so you can focus on keeping your systems running smoothly.

Contents

Tutorial Hands-on introduction for new users or those looking to deepen their knowledge

Managing TrueNAS Systems Inventory

View and manage hardware information, disk details, and system specifications across all connected TrueNAS systems

Tutorial Hands-on introduction for new users or those looking to deepen their knowledge

Managing the Keyring

Learn how to create, manage, and use the TrueNAS Connect keyring for secure API key storage and automatic system authentication.

Tutorial Hands-on introduction for new users or those looking to deepen their knowledge

Managing Virtualization

Learn how to view, monitor, and control virtual machines in TrueNAS Connect through the Applications screen interface.

How-To Step-by-step guides covering key operations and common tasks

Export Inventory Data

How to export TrueNAS systems inventory data from TrueNAS Connect for reporting, analysis, or record-keeping.

How-To Step-by-step guides covering key operations and common tasks

Use Enclosure Management

How to use the TrueNAS Connect Enclosures screen for personalized enclosure mapping, planning, and visualization.

Reference Description of UI screens and fields, including technical information like requirements and specifications

Dashboard Screen

Description of the TrueNAS Connect main Dashboard screen, system cards, tag and inventory quick views, dialogs, and fields.

Reference Description of UI screens and fields, including technical information like requirements and specifications

Tags Screen

Description of the TrueNAS Connect Tags screen, settings, and tag functions.

Reference Description of UI screens and fields, including technical information like requirements and specifications

Access Screen

Reference guide for the TrueNAS Connect Access screen, settings, and fields.

Reference Description of UI screens and fields, including technical information like requirements and specifications

Notification Tasks Screen

Reference guide for the TrueNAS Connect Notification Tasks screen interface elements and functionality.

Reference Description of UI screens and fields, including technical information like requirements and specifications

Historical Data Screen

Description of the TrueNAS Connect Historical Data screen, graphs, dialogs, and fields.

Reference Description of UI screens and fields, including technical information like requirements and specifications

Inventory Screen

Reference guide for the TrueNAS Connect Inventory screen interface elements and functionality.

Reference Description of UI screens and fields, including technical information like requirements and specifications

Keyring Screen

Reference guide for the TrueNAS Connect Keyring screen interface elements and operations.

Reference Description of UI screens and fields, including technical information like requirements and specifications

Enclosures Screen

Reference guide for the TrueNAS Connect Enclosures screen interface elements and functionality.

4 - Web Install

Install and set up TrueNAS remotely using streamlined, network-based functionality in TrueNAS Connect.

Introduction

TrueNAS Connect streamlines deployment by allowing you to install TrueNAS through the web interface without requiring physical access. After preparing installation media and booting the system, TrueNAS Connect handles the workflow remotely from your browser.

While initial steps like creating installation media and booting require local access, you can complete the installation and setup entirely through the TrueNAS Connect interface—detecting the system ready for installation and guiding you through registration and configuration.

Contents

Tutorial Hands-on introduction for new users or those looking to deepen their knowledge

TrueNAS Web Install

Learn how to install TrueNAS through the TrueNAS Connect web-based installation feature.