UI Reference Guide

Welcome to this Web Interface (UI) Reference Guide! This document shows and describes each screen and configurable option contained within the TrueNAS web interface. The document is arranged in a parallel manner to the UI, beginning with the top panel and then descending through each option in the left side menu. To display this document in a linear HTML format, export it to PDF, or physically print it, please select ⎙ Download or Print.

TrueNAS SCALE documentation is divided into several sections or books:

• The Getting Started Guide provides the first steps for your experience with TrueNAS SCALE:

  • Software Licensing information.
  • Recommendations and considerations when selecting hardware.
  • Installation tutorials.
  • First-time software configuration instructions.

• Configuration Tutorials have many community and iXsystems -provided procedural how-tos for specific software use-cases.

• The UI Reference Guide describes each section of the SCALE web interface, including descriptions for each configuration option.

• API Reference describes how to access the API documentation on a live system and includes a static copy of the API documentation.

• SCALE Security Reports links to the TrueNAS Security Hub and also contains any additional security-related notices.