TrueNAS Apps: Tutorials
Application maintenance is independent from TrueNAS version release cycles.
App versions, features, options, and installation behavior at time of access might vary from documented tutorials and UI reference.

Enterprise Apps

4 minute read.

Last Modified 2024-09-27 13:35 EDT

We welcome community contributions to keep this documentation current! Click Edit Page in the top right corner to propose changes to this article. See Updating Content for more information.

TrueNAS Enterprise
SCALE Enterprise-licensed systems do not have applications available by default. To enable applications as part of the Enterprise license, consult with iXsystems.
Only install qualified applications from the Enterprise applications train with the assistance of iXsystems Support.
Contacting Support
Customers who purchase iXsystems hardware or that want additional support must have a support contract to use iXsystems Support Services. The TrueNAS Community forums provides free support for users without an iXsystems Support contract.
iXsystems Customer Support
Support Portal https://support.ixsystems.com
Email support@ixsystems.com
Telephone and Other Resources https://www.ixsystems.com/support/

iXsystems Customer Support
Support Portal	https://support.ixsystems.com
Email	support@ixsystems.com
Telephone and Other Resources	https://www.ixsystems.com/support/

TrueNAS is certified with leading hypervisors and backup solutions to streamline storage operations and ensure compatibility with your existing IT infrastructure. TrueNAS Enterprise storage appliances deliver a wide range of features and scalability for virtualization and private cloud environments, with the ability to create off-site backups with scheduled sync and replication features. TrueNAS applications expand the capabilities of your system by adding third-party software but can add significant risk to system stability and security.

Keep these general best practices in mind when using applications with TrueNAS:

App Pool Selection

We recommend users keep the container use case in mind when choosing a pool. Select a pool with enough space for all the application containers you intend to use.

TrueNAS creates the ix-apps dataset on the chosen pool and uses it to store all container-related data. This is for internal use only.

SCALE provides two default storage options, the default iXvolume or setting a host path to a preexisting dataset. If you intend to store your application data in a location separate from other storage on your system, create a new dataset before launching the app installation wizard.

App Dataset and File Sharing

SCALE provides two default storage options, iXvolumes and host path to a pre-existing dataset.

Selecting the iXvolume allows SCALE to create the storage volume for the application. If the application requires datasets with specific names, you must create them before launching the application installation wizard.

Earlier versions of SCALE had issues with apps failing to deploy if the application and an SMB or NFS share had the same host path to a dataset. This issue no longer exists, but we still recommended creating datasets for applications that do not share the same host path as an SMB or NFS share.

Docker Compose Settings

As of 24.10, TrueNAS apps use Docker containers and Docker Compose. Docker Compose is an open-source container and image software that manages images and container deployments. The default system-level settings are found in Apps > Settings.

Custom Apps

The Custom App button opens a configuration wizard where users can install applications not included in the approved application catalog train. Be prepared with all required information and complete preparation steps beginning to use the Custom App wizard. You cannot leave the configuration wizard to go create data storage or directories, configure network settings, set up certificates, or other functions, and then return to the wizard to find saved settings.

We recommend setting up your storage, user, or other configuration requirements before starting the wizard. You should have access to information such as:

The path to the image repository
Any container entrypoint commands or arguments
Container environment variables
Network settings
IP addresses and DNS nameservers
Container and node port settings
Storage volume locations
Certificates for image security

App Directory Services

TrueNAS SCALE allows configuring an Active Directory or LDAP server to handle authentication and authorization services, domain, and other account settings. Identify your existing Kerberos realm and keytab information. You might need to supply your LDAP server host name, LDAP server base and bind distinguished names (DN), and the bind password.

SCALE is configured with default port numbers, but you can change these. Before making a port number change, refer to the Default Ports for a list of used and available ports before changing default port assignments. TrueNAS SCALE requires assinging a node port greater than 9000.

iXsystems Support can assist Enterprise customers with configuring directory service settings in TrueNAS with the information customers provide, but they do not configure customer Active Directory system settings.

For more information on configuring general application functions and installation wizard screens, see TrueNAS Apps.

Understanding App Intall Wizard Settings

For information on adding to or changing the train for the apps catalog, see Managing App Trains.

Enterprise Apps Contents

MinIO Enterprise: Tutorials for installing and configuring the MinIO Enterprise application in an Enterprise-licensed deployment.
Syncthing (Enterprise): Provides general information, guidelines, installation instructions, and use scenarios for the Enterprise version of the Syncthing app.