This is the multi-page printable view of this section. Click here to print.
Essentials
1 - Getting Started
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
Getting Started with TrueNAS Connect
TrueNAS Connect quickstart guide.
Managing the Keyring
Learn how to create, manage, and use the TrueNAS Connect keyring for secure API key storage and automatic system authentication.
Customize Your Account
How to view your profile information and customize your avatar in TrueNAS Connect.
Dashboard Screen
Description of the TrueNAS Connect main Dashboard screen, system cards, tag and inventory quick views, dialogs, and fields.
Top Toolbar
Description of the TrueNAS Connect top toolbar and main menu options..
Profile Screen
Reference guide for the TrueNAS Connect Profile screen interface elements and functionality.
Keyring Screen
Reference guide for the TrueNAS Connect Keyring screen interface elements and operations.
End User License Agreement (EULA)
TrueNAS Connect Terms of Service (EU GDPR-Compliant)
2 - Health Reporting
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
Health Reporting
Monitor your system(s) status, alerts, and performance with built-in health features.
Add Notification Tasks
How to configure notification tasks in TrueNAS Connect for proactive monitoring.
Historical Data Screen
Description of the TrueNAS Connect Historical Data screen, graphs, dialogs, and fields.
Notification Tasks Screen
Reference guide for the TrueNAS Connect Notification Tasks screen interface elements and functionality.
3 - TrueNAS Management
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
Managing TrueNAS Systems Inventory
View and manage hardware information, disk details, and system specifications across all connected TrueNAS systems
Managing the Keyring
Learn how to create, manage, and use the TrueNAS Connect keyring for secure API key storage and automatic system authentication.
Managing Virtualization
Learn how to view, monitor, and control virtual machines in TrueNAS Connect through the Applications screen interface.
Export Inventory Data
How to export TrueNAS systems inventory data from TrueNAS Connect for reporting, analysis, or record-keeping.
Use Enclosure Management
How to use the TrueNAS Connect Enclosures screen for personalized enclosure mapping, planning, and visualization.
Dashboard Screen
Description of the TrueNAS Connect main Dashboard screen, system cards, tag and inventory quick views, dialogs, and fields.
Tags Screen
Description of the TrueNAS Connect Tags screen, settings, and tag functions.
Access Screen
Reference guide for the TrueNAS Connect Access screen, settings, and fields.
Notification Tasks Screen
Reference guide for the TrueNAS Connect Notification Tasks screen interface elements and functionality.
Historical Data Screen
Description of the TrueNAS Connect Historical Data screen, graphs, dialogs, and fields.
Inventory Screen
Reference guide for the TrueNAS Connect Inventory screen interface elements and functionality.
Keyring Screen
Reference guide for the TrueNAS Connect Keyring screen interface elements and operations.
Enclosures Screen
Reference guide for the TrueNAS Connect Enclosures screen interface elements and functionality.
4 - Web Install
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
TrueNAS Web Install
Learn how to install TrueNAS through the TrueNAS Connect web-based installation feature.