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 by providing a unified web interface for monitoring and controlling your TrueNAS system(s). Getting started requires only administrator access to your TrueNAS systems and an OAuth account for authentication.

The initial setup process guides you through service connection, system registration, and security configuration including keyring creation for secure API access. Once configured, Connect provides a centralized dashboard for managing your system(s), customizing monitoring views, and accessing essential system information in a conveniently unified 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 capabilities that provide real-time visibility into system status, performance metrics, and critical events across your TrueNAS system(s). The integrated monitoring features track key metrics including CPU usage, temperature, disk I/O, memory utilization, and storage capacity while highlighting critical alerts and offline disk conditions.

The health reporting system enables proactive infrastructure management through customizable notification tasks that can deliver alerts via email, SMS, Slack, or PagerDuty based on configurable thresholds and schedules. With historical data retention for paid accounts and immediate alert visibility for all users, Connect ensures you stay informed about system health issues before they impact your operations, eliminating the need to manually check individual TrueNAS 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 comprehensive orchestration capabilities that enable centralized monitoring and coordination of your TrueNAS system(s) from a single web interface. The management suite includes detailed hardware inventory tracking, proactive health monitoring with customizable alerts, and flexible reporting capabilities for asset management and compliance.

Through the centralized dashboard, you can monitor real-time system metrics, coordinate storage devices across multiple systems, manage automated notification tasks for critical events, and export detailed inventory reports in multiple formats. These orchestration tools provide centralized visibility and coordination for your fleet while detailed system configuration remains in the individual TrueNAS system interfaces.

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 allows you to install TrueNAS on your systems (targets) through the TrueNAS Connect web interface. After preparing your TrueNAS target for install, TrueNAS Connect handles the installation workflow remotely without requiring physical access.

The web installation process streamlines system setup by detecting an installer-ready system on your network and then guiding you through registration and initial configuration from your browser. While initial steps like creating installation media and booting the target system require local access, you can complete the actual installation and setup process entirely through the TrueNAS Connect interface.

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.