70 lines
3.1 KiB
Markdown
70 lines
3.1 KiB
Markdown
# unraid-podman
|
|
|
|
A native [Unraid](https://unraid.net/) plugin that integrates [Podman](https://podman.io/)
|
|
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](docs/ARCHITECTURE.md) for the full technical plan and
|
|
> [docs/ROADMAP.md](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: `.plg` installation, Slackware `.txz` packages,
|
|
BSD-style `rc.d` init 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](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](docs/ARCHITECTURE.md) — full technical design (directory layout,
|
|
packaging, init scripts, persistence, networking, autostart, updates, rollback,
|
|
logging, error handling, future WebUI).
|
|
- [Roadmap](docs/ROADMAP.md) — phased delivery plan.
|
|
- [Install guide](docs/INSTALL.md) — end-user installation steps (draft).
|
|
- [Troubleshooting](docs/TROUBLESHOOTING.md) — common problems and diagnostics.
|
|
- [FAQ](docs/FAQ.md)
|
|
|
|
## Contributing
|
|
|
|
Contributions are welcome — see [CONTRIBUTING.md](CONTRIBUTING.md) for the dev
|
|
workflow, coding conventions, and how the packaging pipeline works. Please also
|
|
review our [Code of Conduct](.github/CODE_OF_CONDUCT.md).
|
|
|
|
## Security
|
|
|
|
Rootful Podman's API socket is root-equivalent. See
|
|
[SECURITY.md](.github/SECURITY.md) for the vulnerability disclosure process and
|
|
known security considerations.
|
|
|
|
## License
|
|
|
|
Licensed under the [MIT License](LICENSE).
|