3.1 KiB
unraid-podman
A native Unraid plugin that integrates Podman as a first-class container engine, running alongside Docker.
Status: architecture / scaffolding stage. No functional code has been shipped yet. This repository currently defines the target structure and design; see docs/ARCHITECTURE.md for the full technical plan and docs/ROADMAP.md for what's coming.
Goals
- Run rootful Podman on Unraid with full persistence across reboots (config, images, containers, volumes, networks) despite Unraid's RAM-root design.
- Coexist cleanly with Docker — no shared storage, network, or firewall conflicts.
- Follow Unraid's native conventions:
.plginstallation, Slackware.txzpackages, BSD-stylerc.dinit scripts (no systemd), config on/boot, data on the array/cache. - Provide a WebUI in the Dynamix style once the CLI-driven core is stable.
- Eventually make Docker optional/disable-able once feature parity is reached.
See docs/ARCHITECTURE.md for the full rationale behind every decision below.
Repository structure
.
├── .github/ CI workflows, issue/PR templates, community health files
├── assets/ Icons, screenshots, branding used by the plugin & GUI
├── config/ Default containers/storage/registries config templates
├── docs/ Architecture, install guide, FAQ, troubleshooting, roadmap
├── packages/ Slackware .txz build recipes (podman, conmon, crun, netavark, ...)
├── plugin/ The .plg manifest, rc.d init script, sbin helper scripts,
│ and the default files deployed to /boot/config/plugins/podman
├── scripts/ Build, release, and developer tooling scripts
└── webui/ Dynamix-style WebUI pages (plugins/podman/), added in a later phase
Installation
Not yet available. Once packages and the .plg manifest are published, installation
will be the standard Unraid flow: Plugins → Install Plugin with the .plg URL, or
via the Unraid Community Applications store once listed there.
Documentation
- Architecture — full technical design (directory layout, packaging, init scripts, persistence, networking, autostart, updates, rollback, logging, error handling, future WebUI).
- Roadmap — phased delivery plan.
- Install guide — end-user installation steps (draft).
- Troubleshooting — common problems and diagnostics.
- FAQ
Contributing
Contributions are welcome — see CONTRIBUTING.md for the dev workflow, coding conventions, and how the packaging pipeline works. Please also review our Code of Conduct.
Security
Rootful Podman's API socket is root-equivalent. See SECURITY.md for the vulnerability disclosure process and known security considerations.
License
Licensed under the MIT License.