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

Local Users

  4 minute read.

Last Modified 2022-06-07 10:24 EDT

In TrueNAS, user accounts allow flexibility for accessing shared data. Typically, administrators create users and assign them to groups. Doing so makes tuning permissions for large numbers of users more efficient.

Only the root user account can log in to the TrueNAS web interface.

When the network uses a directory service, import the existing account information using the instructions in Directory Services.

Using Active Directory requires setting Windows user passwords in Windows.

To see user accounts, go to Credentials > Local Users.

LocalUsersSCALE

TrueNAS hides all built-in users (except root) by default. Click the , then click SHOW to see all built-in users.

Creating User Accounts

This short video demonstrates adding a local user.

(Video URL: https://www.truenas.com/docs/files/scaleangelfishlocalusers.mp4)

To create a new user, click Add.

NewUserSCALE

TrueNAS lets users configure four different user account traits.

Identification

Enter the user full name in Full Name. TrueNAS suggests a simplified name in Username derived from the Full Name, but you can override it with your own choice.

You can also assign a user account email address in the Email field.

Set and confirm a password.

User ID and Groups

Next, you must set a user ID. TrueNAS suggests a user ID starting at 1000, but you can change it if you wish. We recommend using an ID of 1000 or greater for non-built-in users.

By default, TrueNAS creates a new primary group with the same name as the user. To add the user to an existing primary group instead, clear the New Primary Group checkbox and select a group from the Primary Group drop-down list. You can add the user to more groups using the Auxiliary Groups drop-down list.

Directories and Permissions

When creating a user, the home directory path is set to /nonexistent, which does not create a home directory for the user. To set a user home directory, select a path using the file browser. If the directory exists and matches the user name, TrueNAS sets it as the user home directory. When the path does not end with a sub-directory matching the user name, TrueNAS creates a new sub-directory. TrueNAS shows the path to the user home directory when editing a user.

You can set the home directory permissions directly under the file browser. You cannot change TrueNAS default user account permissions.

Authentication

You can assign a public SSH key to a user for key-based authentication by pasting the public key into the SSH Public Key field. If you are using an SSH public key, always keep a backup of the key. Click Download SSH Public Key to download the pasted key as a .txt file.

By default, Disable Password is No.

Setting Disable Password to Yes disables several options:

  • The Password field becomes unavailable, and TrueNAS removes any existing password from the account.
  • The Lock User and Permit Sudo options disappear.
  • The account is restricted from password-based logins for services like SMB shares and SSH sessions.

You can set a specific shell for the user from the Shell drop-down:

ShellDescription
cshC shell for UNIX system interactions.
shBourne shell
tcshEnhanced C shell that includes editing and name completion.
bashBourne Again shell for the GNU operating system.
ksh93Korn shell that incorporates features from both csh and sh.
mkshMirBSD Korn Shell
rbashRestricted bash
rzshRestricted zsh
scponlyscponly restricts the user’s SSH usage to only the scp and sftp commands.
zshZ shell
git-shellrestricted git shell
nologinUse when creating a system account or to create a user account that can authenticate with shares but that cannot log in to the TrueNAS system using ssh.

Setting Lock User disables all password-based functionality for the account until you unset it.

Permit Sudo allows the account to act as the system administrator using the sudo command. Leave it disabled for better security.

If the user accesses TrueNAS data using Windows 8 or newer, set Microsoft Account to enable those systems additional authentication methods.

By default, Samba Authentication is enabled. This allows using the account credentials to access data shared with SMB.

Editing User Accounts

To edit an existing user account, go to Credentials > Local Users, expand the User entry, and click Edit: