Installation Guide
Get HyperDeck Backup Manager running on your TrueNAS server in under 10 minutes.
1. Prerequisites
- TrueNAS SCALE 25.04 (Electric Eel) or later
- A storage pool with space for video recordings
- Network access to your Blackmagic HyperDeck devices
- A license key from entertainmentit.co/hyperdeck-backup (or start a free trial during setup)
System Requirements
| HyperDecks | CPU | RAM | NIC | Storage |
|---|---|---|---|---|
| 1 – 5 | 4+ cores | 8 GB | 1 Gbps | HDD or SSD |
| 6 – 10 | 8+ cores | 16 GB | 10 Gbps | SSD recommended |
| 11 – 15 | 12+ cores | 32 GB | 10 Gbps | SSD |
| 16 – 20 | 16+ cores | 64 GB | 10 Gbps | NVMe SSD |
2. Create TrueNAS Datasets
You need three datasets to store recordings, app data, and configuration. These persist across updates and restarts.
In TrueNAS, go to Datasets in the left sidebar.
Click Add Dataset. Name it Recordings (or any name you prefer). Click Save.
Your path: /mnt/YourPool/Recordings
Click Add Dataset. Name it hyperdeck-data. Click Save.
Path: /mnt/YourPool/hyperdeck-data
Click Add Dataset. Name it hyperdeck-config. Click Save.
Path: /mnt/YourPool/hyperdeck-config
3. Install the App
In TrueNAS, click Apps → Discover Apps → Custom App (top-right button).
Fill in these values:
| Field | Value |
|---|---|
| Application Name | hyperdeck-backup |
| Image Repository | ghcr.io/devsupport-eit/hyperdeck-backup |
| Image Tag | latest |
4. Network & Storage Configuration
Network
Check the Host Network option. This is required — the app needs direct network access to communicate with HyperDeck devices.
The web UI will be available on port 8080 of your TrueNAS server's IP.
Storage — Host Path Volumes
Add three volumes (replace /mnt/YourPool with your actual pool):
| Host Path | Mount Path | Purpose |
|---|---|---|
/mnt/YourPool/hyperdeck-data | /app/data | Database, license, settings |
/mnt/YourPool/hyperdeck-config | /app/config | Google Drive credentials |
/mnt/YourPool/Recordings | /mnt/nas | Video recording storage |
Environment Variable
Add one environment variable:
| Name | Value |
|---|---|
PYTHONUNBUFFERED | 1 |
Restart Policy & Install
Set restart policy to Unless Stopped, then click Install. The first install takes 1–3 minutes to pull the Docker image.
5. Activate Your License
Once TrueNAS shows the app as Running, open your browser:
Replace YOUR_TRUENAS_IP with your server's IP address.
Option A: Start a Free Trial
- Enter your email and click Start Free Trial
- Check your email for the license key
- Enter the key and click Activate License
- Full access for 7 days — no credit card required
Option B: Enter a Purchased Key
- Check your purchase confirmation email for your key
- Enter it (format: XXXXX-XXXXX-XXXXX-XXXXX) and click Activate License
Option C: Purchase from the App
- Click Purchase a License — $365/year on the license screen
- Complete checkout on our website
- Your key will be emailed to you
6. Connect HyperDecks & Start Backing Up
Click HyperDecks → + Add HyperDeck → enter a name and IP address → Save → Connect.
Click Jobs → + New Job → set client, event, date, and destinations (NAS, Google Drive, SFTP, USB) → Save.
Click Load Job on your job card, then Start. Files transfer automatically as recordings complete.
7. USB Drive Setup (Optional)
To back up recordings to USB drives, you need to mount them on TrueNAS first.
SSH into your TrueNAS server and run:
Create a mount point and mount:
For ext4/xfs drives:
For NTFS drives (common in video production):
Replace sdX1 with your actual device name from lsblk.
In TrueNAS Apps, edit hyperdeck-backup and add a new Host Path Volume:
| Host Path | Mount Path |
|---|---|
/mnt/usb_drives/drive1 | /mnt/usb/drive1 |
Save — the app will restart with the USB drive accessible. You can add up to 4 USB drives (drive1 through drive4).
8. Troubleshooting
App shows "Running" but web UI won't load
Make sure Host Network is enabled in the app's network settings. Access the app on port 8080 of your TrueNAS IP.
License key says "not found"
Enter the key exactly as emailed (XXXXX-XXXXX-XXXXX-XXXXX). If you just created a trial, wait 30 seconds and try again.
Cannot connect to HyperDeck
Verify the HyperDeck is powered on, on the same network, and remote control is enabled (HyperDeck Settings → Remote).
TZ environment variable error
Remove the TZ variable from environment settings. TrueNAS handles timezone automatically.
Files not transferring
Check the Transfers page for errors. The HyperDeck FTP service may be busy, or the destination storage may be full.
9. Frequently Asked Questions
How many HyperDecks can I connect?
No hard limit. Tested with up to 20 simultaneously. See system requirements above for recommended hardware.
Can I back up to multiple destinations at once?
Yes — each job can back up to NAS, Google Drive, SFTP, and USB drives simultaneously.
What happens when my trial expires?
The app shows the license screen. Your data, settings, and HyperDeck configurations are preserved. Purchase a license to resume.
Can I move my license to another server?
Yes. Go to Settings → License Management → Deactivate This Machine. This releases the slot so you can activate on a new server.
Is my data safe if I reinstall?
Yes, as long as you keep the datasets (hyperdeck-data, hyperdeck-config, Recordings). The app reads from these on startup.
How do I update to a new version?
In TrueNAS Apps, find hyperdeck-backup, click Edit, change the Image Tag to the new version, and save.
Do I need SSH access?
No — except for USB drive mounting. Everything else is through the TrueNAS and app web UIs.
Need Help?
Email: devsupport@entertainmentit.co
Subject: "HyperDeck Issue for [YOUR COMPANY]"
© 2026 Entertainment IT, INC. All rights reserved.