TrueNAS Apps

This article covers how to set up the TrueNAS Apps service, configure global settings, and other general information. For details on discovering, installing, and managing applications, see Managing Apps and individual app tutorials.

You must choose a pool before you can install an application. See Choosing the Apps Pool below for more information about apps pool selection.

As of 24.10, TrueNAS apps use Docker containers and Docker Compose for deployment. Docker is an open-source software that manages images and container deployments.

The default system-level settings are found in Apps > Settings.

For more information on screens and screen functions, refer to the UI Reference article on Apps Screens.

Use the Configuration dropdown to access the Choose Pool, Unset Pool, Manage Container Images, and Settings options.

You are prompted to select the pool for apps the first time you click on Apps. You can exit out of this if you are not ready to deploy apps or do not have a pool configured for apps to use for storage. You must set the pool before you can add any application.

Select the pool and click Save. If you close the dialog to set the pool later, click Configuration > Choose Pool to set the pool.

To select a different pool for apps to use, click Configuration > Unset Pool. This turns off the apps service until you choose another pool for apps to use.

To sign in to a Docker registry, click Configuration > Sign-in to a Docker registry to go to the Docker Registries screen.

Signing in to a registry, such as Docker Hub, is not required but allows you to avoid rate limiting issues or connect to a private registry.

Click Add Registry to open the Create Docker Registry panel.

Use the URI dropdown to select the Uniform Resource Identifier (URI) type for the registry. Options are Docker Hub or Other Registry. The URI dropdown is hidden when a Docker Hub registry record is already configured.

To sign in to Docker Hub, enter the user name and password of an existing Docker Hub account.

To sign in to another registry, select Other Registry from the dropdown or click Add Registry again after signing in to Docker Hub.

Enter a valid Uniform Resource Identifier (URI) for the registry, for example https://index.docker.io/v1/. Then enter a display name for the registry record in TrueNAS.

Enter the user name and password of an existing account on the registry.

Click Save to sign in and create the registry record.

Click Configuration > Settings to open the Settings screen, which contains options for setting app trains, configuring app networking, installing NVIDIA drivers (if compatible hardware is present), and allowing TrueNAS to monitor for Docker image updates.

TrueNAS applications are available in three catalogs (trains):

Enterprise

Applications validated by TrueNAS Engineering for Enterprise deployment on TrueNAS Enterprise-licensed systems.

These applications receive either Enterprise Deployment Support or full Enterprise Application Support from the TrueNAS Support team.

Stable

Applications tested by the TrueNAS Engineering team and chosen based on their functionality and integration with TrueNAS.

TrueNAS Engineering can provide software maintenance for these applications, but the TrueNAS Support team does not offer continual support. Issues for these applications are tracked separately and addressed on a best-effort basis in the community forums and other user-driven resources.

Community

Applications proposed and maintained by the TrueNAS community without official TrueNAS support.

Issues for these applications are tracked separately and addressed on a best-effort basis in the community forums and other user-driven resources.

Some apps proposed by community members might be adopted as official Stable train apps.

See App Support Definitions for more information on application support levels.

TrueNAS Community Edition systems populate the Discover apps screen with the Stable and Community catalogs populate by default. TrueNAS Enterprise-licensed systems show the Enterprise catalog.

Users can change the apps displayed on the Discover screen by adding or removing trains. To add or remove a train, Settings on the Configuration dropdown list to open the Settings screen.

Select the Preferred Trains checkbox(es) for the train(s) to include, then click Save.

After making a change, go to the Discover screen and click on Refresh Catalog to pull the catalog from the repository and refresh it in TrueNAS.

To remove a train from the catalog, deselect the checkbox for the train on the Settings screen, then click Save. You must have at least one train selected.

Go to Apps > Installed, click Configuration, and select Settings.

To add another range of IP addresses, click Add to the right of Address Pools, then select a range from the dropdown list of options, and enter the desired value in Size.

Base shows the default IP address and subnet, and Size shows the network size of each docker network that is cut off from the base subnet.

This setting replaces the Kubernetes Settings option for Bind Network in 24.04 and earlier. Use to resolve issues where apps experience issues where TrueNAS device is not reachable from some networks. Select the network option, or add additional options to resolve the network connection issues.

Give special consideration when TrueNAS is installed in a VM, as VMs are not configured to use HTTPS.

Enabling HTTPS redirect can interfere with the accessibility of some apps. To determine if the HTTPS redirect is active, go to System > General Settings > GUI > Settings and locate the Web Interface HTTP -> HTTPS Redirect checkbox.

To disable HTTPS redirects, clear the checkbox and click Save, then clear the browser cache before attempting to connect to the app again.

Beginning in TrueNAS 24.10, NVIDIA drivers are no longer automatically installed. Users must manually install drivers from the TrueNAS UI.

If running TrueNAS 24.10 or higher:

1. Go to Apps > Installed and click on the Configuration.

2. Click on Settings to open the Settings configuration screen.

3. Select Install NVIDIA Drivers, which is available to users with compatible GPUs.

4. Select Install NVIDIA Drivers, and click Save.

Select Check for docker image updates (selected by default) to enable TrueNAS to periodically check for Docker image updates. This applies to all Docker images present on the system for either catalog or custom applications. Disable to prevent TrueNAS from monitoring for upstream image updates.

TrueNAS offers three distinct classes of support for applications, each tailored to provide varying levels of assistance depending on the specific needs and requirements.
This policy outlines the support structure for applications on TrueNAS.
Users should review these definitions carefully and consult with their support channels if they have specific questions about the level of support applicable to their applications.