Home

Welcome to the UndockerUI wiki!

UndockerUI Wiki

UndockerUI is an improved Docker UI for Unraid compared to the built-in Docker page—same Docker engine and GraphQL backend, with a denser table, richer details, compose-from-the-browser, and dedicated logs/update windows.

This wiki covers how the project fits into Unraid, how to install it, and how to use every part of the UI.

Repository: romwil/undockerui

---

Start here

If you want to…	Read
Understand what UndockerUI is and why it exists	Overview
Know hardware/software requirements	Requirements
Install or upgrade the plugin on Unraid	Installation
Open the app and orient yourself	First run
Use the table, filters, menus, and details	Using the UI
Work with Compose files from the browser	Compose workspace
Use logs windows and container image updates	Logs and updates
See how the pieces connect (SPA, GraphQL, PHP)	Architecture
Obtain Unraid API keys & enable GraphQL	Unraid API and keys
Tune dev environment or .env	Configuration
Understand trust boundaries and reporting issues	Security
Fix common problems	Troubleshooting
Quick questions	FAQ
Build from source or contribute	Development

---

Insights (design choices)

• Same session as Unraid — UndockerUI is not a separate login; it uses your Unraid browser session and CSRF token, like the stock Docker page.
• GraphQL for Docker — Container list, lifecycle, logs, autostart, and image updates go through Unraid’s official GraphQL API so behavior stays aligned with the OS.
• PHP only for Compose file I/O — Reading/writing YAML and running docker compose up -d use a small compose_api.php endpoint with strict path rules and CSRF, because those operations are not exposed the same way through GraphQL in typical setups.
• Iframe on purpose — The plugin page loads the SPA in an iframe so the bundle can live under /plugins/undockerui/dist/ while still inheriting cookies and same-origin access to /graphql and the compose API.
• Icons from Docker labels — When GraphQL does not return iconUrl, UndockerUI reads net.unraid.docker.icon / org.unraid.docker.icon from container labels (same source as Unraid’s Docker client).
• Unraid API keys are for dev / automation — The plugin on the NAS uses your normal login session. API keys and Settings → Management Access options matter when you develop from another machine; see Unraid API and keys.