Getting started
Setup checklist
Follow these steps in order. Each step has an Expected result so you can verify the setup (important for App Store review).
0) Requirements
- The iPhone and the Agent must be able to reach
https://apn.no-logs.de.
- The Agent must be reachable from your iPhone browser (Agent Web UI).
Note: If you use hostnames that are not resolvable in containers (for example some .local setups), use an IP address or a resolvable DNS name.
1) Create a TrueNAS API key
- Create a TrueNAS API key in the TrueNAS UI.
- Copy the API key and keep it safe.
Expected result: You have a TrueNAS API key ready to paste into NAS Guard on iOS.
2) Create a server profile in the iOS app
- Open NAS Guard on iOS.
- Add a server profile with your TrueNAS URL and the API key.
Expected result: The server profile is saved in the app and can be selected.
3) Install the Agent (TrueNAS SCALE Custom App YAML)
- Install/update the Agent using the TrueNAS Edit App YAML method.
- Follow the copy/paste guide here: Install Agent (TrueNAS SCALE).
Expected result: The App status is Running and the Agent Web UI opens in your browser.
4) Generate a pairing code (iOS)
- In NAS Guard iOS, open your server profile.
- Generate an Agent pairing code.
Expected result: The iOS app shows a pairing code and an expiry time.
5) Enter the pairing code in the Agent Web UI
- Open the Agent Web UI in your browser.
- Enter the pairing code and press Pair.
- Keep the iOS app open for a moment so it can upload the TrueNAS config.
Expected result: The Agent shows that it is paired and starts connecting to TrueNAS.
6) TLS / certificate pinning (TOFU)
If your TrueNAS uses a self-signed certificate, the Agent can pin the certificate fingerprint (Trust On First Use). See TLS / certificate pin.