NAS Guard Help

Install the Agent (TrueNAS SCALE)
EN DE

Contents

Overview Getting started Install Agent (TrueNAS SCALE) Pairing TrueNAS TLS / certificate pin Troubleshooting FAQ
TrueNAS SCALE
Install the NAS Guard Agent

This guide uses the exact installation method shown in TrueNAS SCALE: Apps → Installed → Edit → Edit App YAML. Copy/paste the YAML below.

What you need

  • TrueNAS SCALE with Apps enabled.
  • A dataset directory for persistent Agent data (host path).
  • Access to the NAS Guard Agent container image.
Important: The Agent must have persistent storage mounted to /data. Otherwise pairing state and the certificate pin will be lost after updates/restarts.

Step 1: Create a dataset directory for Agent data

  1. In TrueNAS, open Datasets.
  2. Create a dataset or directory you will mount into the container (example: /mnt/POOL/apps/nas-guard-agent).
This path is required. You will paste it into the YAML under volumes:.

Step 2: Install/Update via “Edit App YAML”

  1. Open Apps → Installed.
  2. Select your app (example name: agent).
  3. Click Edit → Edit App YAML.
  4. Replace the YAML with the following (copy/paste):
services:
  nas-guard-agent:
    container_name: nas-guard-agent
    environment:
      - NASGUARD_PUSH_BASE_URL=https://apn.no-logs.de
      - NASGUARD_DATA_DIR=/data
    image: registry.git.hans-renz.de/hans/nas-guard-agent-images:latest
    ports:
      - '18080:8080'
    pull_policy: always
    restart: unless-stopped
    volumes:
      - /mnt/POOL/apps/nas-guard-agent:/data
Adjust only these lines if needed:
  • Data path: /mnt/POOL/apps/nas-guard-agent:/data → replace /mnt/POOL/... with your dataset path.
  • Web UI port: '18080:8080' → you can change 18080 if the port is already used.
Expected result: After saving, the App status becomes Running and shows the port mapping 18080:8080 in the Workloads/Ports widget.

Step 3: Open the Agent Web UI

  1. Open in your browser: http://<truenas-ip>:18080/ (use your chosen host port if you changed it).
  2. You should see the NAS Guard Agent page.
If it does not open: Check port mapping and whether the App is running. See Troubleshooting.
Next: Pairing
help.no-logs.de