TrueNAS JBOD Enclosure UI is a Docker application for seeing disks in their physical slots. It can show enclosure layout, disk details, storage paths, history, and identify LEDs when the connected system supports them.
It runs on a separate Docker host. Nothing is installed on TrueNAS.
The screenshots use demo data, not a live storage system.
- Shows disks in a physical chassis layout
- Displays model, serial number, size, temperature, health, and path details
- Switches between connected systems and enclosure views
- Saves custom slot mappings and chassis layouts
- Shows pool, controller, SAS, and multipath context when available
- Runs identify LEDs on supported systems
- Adds disk history and change events with the optional history service
- Provides setup, backup, restore, and maintenance tools in the optional admin UI
- Exposes health and Prometheus-compatible metrics endpoints
The built-in profiles cover hardware that has been tested with the project:
- TrueNAS CORE and SCALE
- Generic Linux storage hosts
- VMware ESXi
- OSNexus QuantaStor
- Supermicro BMC and IPMI inventory
- UniFi UNVR and UNVR Pro
Support varies by platform. Some systems provide inventory only, while others also provide SMART data, path details, or LED control. See the platform guides for tested hardware and setup notes.
You need Docker Compose, the URL of your TrueNAS system, and a TrueNAS API key.
mkdir -p /docker-local/truenas-jbod-ui && cd /docker-local/truenas-jbod-ui
curl -fsSL -o compose.yaml https://raw.githubusercontent.com/gcs8/truenas-jbod-ui/v0.22.2/docker-compose.yml
cat > .env <<'EOF'
JBOD_UI_IMAGE=ghcr.io/gcs8/truenas-jbod-ui:v0.22.2
TRUENAS_HOST=https://truenas.example.test
TRUENAS_API_KEY=replace-with-your-api-key
TRUENAS_PLATFORM=core
TRUENAS_VERIFY_SSL=false
EOF
docker compose up -dReplace the example URL and API key before starting. Use scale instead of
core when connecting to TrueNAS SCALE.
Open http://your-docker-host:8080.
TRUENAS_VERIFY_SSL=false skips certificate verification so systems with a
self-signed certificate work on the first launch. After the app is working, you
can enable certificate verification by following
Advanced configuration.
The default setup has no login. Anyone who can reach the published port can use the controls available in that service. Do not publish the ports directly to the Internet. Browser mutations must come from the same origin automatically. Built-in authentication and explicit public-origin settings are optional.
For a slower walkthrough with health checks and troubleshooting, use the Quick Start guide.
Change JBOD_UI_IMAGE in the existing .env to the target release tag or
immutable digest, then run docker compose pull and docker compose up -d.
Keep your existing Compose files and pass the same -f files and selected
profiles to both commands so optional history is updated too. Do not activate
stopped admin or backup services just to update the UI.
See the update and rollback steps. Optional hardening is separate from an image update; retain any hardening already chosen.
The main UI works by itself. Start history for charts and saved disk events:
docker compose --profile history up -dStart the admin UI for guided setup, profile editing, backup and restore, or container controls:
docker compose --profile admin up -d enclosure-adminThe backup scheduler and Backups page are not in a released deployment yet. In a
current-source checkout using its matching image and Compose file, the backup-scheduler profile
is off by default; start it with --profile backup-scheduler. It creates encrypted config
backups after changes and scheduled full backups only after you enable those two classes in the backup policy; it can then copy them to filesystem,
FTP/FTPS, SFTP, SMB, NFS, or S3. The admin
Backups page
can run and manage backups. A restore inspects the exact archive and asks for
confirmation before import. Local and remote retention are configured independently.
New full backups use encrypted tar.zst by default, and existing .7z backups remain readable.
- Add
docker-compose.backup-nfs.ymlonly for NFS targets. - Add
docker-compose.history-bind.ymlwhen a v0.22.2 deployment publishes history on a non-loopback address during an image-only update.
Default ports are Main UI 8080, history service 8081, and admin UI 8082.
- Quick Start
- Docker deployment
- TrueNAS CORE setup
- TrueNAS SCALE setup
- SSH setup
- Admin UI
- Backup, restore, and debug bundles
- Upgrading
- Troubleshooting
- All documentation
- Hardware outside the tested profiles may need a custom layout.
- ESXi integration is read-only.
- The IPMI path is focused on tested Supermicro systems.
- Full ESXi drive details require StorCLI on the host.
MIT. See LICENSE.

