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)