TrueNAS SCALE
Install the NAS Guard Agent
The NAS Guard Agent runs as a lightweight container on your TrueNAS and connects your NAS to the app — securely and without exposing any ports to the internet.
Why run the Agent?
- Real-time push alerts — get notified immediately when your NAS has issues (degraded pools, disk errors, failed services).
- No port forwarding required — the Agent connects outbound to our push service. Your NAS stays behind your firewall.
- Privacy first — only alert metadata is transmitted. No access to your files or credentials.
More to come: The Agent lays the groundwork for additional features in future updates — running it now means you'll benefit automatically.
What you need
- TrueNAS SCALE with Apps enabled.
- A server profile in the NAS Guard iOS app (TrueNAS URL + API key).
Install from the app (recommended)
The easiest way to install the Agent is directly from the NAS Guard app:
- Open NAS Guard on iOS and go to your server's settings.
- Scroll to Server Monitoring.
- Select a storage pool and tap Install Agent.
Expected result: The app installs the Agent automatically. After a few seconds the status shows Running.
After installation, the app will guide you through the pairing process. See Pairing for details.
Manual install (advanced)
If you prefer to install manually or need to customize the configuration:
- In TrueNAS, open Apps → create a new Custom App.
- Open Edit → Edit App YAML and paste the following:
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.no-logs.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: Replace
/mnt/POOL/... with your dataset path.
- Web UI port: Change
18080 if the port is already in use.
After the app is running, open the Agent Web UI at http://<truenas-ip>:18080/ and proceed with Pairing.