(408) 943-4100               V   Commercial Support Toggle between Light and Dark mode

Applications

  5 minute read.

Last Modified 2021-03-31 14:03 EDT

With the rest of the system configured and data being shared over a network, the final step to consider for first time setup is installing any application solutions. Applications or features added to TrueNAS are created in separate “Plugins”, Jails", or “Virtual Machines” that are kept separate from the base TrueNAS operating system. If anything goes wrong or a security vulnerability is exploited in one of these application environments, TrueNAS remains unaffected. These solutions safely expand TrueNAS' capabilities in a restricted, safeguarded way.

The primary method to install applications is to use Plugins. These are pre-packaged applications that quickly install in a tailor-made environment. Some plugins are supported by iXsystems while others are provided and maintained by the open source community.

A Jail is a restricted FreeBSD operating system installed as a separate subset of TrueNAS. Jails can install a wide variety of applications and be tuned to very specific use cases, but require more extensive knowledge of FreeBSD and command line operation.

A Virtual Machine is a fully independent operating system installation. This reserves or splits the available hardware resources to create a different, full operating system experience. TrueNAS can install Windows or Unix-like operating systems in a Virtual Machine (VM), but regular system performance is reduced while virtual machines are running.

Click one of the tabs below to see instructions on installing your preferred application solution.

Plugins that use a network interface need to Disable Hardware Offloading in Network -> Interface. Disabling hardware offloading can reduce general network performance for that interface, so it is recommended to use a secondary interface for application environments.

This instruction demonstrates plugins by walking you through installing the community-favorite Plex application. You will need an account with Plex to follow these instructions.

Installing Plex

Create a dataset called audio and a dataset called video to be used as mount points for Plex. Next, go to the Plugins page.

Installing a basic PlexMedia Plugin:

  1. Select the Plex Media Server plugin and click INSTALL.

PlexInstallButton

  1. Under Jail Name, enter whatever name you’d like (i.e. “Plex”).
  2. DHCP is set automatically.
  3. Click SAVE.

PluginsPlexMediaSave

  1. A dialog window shows the installation progress.

PluginsPlexInstallProgress

When available, Plugin Installation Notes display when the install completes.
  1. The plugin Status shows as up, with the Boot option set.
  2. Click > to expand the Plex table entry:

PluginsPlexJailUp

  1. Stop the up plugin.
  2. Click MOUNT POINTS.

PluginsPlexSetMountpoints

  1. Click Actions and Add.

JailsMountPointsPlexAddMountpoint

  1. Fill out one mount point for each previously created dataset. The Source is the created dataset and the Destination is the media directory with /datasetname appended (see example):

JailsMountPointsPlexSetMountpoint

  1. Click Submit. Do this for as many mount points as needed. In this example, we have audio and video.

  2. Go to Storage > Pools and click > Edit Permissions for your source datasets.

StoragePoolsPlexEditPermissions

  1. Click Create a custom ACL and Continue.

StoragePoolsPermissionsPlexACL

  1. Click ADD ACL ITEM and enter the values pictured below:

StoragePoolsPermissionsPlexPermissions

Set Apply permissions recursively and click Save.

  1. Go to Plugins, find the Plex entry, and click the >. Start the plugin.

Accessing Plex

  1. When the Plex plugin status is up, click the > and Manage.

PluginsPlexManage

  1. Enter your Plex login informamtion.

PluginsPlexLogin

PluginsPlexSuccess

Installing a Jail

  1. Go to the Jails page and click ADD.

    Jails

  2. Enter a jail Name, select the Release version, and click NEXT.

    JailsAddName

  3. To allow the jail access to the internet, set DHCP Autoconfigure IPv4 and click NEXT. Additional defaults are set when the DHCP option is set.

    JailsAddNetworkingDHCP

  4. Review the Jail Summary and click SUBMIT.

    JailsAddConfirm

Accessing a Jail

  1. Go to Jails and click the > next to the newly created jail. Click START.

    JailsStart

  2. When the jail State changes to up, click > SHELL to see the jail command line.

    JailsShell

Installing a Virtual Machine

Virtual Machines require uploading an Operating System .iso to TrueNAS. This example shows using an Ubuntu .iso:

  1. Go to Virtual Machines and click ADD.

    VirtualMachines

  2. Select a Guest Operating System and enter a Name. For this example the Guest Operating System is set to Linux. Click NEXT.

    VirtualMachinesAddOperatingSystemLinux

  3. Now enter the physical resources to give the VM. Larger numbers of Virtual CPUs, Cores, Threads, and Memory allow the VM to perform better, but reduces the performance of the TrueNAS system. Click NEXT.

    VirtualMachinesAddCPU

  4. Set Create a new disk image and select a Zvol Location for the VM storage. Enter a usable storage Size (example shows 50 GiB) and click the NEXT button.

    VirtualMachinesAddDisks

  5. Network Interface automatically detects the hardware and sets defaults that allow network access. Make sure these settings are valid, then click NEXT.

    VirtualMachinesAddNetworkInterface

  6. Set Upload an installer image file to see additional options. Select an ISO save location on the TrueNAS system. Now click Choose File and browse to the OS installation .iso. Click UPLOAD and wait for the process to finish (this can take some time). Click NEXT.

    VirtualMachinesAddInstallationMedia

  7. Confirm the VM configuration is correct and click SUBMIT.

    VirtualMachinesAddConfirm

Accessing a Virtual Machine

  1. Go to Virtual Machines and click > next to the newly created VM. Click START.

    VirtualMachinesStart

  2. When the VM State changes to up, click VNC to see the VM display.

    VirtualMachinesOptions

    Because this example used an Ubuntu .iso, the Ubuntu installation screen is shown.

    UbuntuInstall

    From here, install the OS as normal.

  3. When the OS install completes, go back to Virtual Machines, toggle the State, and click DEVICES.

    VirtualMachinesDevices

    Find the CDROM entry and click > Delete to remove it. This removes the installation .iso from the VM and allows it to boot into the full OS the next time the VM activates.