TrueNAS-Compose

Setting Up TrueNAS Before Using Docker Stacks

Before you use this Docker stacks, make sure you have completed the following steps to properly configure TrueNAS:

• Step 1: Install TrueNAS Scale - Follow the official instructions from the TrueNAS website to install it on your hardware.
• Step 2: Configure Network Settings - Ensure your network settings are properly configured:
  1. Navigate to "Network > Interfaces" in the TrueNAS interface.
  2. Click on the "Edit" button of your interface to access the interface settings.
  3. Uncheck "DHCP".
  4. Uncheck "Autoconfigure IPv6".
  5. Set the "MTU" to:

  1500

  6. Set your TrueNAS IP address in the "Aliases" section, in most cases:

  192.168.1.1/24

  7. Click "Save".
  8. Click on "Test Changes" and confirm.
  9. Access the IP address you set up for TrueNAS [ ie: https://192.168.1.1 ] and login again to confirm the changes.
  10. Navigate to "Network > Global Configuration > Settings" in the TrueNAS interface.
  11. Add the following nameservers to the "DNS Servers":

  1.1.1.2

  1.0.0.2

  9.9.9.9

  12. Add your router's IP address to the "Default Gateway", in most cases:

  192.168.1.254

  13. Click "Save".
  14. Navigate to "System > General Settings > GUI > Settings" in the TrueNAS interface.
  15. Choose your TrueNAS IP address in "Web Interface IPv4 Address", in most cases:

  192.168.1.1

  16. Change your TrueNAS HTTP port in "Web Interface HTTP Port" from 80 to:

  81

  17. Change your TrueNAS HTTPS port in "Web Interface HTTPS Port" from 443 to:

  444

  18. Check "Web Interface HTTP -> HTTPS Redirect".
  19. Check "Show Console Messages".
  20. Uncheck "Usage collection".
  21. Click "Save".
  22. Navigate to "System > Advanced Settings > Sysctl" in the TrueNAS interface.
  23. Add the following "Variable=Value" pairs: # Don't copy the '=' sign in beetwen the Variables and their Values

  net.ipv6.conf.all.disable_ipv6=1

  net.ipv4.ip_forward=1

  24. Click "Save".
• Step 3: Configure Apps' Pool - Follow the official instructions from the TrueNAS website to set up your pools and then: # TIP: Name your System/Apps pool 'tank'
  1. Navigate to "Apps > Configuration > Choose Pool" in the TrueNAS interface.
  2. Select your TrueNAS Apps' pool name from the list, in most cases:

  tank

  3. Click "Choose" to save.
• Step 4: Install NVIDIA Drivers (optional) - If you have a NVIDIA GPU make sure you install the NVIDIA drivers/runtime:
  1. Navigate to "Apps > Configuration > Settings" in the TrueNAS interface.
  2. Check "Install NVIDIA Drivers"
  3. Click "Save".
• Step 5: Configure Datasets - You will need to configure datasets to store Docker data:
  1. Navigate to "System > Shell" in the TrueNAS interface.
  2. Type "cli" and press Enter.
  3. Copy and paste the following commands into the TrueNAS CLI: # Replace 'tank' with your Apps' pool name

  storage dataset create name=tank/docker share_type=APPS

  storage dataset create name=tank/docker/dockge share_type=APPS

  storage dataset create name=tank/docker/dockge/stacks share_type=APPS

  storage dataset create name=tank/docker/dockge/data share_type=APPS

  4. Type "exit" and press Enter.
  5. Navigate to "Datasets" in the TrueNAS interface.
  6. Expande your Apps' pool tree and click on the "docker" dataset to select it.
  7. Navigate to "Permissions > Edit" to access the ACL Editor.
  8. Set the following "Access Control List": # This is the default ACL for Apps

  owner@ - root                               Allow | Full Control

  group@ - root                               Allow | Modify

  Group - builtin_users                       Allow | Modify

  Group - builtin_administrators              Allow | Full Control

  User - apps                                 Allow | Modify

  9. Check "Apply permissions recursively" and confirm.
  10. Check "Apply permissions to child datasets".
  11. Click "Save Access Control List".
• Step 6: Create Docker Networks - You will need to create the "proxy" and "home" networks to easily access your Docker services:
  1. Navigate to "System > Shell" in the TrueNAS interface.
  2. Copy and paste the following commands into the TrueNAS shell:

  sudo docker network create --driver=bridge --subnet=172.17.0.0/24 --ip-range=172.17.0.0/24 --gateway=172.17.0.1 proxy

  sudo docker network create --driver=macvlan --subnet=192.168.1.0/24 --ip-range=192.168.1.0/24 --gateway=192.168.1.254 -o parent=eno1 home

  3. If needed, replace the "home" network's subnet/ip-range, gateway and interface (ie: parent=eth0) to match your TrueNAS network's settings
• Step 7: Install Dockge - Use Dockge to manage all your Docker stacks. To install it:
  1. Navigate to "Apps > Discover Apps" in the TrueNAS interface.
  2. Search for "dockge" and click to install.
  3. Navigate to "Network Configuration" in the installation interface.
  4. Keep the default "WebUI Port":

  31014

  5. Change the "Certificate" to:

  'truenas_default' Certificate

  6. Navigate to "Storage Configuration" in the installation interface.
  7. Choose the following type in "Dockge Stacks Storage":

  Host Path (Path that already exists on the system)

  8. Insert the following path in "Host Path": # Replace 'tank' with your Apps' pool name

  /mnt/tank/docker/dockge/stacks

  9. Choose the following type in "Dockge Data Storage":

  Host Path (Path that already exists on the system)

  10. Insert the following path in "Host Path": # Replace 'tank' with your Apps' pool name

  /mnt/tank/docker/dockge/data

  11. Navigate to "Labels Configuration" in the installation interface.
  12. Add the following "Key=Value" pairs: # Don't copy the '=' sign in beetwen the Keys and their Values

  tsdproxy.enable=true

  tsdproxy.name=dockge

  tsdproxy.scheme=https

  tsdproxy.tlsvalidate=false

  tsdproxy.container_port=31014

  13. Make sure to set "dockge" in the "Containers" section of each label.
  14. Click "Save" to install and wait for the green "Running" status indicator.
  15. Click on the "Web UI" button in the "Application Info" section to open Dockge.
  16. Change the URL to "https://" and press Enter. # Add this page to your browser's bookmark bar
• Step 8: Reboot - If everything went well, reboot your TrueNAS system.

Once these steps are completed, you'll be ready to use this Docker stacks on your TrueNAS Scale.

Choose a Docker stack from the dropdown below to get the Docker Compose and .env file configurations, along with installation instructions for TrueNAS Scale.