TrueNAS Documentation Hub

TrueNAS Documentation

TrueCommand Documentation

TrueNAS Hardware Documentation

TrueNAS® is an operating system that is designed to be the most effective and time-efficient solution for storing, securing, and sharing data over a network. It is the simplest way to create a safe, centralized, and easily accessible place for your data.

The topics on this page are arranged to guide you through learning about TrueNAS, installing and configuring the system, then setting up data storage and sharing. There are additional topics for the TrueCommand and TrueNAS SCALE members of the TrueNAS family, 3rd party software integration notes, and reference documentation for the powerful and cost-effective TrueNAS storage appliances available for purchase from iXsystems.

Introducing TrueNAS

Start by learning all about TrueNAS! Read about the features and wider software family, keep up with the latest release notes and software roadmap, and find hardware recommendations for installing the free TrueNAS CORE.

What is TrueNAS?
Release Notes
Release Schedule
CORE Hardware Guide

Overview

Initial Setup

After discovering if your hardware is right for TrueNAS, move to downloading and installing the software. After installing, you'll want to log in to the web interface and start configuring the system, including the system networking. Next, move to reviewing your system security by creating user and group accounts, setting up your directory services, and reviewing best practices. After networking and security configuration is complete, the system is ready for setting up data storage and alert notifications.

Installation and Update Procedures
First-time Configuration
Configuring Networking
Credentials and Security
Setting up Storage

Initial Setup

Data Sharing

With the initial system configuration done, set up file sharing with the different protocols built into TrueNAS to pull data into the system or share files on your network.

Server Message Block (SMB)
Network File System (NFS)
Block Sharing (iSCSI)
Apple Filing Protocol (AFP)
WebDAV
FTP / SFTP
S3 Object

Sharing

Advanced Management

For more complicated use cases, TrueNAS supports many different administrative tasks such as monitoring system statistics, additional scripting, and backing up the system configuration. Automatic data back up, sync, or other system maintenance tasks can also be scheduled. There are also many different advanced features that unlock the full potential of TrueNAS, such as modifying Access Control Lists, using plugins and Virtual Machines (VMs), and reconfiguring High-Availability in TrueNAS Enterprise.

System Administration
Automated Tasks
Advanced Procedures

Advanced Management

Solution Integrations

Articles discussing how to integrate TrueNAS with various external applications.

Kubernetes®
OpenStack®
Veeam®
VMware®

Solution Integrations

TrueNAS SCALE

TrueNAS SCALE is a Debian-based version of TrueNAS with container support. It is currently in pre-ALPHA status and under active development. SCALE documentation is mostly shared with TrueNAS CORE and Enterprise, but articles discussing SCALE specific features are organized in this topic.

Developer's Notes
SCALE Release Notes

TrueNAS SCALE

Additional Topics

Want to become a TrueNAS expert? These additional topics help fill in a staggering amount of detail about TrueNAS. They include reference materials that detail each field in the TrueNAS user interface, deep dives into TrueNAS, and miscellaneous errata. Topics include articles that apply to earlier specific versions of TrueNAS (and FreeNAS), along with previous version release notes. The Application Programming Interface is also detailed here, along with simple instructions for creating an API key.

Reference Articles
Usage Optimizations
Legacy Documentation
API Documentation

Additional Topics
Last modified November 11, 2020: Update _index.md (37591962)