Get a Quote     (408) 943-4100               TrueNAS Discord      VendOp_Icon_15x15px   Commercial Support Toggle between Light and Dark mode

Setting Up Permissions

  5 minute read.

Last Modified 2022-12-09 09:08 EST

TrueNAS SCALE provides basic permissions settings and a full Access Control List (ACL) editor to define dataset permissions. ACL permissions control the actions users can perform on dataset contents.

An Access Control List (ACL) is a set of account permissions associated with a dataset and applied to directories or files within that dataset. TrueNAS uses ACLs to manage user interactions with shared datasets and creates them when users add a dataset to a pool.

ACL Types in SCALE

TrueNAS SCALE offers two ACL types: POSIX which is the SCALE default, and NFSv4. For a more in-depth explanation of ACLs and configurations in TrueNAS SCALE, see our ACL Primer.

Viewing Permissions

Basic ACL permissions are viewable and configurable on both the Add Dataset and Edit Dataset screens. Click Advanced Options to access the ACL Type and ACL Mode settings.

Advanced ACL permissions are viewable on the Dataset Permissions widget, but only editable for non-root datasets.

ViewRootDatasetPermissionsWidget

Editing Basic ACL Settings

Click the more_vert icon to display the Dataset Actions list of options, and then click Add Dataset to open the Add Dataset configuration screen, or click Edit Options to open the Edit Dataset configuration screen.

Click Advanced Options and scroll down to the ACL Type and ACL Mode settings.

First, select the ACL Type from the dropdown list. The option selected changes the ACL Mode setting.

Editing ACL Permissions

You can view permissions for any dataset but the edit option only displays on the Dataset Permissions widget for non-root datasets.

Configuring advanced permissions overrides basic permissions configured on the add and edit dataset screens.

Click the more_vert icon to display the Dataset Actions list of options for a non-root dataset, and then click View Permissions.

ViewDatasetPermissionsWidget

Click the edit Edit icon. The Edit Permissions screen displays with the Unix Permissions Editor configuration settings.

EditPermissionsUnixPermissionsEditor

Enter or select the user from the dropdown list, set the read/write/execute permissions, and then select Apply User. The options include users created manually or imported from a directory service. Click Apply User to confirm changes. To prevent errors, TrueNAS only submits changes when selected.

A common misconfiguration is removing the Execute permission from a dataset that is a parent to other child datasets. Removing this permission results lost access to the path.

Next enter or select the group from the dropdown list, set the read/write/execute permissions, and then select Apply Group. The options include groups created manually or imported from a directory service. Click Apply Group to confirm changes. To prevent errors, TrueNAS only submits changes when selected.

If you want to apply these settings to all child datasets, select Apply permissions recursively.

Click Save if you do not want to use an ACL preset.

Configuring an ACL Preset (NFSv4 ACL)

WARNING: Changing the ACL type affects how TrueNAS writes and reads on-disk ZFS ACL.

When the ACL type changes from POSIX to NFSv4, internal ZFS ACLs do not migrate by default, and access ACLs encoded in posix1e extended attributes convert to native ZFS ACLs.

When the ACL type changes from NFSv4 to POSIX, native ZFS ACLs do not convert to posix1e extended attributes, but ZFS will use the native ACL for access checks.

To prevent unexpected permissions behavior, you must manually set new dataset ACLs recursively after changing the ACL type.

Setting new ACLs recursively is destructive. We suggest creating a ZFS snapshot of the dataset before changing the ACL type or modifying permissions.

An ACL preset loads NFS4 pre-configured permissions to match general permissions situations.

From the Unix Permissions Editor configuration screen, click Set ACL to configure advanced NFS4 permissions. The If you want to use an ACL preset, click Set ACL. The Edit ACL screen displays with the Select a preset ACL dialog as the first step.

Click the Select a present ACL radio button to use a pre-configured set of permissions, and then select the preset you want to use from the Default ACL Options dropdown list, or click Create a custom ACL to configure your own set of permissions. Click Continue.

NFS4SelectAPresetACLWindow

Each default preset loads different permissions to the Edit ACL screen. The Create a custom preset opens the Edit ACL screen with no default permission settings.

CreateCustomACL

First select or type the name of the user in Owner. The owner controls which TrueNAS user and group has full control of this dataset.

Next select or type the name of the group in Owner Group.

Select the Who ACE value from the dropdown list and then select the Permissions. If you select User or Group you then select the name from User or Group. See nfs4_setfacl(1) NFSv4 ACL ENTRIES. Whatever you select in Who highlights the Access Control List entry on the left side of the screen.

Select Flags to specify how this ACE applies to newly created directories and files within the dataset. Basic flags enable or disable ACE inheritance. Advanced flags allow further control of how the ACE applies to files and directories in the dataset.

If you want to apply this preset to all child datasets select Apply permissions recursively.

To add another item to your ACL, click Add Item. To display the ACL presets window, click Use ACL Preset.

Click Save Access Control List when you finish configuring settings for the user or group in the Who field.

To view ACL information from the console, go to System Settings > Shell and enter:

getfacl /mnt/path/to/dataset

Related Content

Related Dataset Articles