Get a Quote   (408) 943-4100               TrueNAS Discord      VendOp_Icon_15x15px   Commercial Support Toggle between Light and Dark mode
TrueNAS.com Software Systems Company Community Security iX Portal Download

  1. Documentation Hub
  2. /
  3. TrueNAS CORE and Enterprise
  4. /
  5. Configuration Tutorials
  6. /
  7. Services
  8. /
  9. Configuring SSH
Edit this page

Configuring SSH

  2 minute read.

Last Modified 2022-05-11 11:36 EDT

The SSH service allows connections to TrueNAS with the Secure SHell Transport Layer Protocol. When TrueNAS is used as an SSH server, the users in the network must use SSH client software to transfer files with SSH.

Allowing external connections to TrueNAS is a security vulnerability! Do not enable SSH unless external connections are required.

To configure SSH, disable the service and click .

ServicesSSHOptions

Configure the options as needed to match your network environment.

See SSH Screen

Remote systems could require root access to the system, but make sure to have all security precautions in place before allowing root access.

There are some additional options recommendations for the SSH service:

  • Add *NoneEnabled no to the Auxiliary Parameters to disable the insecure none cipher.
  • Increase the ClientAliveInterval if SSH connections tend to drop.
  • ClientMaxStartup defaults to 10. Increase this value when more concurrent SSH connections are required.

Don’t forget to re-enable the SSH service on the Services page when all configuration changes are complete. To create and store specific SSH connections and keypairs, go to the System menu section.

This only works for users that use command line versions of commands scp and sftp. When SSH is configured, authenticated users with a user account can use ssh to log into the TrueNAS system over the network. User accounts are created by going to Accounts > Users and clicking ADD.

By default, the user sees their home directory after logging in with SSH. However, the user can still find system locations outside their home directory, so take security precautions before granting users SSH access to the system. One method to increase security is to change shell for a user to only allow file transfers. This allows users to use commands scp and sftp to transfer files between their local computer and their home directory on the TrueNAS system while restricting them from logging into the system using ssh.

To configure this scenario, go to Accounts > Users and edit the desired user account. Change the Shell to scponly. Repeat for each user that needs restricted SSH access.

Accounts Users Edit Shell Scp only

Test the configuration from another system by running the sftp, ssh, and scp commands as that user account. sftp and scp work but ssh fails.