Get a Quote     (408) 943-4100               TrueNAS Discord      VendOp_Icon_15x15px   Commercial Support Toggle between Light and Dark mode
Edit this page

Documentation Hub

  4 minute read.

Last Modified 2022-12-13 13:12 EST

TrueNAS: Open Storage

There are some updates to the Docs Hub!

TrueNAS is the world’s most popular Open Source storage operating system and is the most efficient solution for managing and sharing data over a network. It is the simplest way to create a safe, secure, centralized, and easily accessible place for your data. TrueNAS Open Storage provides unified ZFS-based storage for file, block, object, and application data.

Whether you’re looking to protect and share your company data or your family photos, TrueNAS CORE provides a secure, centralized, and easily accessible place for your data. When combined with our high-availability hardware and TrueCommand single interface management solution, TrueNAS Enterprise ensures that your data is always safe, secure, and available. TrueNAS SCALE evolves NAS functionality even further with container support, dual active system configurations, and hyper-converged architecture.

First Steps

DooderRocket

Ready to get started? Click your platform below to begin setting up your system.

Using the Documentation Hub

DooderLaptop

The Documentation Hub has all of the information you need to set up and manage your TrueNAS system. Documentation articles follow the latest supported software releases, with previous version documentation available in the Docs Archive:

SoftwareCurrent Documented VersionPrevious Major Version
TrueNAS CORE & Enterprise13.012.0 (Release Notes)
TrueNAS SCALE22.12 Bluefin22.02 Angelfish
TrueCommand2.22.1

The navigation pane to the left is sorted into several topics that you can expand to find the specific knowledge you’re looking for:

  • TrueNAS CORE and Enterprise contains content specific to the FreeBSD-based CORE software. This includes a Getting Started Guide, Configuration Tutorials, and reference documentation for the UI and API.
  • TrueNAS SCALE contains content specific to the Linux-based SCALE software. This includes a Getting Started Guide, Configuration Tutorials, and reference documentation for the UI and API.
  • TrueNAS Upgrades documents current upgrade information for both CORE and SCALE, including the active update trains and developer images for upcoming versions.
  • Solutions provides version-agnostic background information and tutorials about general system use cases or integrations with other vendor solutions.
  • TrueCommand contains content specific to the latest support release of TrueCommand. This includes installation instructions, reference information about each section of the TrueCommand web interface, and tutorials for specific use-cases.
  • TrueNAS Systems has content specific to the various hardware platforms that iXsystems builds and sells specifically for use with TrueNAS.
  • Contributing provides guidance for those seeking to contribute to the open-source projects.
  • References provides general background knowledge about concepts and terms and some of the underlying technologies that are used in TrueNAS.

The More menu in the lower-left side of the screen has links to security notices, archived documentation, and the GitHub source repository for this website. An RSS feed is also available here.

You can also use the search bar above the navigation pane if you know specific keywords for what you’re looking for.

Contributors welcome! Anyone can contribute new content or feedback about the Documentation Hub and TrueNAS by Reporting Issues or suggesting updates and new articles.

Can’t find what you’re looking for? Just want to be part of the TrueNAS community? Join our Community Forums or the TrueNAS subreddit.

What’s New on the Documentation Hub?

The Documentation Hub has had some changes for the SCALE Bluefin release!

The Docs Hub has replaced the existing search algorithm with a lunr.js implementation that conducts keyword searches through the entire content. Search results display in a separate page. The full path to each result is visible, along with a description of the content.

Table of Contents for Sections with Nested Articles

New functionality allows generating a list of links and showing the article description for articles that are nested within a documentation section. Articles that have nested content now have a Table of Contents expandable or generic subsection that shows links to each article that is within that topic. Short descriptions of each nested article can also be displayed.

New functionality allows showing a list of links to other articles that have some kind of subject matter relationship. This is typically used to link Reference content to Tutorials and is generally designed to help readers find related content faster.