TrueNAS SCALE Nightly Development Documentation
This content follows experimental early release software. Use the Product and Version selectors above to view content specific to a stable software release.

SCALE Tutorials

6 minute read.

Last Modified 2024-03-15 13:07 EDT

This guide collects various how-tos for both simple and complex tasks using primarily the TrueNAS web interface. Tutorials are organized parallel to the TrueNAS web interface structure and grouped by topic. Tutorials are living articles and continually updated with new content or additional in-depth tutorials that guide in unlocking the full potential of TrueNAS.

To display all tutorials in a linear HTML format, export it to PDF, or physically print it, please select ⎙ Download or Print.

TrueNAS SCALE Tutorials

⎙ Download or Print: View all TrueNAS SCALE Tutorials as a single page for download or print.

Top Toolbar: Tutorials about options available from the TrueNAS SCALE top toolbar.

Managing API Keys: This tutorial shows how to add, create, or edit an API key in TrueNAS SCALE.
Shutting Down SCALE Enterprise HA: Describes the procedure for shutting down an Enterprise HA system in TrueNAS SCALE.

Dashboard: Tutorials related to using the TrueNAS SCALE Dashboard.

Synchronizing System and SCALE Time: Provides instructions on synchronizing the system server and TrueNAS SCALE time when both are out of alignment with each other.

Storage: Tutorials for configuring the various features contained within the Storage area of the TrueNAS SCALE web interface.

Import Pool: Provides information on ZFS importing for storage pools in TrueNAS SCALE. It also addresses GELI-encrypted pools.
Disks: Articles with instructions for managing, replacing, and wiping disks.
Create Pool: Provides background considerations and a simple tutorial on creating storage pools in TrueNAS SCALE.
Fusion Pools: Provides information on setting up and using fusion pools.
Managing Pools: Provides instructions on managing storage pools, VDEVs, and disks in TrueNAS SCALE.

Datasets: Tutorials for creating and managing datasets in TrueNAS SCALE.

Adding and Managing Datasets: Provides instructions on creating and managing datasets.
Adding and Managing Zvols: Provides instructions on creating, editing, and managing zvols.
Managing User or Group Quotas: Provides information on managing user and group quotas.
Creating Snapshots: Provides instructions on creating ZFS snapshots in TrueNAS Scale.
Managing Snapshots: Provides instructions on managing ZFS snapshots in TrueNAS Scale.
Storage Encryption: Provides information on SCALE storage encryption for pools, root datasets, datasets, and zvols.
Setting Up Permissions: Provides instructions on editing and viewing ACL permissions, using the ACL editor screens, and general information on ACLs.

Shares: Tutorials for configuring the various data sharing features in TrueNAS SCALE.

AFP Migration: Provides information on migrating AFP shares from CORE to SCALE.
Block Shares (iSCSI): Describes the iSCSI protocol and has tutorials for various configuration scenarios.
Adding NFS Shares: Provides instructions on adding NFS shares, starting NFS service, and accessing the share.
Multiprotocol Shares: Provides instructions on setting up SMB and NFSv4 mixed-mode shares.
Windows Shares (SMB): Provides information on SMB shares and instruction creating a basic share and setting up various specific configurations of SMB shares.

Data Protection: Tutorials related to configuring data backup features in TrueNAS SCALE.

Managing Scrub Tasks: Provides instruction on running scrub and resilver tasks.
Cloud Sync Tasks: Tutorials for configuring and managing data backups to from TrueNAS to various 3rd party Cloud Service Providers.
Configuring Rsync Tasks: Provides instructions on adding rsync tasks with two methods, SSH connection and module.
Adding Periodic Snapshot Tasks: Provides instructions on creating periodic snapshot tasks in TrueNAS SCALE.
Creating VMWare Snapshots: Provides instructions for creating ZFS snapshots when using TrueNAS as a VMWare datastore.
Managing S.M.A.R.T. Tests: Provides instructions on running S.M.A.R.T. tests manually or automatically, using Shell to view the list of tests, and configuring the S.M.A.R.T. test service.
Replication Tasks: Tutorials for configuring ZFS snapshot replication tasks in TrueNAS SCALE.

Network: Tutorials for configuring network interfaces and connections in TrueNAS SCALE.

Interface Configurations: Tutorials about configuring the various types of network interfaces available in TrueNAS SCALE.
Adding Network Settings: Provides instructions on adding network settings during initial SCALE installation or after a clean install of SCALE.
Managing Network Global Configurations: Provides instructions on configuring or managing global configuration settings.
Managing Network Settings (Enterprise HA): Provides instructions on how to make changes to network settings on SCALE Enterprise (HA) systems.
Configuring Static Routes: Provides instructions on configuring a static route using the SCALE web UI.
Setting Up IPMI: Guides you through setting up Intelligent Platform Management Interface (IPMI) on TrueNAS SCALE.

Credentials: Tutorials for configuring the different credentials needed for TrueNAS SCALE features.

Using Administrator Logins: Explains role-based administrator logins and related functions. Provides instructions on properly configuring SSH and working with the admin and root user passwords.
Managing Users: Provides instructions on adding and managing administrator and local user accounts.
Managing Local Groups: Provides instructions to manage local groups.
Setting Up Directory Services: Tutorials for configuring the various directory service credentials.
Backup Credentials: Backup credential tutorials for integrating TrueNAS SCALE with cloud storage providers by setting up SSH connections and keypairs.
Certificates: Information about adding and managing certificates, CSRs, CAs and ACME DNS-Authenticators in TrueNAS SCALE.
Configuring KMIP: Describes how to configure KMIP on TrueNAS SCALE Enterprise.

Virtualization: Tutorials for configuring TrueNAS SCALE virtualization features.

Adding and Managing VM Devices: Provides instructions on adding or managing devices used by VMs.
Accessing NAS From a VM: Provides instructions on how to create a bridge interface for the VM and provides Linux and Windows examples.

Apps: Expanding TrueNAS SCALE functionality with additional applications.

Using SCALE Catalogs: Provides basic information on adding or managing application catalogs in TrueNAS SCALE.
Using Install Custom App: Provides information on using Install Custom App to configure custom or third-party applications in TrueNAS SCALE.
Securing Apps: Securing TrueNAS applications with VPNs and Zero Trust.
Community Apps: Notes about community applications and individual tutorials for applications.
Enterprise Applications: Tutorials for using TrueNAS SCALE applications in an Enterprise-licensed deployment.
Sandboxes (Jail-like Containers): Provides advanced users information on deploying custom FreeBSD jail-like containers in SCALE.

Reporting: Provides information on changing settings that control how SCALE displays report graphs, how to interact with graphs, and configuring reporting exporters.

System Settings: Tutorials for configuring the system management options in the System Settings area of the TrueNAS SCALE web interface.

Updating SCALE: Provides instructions on updating SCALE releases in the UI.
Updating SCALE Enterprise HA: Provides instructions on how to update SCALE releases on Enterprise (HA) systems.
General Settings: Tutorials for configuring many general TrueNAS SCALE settings.
Advanced Settings: Tutorials for configuring advanced system settings in TrueNAS SCALE.
Boot Pool Management: Provides instructions on managing the TrueNAS SCALE boot pool and boot environments.
Services: Tutorials for TrueNAS SCALE services.
Using Shell: Provides information on using the TrueNAS SCALE Shell.
Audit Logging: Provides information on the system and SMB Share audit logging screens and function in TrueNAS.