TrueNAS AppsTrueNAS 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.

Community Apps

Documentation for applications within the Community train is created and maintained by members of the TrueNAS community. The TrueNAS Documentation Hub hosts but does not validate or maintain articles within this section.

Community contributions are highly encouraged! Please see Contributing to TrueNAS Application Documentation to learn how you can assist.

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.

The TrueNAS community creates and maintains numerous applications intended to expand system functionality far beyond what is typically expected from a NAS.

By default, the TrueNAS application catalog includes the stable train. To see community-maintained applications on the Discover screen, you must add the train.

To view the community apps, from the Installed application screen, click Settings and then Train Settings. Select the community checkbox on the Train Settings screen and click Save. Go to the Discover screen and click Refresh Catalog, to the right of the search field.

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

Below, you’ll find additional details about TrueNAS apps administration, including best practices and in-depth insights.

App Pool Selection

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

For app stability and performance, we recommend using SSD storage for the apps pool due to their faster speed and resilience for repeated read/writes.

TrueNAS 24.10 and newer creates a hidden ix-apps dataset on the apps pool and mounts the hidden directory at /mnt/.ix-apps. The ix-apps dataset does not inherit encryption if an encrypted pool is selected as the pool for applications.

See Understanding App Storage for more information about the ix-apps dataset and other app data storage volumes.

App Dataset Types

ix-apps Dataset

TrueNAS 24.10 and newer creates a hidden ix-apps dataset, mounted at /mnt/.ix-apps, to store Docker configuration, catalog data, and app metadata. The ix-apps dataset is internally managed by TrueNAS and hidden to prevent user misconfiguration. Any modification of it can result in instability and loss of app functionality.

Do not include the ix-apps dataset inside of an SMB or NFS share.

The ix-apps dataset does not inherit encryption if an encrypted pool is selected as the pool for applications.

Back up and restore functionality as well as migration of the ix-apps dataset from one apps pool to another are not currently supported by the TrueNAS interface. Support for these features is planned for a future TrueNAS release version.

TrueNAS 24.04 and earlier versions stored applications data in an ix-applications dataset on the configured apps pool. Systems with applications deployed that upgrade from earlier releases to 24.10 retain the ix-applications dataset. During the migration process, 24.10 reads the stored Kubernetes app data in the ix-applications dataset, ports them to Docker, and saves them in the new ix-apps dataset. App storage ixVolumes present in ix-applications are cloned under the ix-apps dataset and promoted.

The app data retained in ix-applications enables TrueNAS to revert to 24.04 with functional applications. TrueNAS 24.10 or newer does not use app data in the ix-applications dataset. It can be safely removed after fully migrating to 24.10, but apps do not function if reverted to 24.04 without the ix-applications dataset.

ixVolume Datasets

ixVolume datasets allow TrueNAS to automatically create an app storage path inside the hidden ix-apps dataset.

ixVolumes are typically created with appropriate permissions to deploy the application. If needed, use Enable ACL in Storage Configuration to configure ACL entries for an ixVolume.

ixVolumes are not recommended for permanent storage volumes, they are intended for use as rapid storage for a test deployment of the container. Though they can simplify test deployment, ixVolumes complicate tasks like app data backup. We recommend manually adding datasets and configuring container storage volumes with the host path option.

Host Path Datasets

Host Paths allow users to mount existing TrueNAS datasets to paths within the app container. Create the TrueNAS dataset(s) before assigning them as host paths within the app installation screen.

Mounting a host path does not automatically configure appropriate permissions to deploy the application. Use Enable ACL in Storage Configuration to configure ACL entries for each host path.

Configuring Host Path ACL Entries

After entering the path inside the container in Mount Path, select Enable ACL. Browse to or enter the path to the dataset in Host Path. Click Add next to ACL Entries to display a set of ACE fields. Use ID Type to select whether the ACE is for a user or a group. Enter the UID or GID in ID and adjust the permissions level in Access.

Refer to the app Run As Context on the app details screen for default ID requirements. A user or group ID does not need to exist locally on TrueNAS or match the name configured in the container to grant an ACE. Failing to configure host path ACLs prevents the app from deploying!

Select Force Flag in ACL Options. This allows TrueNAS to write ACL entries to the storage volume if it has existing data in it. Force Flag is required to edit or update an existing application.

SMB Share Volumes

Some app storage configurations include the SMB/CIFS Share option. Use this option to mount an existing SMB share using a Docker volume.

Tmpfs Directories

Some app storage configurations include the Tmpfs (Temporary directory created on the RAM) option. Use this option to configure a memory-backed temporary directory, such as for transcoding. See the Docker tmpfs documentation for more information.

Custom Apps

TrueNAS includes the ability to install third-party apps in Docker containers that allow users to deploy apps not included in the catalog. Generally, any container that follows the Open Container Initiative specifications can be deployed.

To deploy a custom application, go to Apps and click Discover Apps. Click Custom App to open the Install iX App screen with a guided installation wizard. Click > Install via YAML to open the Custom App screen with an advanced YAML editor for deploying apps using Docker Compose.

We recommend setting up your storage, user, or other configuration requirements before beginning deployment. 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 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.

TrueNAS 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.

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.

Applications are provided “as-is” and can introduce system stability or security issues when installed.

Some applications deploy as the root user for initial configuration before changing to operate as a non-root user. Make sure the application is required for your specific use requirements and does not violate your security policies before installation.

The tutorials in this section are for commonly used community-maintained applications. Some apps in this section replace deprecated services or functionality previously built into TrueNAS.

Understanding App Install Wizard Settings

The installation wizard configuration sections vary by application, with some including more configuration areas than others. Click Install to review settings ahead of time to check for required settings. Click Discover on the breadcrumb at the top of the installation wizard to exit the screen without saving and until you are ready return and configure the app settings.

All apps in the stable train, some community train apps, and all apps in the enterprise train generally include these basic setting sections:

  • Application Name shows the default name for the application.

    If deploying more than one instance of the application, you must change the default name.

    Do not change the Version number for official apps or those included in a TrueNAS catalog. When a new version becomes available, the Installed application screen shows an update alert, and the Application Info widget shows an Update button. Updating the app changes the version to the currently available release.

  • Application Configuration shows required and optional settings for the app. Typical settings include user credentials, environment variables, additional argument settings, the name of the node, or even sizing parameters.

  • User and Group Configuration shows the user and group ID for the default user assigned to the app. If not using a default user and group provided, add a new user to manage the application before using the installation wizard, then enter the UID in both the user and group fields. This section is not always included in app installation wizards.

  • Network Configuration shows network settings the app needs to communicate with TrueNAS and the Internet. Settings include the default port assignment, host name, IP addresses, and other network settings.

    If changing the port number to something other than the default setting, refer to Default Ports for a list of used and available port numbers.

    Some network configuration settings include the option to add a certificate. Create the certificate authority and certificate before using the installation wizard if using a certificate is required for the application.

  • Storage Configuration shows options to configure storage for the application. Storage configuration can include the primary data mount volume, a configuration volume, postgres volumes, and an option to add additional storage volumes. The primary mount volumes have two options:

    • ixVolume creates a storage volume inside the hidden ix-apps dataset. This is the default setting.
    • Host Path allows you to select an existing dataset created for the application. It shows additional fields for selecting the path to the dataset and adding the mount point.

    ixVolumes are not recommended for permanent storage volumes, they are intended for rapid storage for a test deployment of the container. We recommend adding datasets and configuring the container storage volumes with the host path option.

    Host paths add existing dataset(s) as the storage volumes. You must configure the datasets before beginning the app installation using the wizard.

    The ix-apps dataset is for internal use only.

    TrueNAS systems with applications deployed that upgrade from earlier releases to 24.10 continue to see the ix-Applications dataset on the pool chosen for applications to use. New installs or systems upgrading where applications are not deployed and a pool is not chosen for apps use the hidden ix-apps dataset. Choosing the pool for apps to use, creates this dataset to store all container-related data. To expose storage volumes found in the ix-applications dataset, take a recursive snapshot.

    Some applications require specific storage volumes for configuration and other data. Apps with these requirements might indicate this in the wizard UI but refer to tutorials for specifics. After configuring required storage volumes you can add storage volumes. To configure additional storage volumes for the application, click Add to select the type of storage to configure. The three storage options are:

    • ixVolume
    • Host path
    • SMB share

    An SMB share option allows you to mount an SMB share as a Docker volume for the application to use. If the application requires specific datasets or you want to allow SMB share access, configure the dataset(s) and SMB share before using the installation wizard.

    ixVolumes do not require setting up an Access Control List (ACL) and Access Control Entry (ACE) in the app configuration settings, but host paths do. After entering the path inside the container in Mount Path, select Enable ACL. Browse to or enter the path to the dataset in Host Path. Click Add next to ACL Entries to display a set of ACE fields. Use ID Type to select whether the ACE is for a user or a group. Enter the UID or GID in ID and adjust the permissions level in Access.

    Refer to the app Run As Context on the app details screen for default ID requirements. A user or group ID does not need to exist locally on TrueNAS or match the name configured in the container to grant an ACE. Failing to configure host path ACLs prevents the app from deploying!

    Select Force Flag to allow TrueNAS to update the application to the next version. This allows TrueNAS to write ACL entries to the storage volume if it has existing data in it. Force Flag is required to edit or update an existing application.

  • Resources Configuration shows CPU and memory settings for the container pod. In most cases, you can accept the default settings, or you can change these settings to limit the system resources available to the application.

    Some apps include GPU settings if the app allows or requires GPU passthrough.

After installing an app, you can modify most settings by selecting the app on the Installed applications screen and then clicking the Edit button on the Application Info widget for that app.

For more detailed information on application install wizard settings, see each of the tutorials provided in this section.

Section Contents

  • 2FAuth: Provides installation instructions for the 2FAuth application in TrueNAS.

  • Actual Budget: Provides installation instructions for the Actual Budget application in TrueNAS.

  • AdGuard Home: Provides installation instructions for the AdGuard Home application in TrueNAS.

  • Audiobookshelf: Provides installation instructions for the Audiobookshelf application in TrueNAS.

  • Autobrr: Provides installation instructions for the Autobrr application in TrueNAS.

  • Bazarr: Provides installation instructions for the Bazarr application in TrueNAS.

  • Briefkasten: Provides installation instructions for the Briefkasten application in TrueNAS.

  • Castopod: Provides installation instructions for the Castopod application in TrueNAS.

  • Chia: Provides basic installation instructions for the Chia application in TrueNAS.

  • ClamAV: Provides installation instructions for the ClamAV application in TrueNAS.

  • Cloudflared: Provides installation instructions for the Cloudflared application in TrueNAS.

  • Dashy: Provides installation instructions for the Dashy application in TrueNAS.

  • DDNS-Updater: Provides basic configuration instructions for the DDNS-Updater application in TrueNAS.

  • Deluge: Provides installation instructions for the Deluge application in TrueNAS.

  • Distribution: Provides installation instructions for the Distribution application in TrueNAS.

  • Dockge: Provides installation instructions for the Dockge application in TrueNAS.

  • Draw.io: Provides installation instructions for the Draw.io application in TrueNAS.

  • File Browser: Provides installation instructions for the File Browser application in TrueNAS.

  • Firefly III: Provides installation instructions for the Firefly III application in TrueNAS.

  • Flame: Provides installation instructions for the Flame application in TrueNAS.

  • FlareSolverr: Provides installation instructions for the FlareSolverr application in TrueNAS.

  • FreshRSS: Provides installation instructions for the FreshRSS application in TrueNAS.

  • Frigate: Provides installation instructions for the Frigate application in TrueNAS.

  • FSCrawler: Provides installation instructions for the FSCrawler application in TrueNAS.

  • Gitea: Provides installation instructions for the Gitea application in TrueNAS.

  • Grafana: Provides installation instructions for the Grafana application in TrueNAS.

  • HandBrake: Provides installation instructions for the HandBrake application in TrueNAS.

  • Homarr: Provides installation instructions for the Homarr application in TrueNAS.

  • Homepage: Provides installation instructions for the Homepage application in TrueNAS.

  • Homer: Provides installation instructions for the Homer application in TrueNAS.

  • Immich: Provides installation instructions for the Immich application in TrueNAS.

  • Invidious: Provides installation instructions for the Invidious application in TrueNAS.

  • IPFS: Provides installation instructions for the IPFS application in TrueNAS.

  • Jellyfin: Provides installation instructions for the Jellyfin application in TrueNAS.

  • Jellyseerr: Provides installation instructions for the Jellyseerr application in TrueNAS.

  • Jenkins: Provides installation instructions for the Jenkins application in TrueNAS.

  • Joplin: Provides installation instructions for the Joplin application in TrueNAS.

  • Kapowarr: Provides installation instructions for the Kapowarr application in TrueNAS.

  • Kavita: Provides installation instructions for the Kavita application in TrueNAS.

  • Komga: Provides installation instructions for the Komga application in TrueNAS.

  • Lidarr: Provides installation instructions for the Lidarr application in TrueNAS.

  • Linkding: Provides installation instructions for the Linkding application in TrueNAS.

  • Listmonk: Provides installation instructions for the Listmonk application in TrueNAS.

  • Logseq: Provides installation instructions for the Logseq application in TrueNAS.

  • Mealie: Provides installation instructions for the Mealie application in TrueNAS.

  • MeTube: Provides installation instructions for the MeTube application in TrueNAS.

  • Minecraft: Provides installation instructions for the Minecraft application in TrueNAS.

  • MineOS: Provides installation instructions for the MineOS application in TrueNAS.

  • Mumble: Provides installation instructions for the Mumble application in TrueNAS.

  • n8n: Provides installation instructions for the n8n application in TrueNAS.

  • Navidrome: Provides installation instructions for the Navidrome application in TrueNAS.

  • Netboot.xyz: Provides installation instructions for the Netboot.xyz application in TrueNAS.

  • Nginx Proxy Manager: Provides installation instructions for the Nginx Proxy Manager application in TrueNAS.

  • Node-RED: Provides installation instructions for the Node-RED application in TrueNAS.

  • Odoo: Provides installation instructions for the Odoo application in TrueNAS.

  • Ollama: Provides installation instructions for the Ollama application in TrueNAS.

  • Omada Controller: Provides installation instructions for the Omada Controller application in TrueNAS.

  • Open WebUI: Provides installation instructions for the Open WebUI application in TrueNAS.

  • Organizr: Provides installation instructions for the Organizr application in TrueNAS.

  • Overseerr: Provides installation instructions for the Overseerr application in TrueNAS.

  • Palworld: Provides installation instructions for the Palworld application in TrueNAS.

  • Paperless-ngx: Provides installation instructions for the Paperless-ngx application in TrueNAS.

  • Passbolt: Provides installation instructions for the Passbolt application in TrueNAS.

  • Penpot: Provides installation instructions for the Penpot application in TrueNAS.

  • pgAdmin: Provides installation instructions for the pgAdmin application in TrueNAS.

  • PiGallery2: Provides installation instructions for the PiGallery2 application in TrueNAS.

  • Piwigo: Provides installation instructions for the Piwigo application in TrueNAS.

  • Planka: Provides installation instructions for the Planka application in TrueNAS.

  • Plex Auto Languages: Provides installation instructions for the Plex Auto Languages application in TrueNAS.

  • Portainer: Provides installation instructions for the Portainer application in TrueNAS.

  • Prowlarr: Provides installation instructions for the Prowlarr application in TrueNAS.

  • qBittorrent: Provides installation instructions for the qBittorrent application in TrueNAS.

  • Radarr: Provides installation instructions for the Radarr application in TrueNAS.

  • Readarr: Provides installation instructions for the Readarr application in TrueNAS.

  • Recyclarr: Provides installation instructions for the Recyclarr application in TrueNAS.

  • Redis: Provides installation instructions for the Redis application in TrueNAS.

  • Roundcube: Provides installation instructions for the Roundcube application in TrueNAS.

  • Rsync Daemon: Installation and basic usage instructions for the Rsync Daemon application in TrueNAS.

  • Rust Desk: Provides installation instructions for the Rust Desk application in TrueNAS.

  • SABnzbd: Provides installation instructions for the SABnzbd application in TrueNAS.

  • SearXNG: Provides installation instructions for the SearXNG application in TrueNAS.

  • SFTPGo: Provides installation instructions for the SFTPGo application in TrueNAS.

  • Sonarr: Provides installation instructions for the Sonarr application in TrueNAS.

  • Tailscale: Provides installation instructions for the Tailscale application in TrueNAS.

  • Tautulli: Provides installation instructions for the Tautulli application in TrueNAS.

  • Tdarr: Provides installation instructions for the Tdarr application in TrueNAS.

  • Terraria: Provides installation instructions for the Terraria application in TrueNAS.

  • TFTP Server: Provides instructions for installing the TFTP Server application in TrueNAS.

  • Tiny Media Manager: Provides installation instructions for the Tiny Media Manager application in TrueNAS.

  • Transmission: Provides installation instructions for the Transmission application in TrueNAS.

  • Unifi Controller: Provides installation instructions for the Unifi Controller application in TrueNAS.

  • Unifi Protect Backup: Provides installation instructions for the Unifi Protect Backup application in TrueNAS.

  • Vaultwarden: Provides installation instructions for the Vaultwarden application in TrueNAS.

  • Vikunja: Provides installation instructions for the Vikunja application in TrueNAS.

  • WebDAV: Instructions for installing and configuring the WebDAV app and sharing feature in TrueNAS.

  • Whoogle: Provides installation instructions for the Whoogle application in TrueNAS.

  • Wordpress: Provides installation instructions for the Wordpress application in TrueNAS.

  • Zerotier: Provides installation instructions for the Zerotier application in TrueNAS.