# Installation Guide (draft)

> This guide is a placeholder. Nothing described here is functional yet — the
> project is at the architecture/scaffolding stage. See
> [ARCHITECTURE.md](ARCHITECTURE.md) and [ROADMAP.md](ROADMAP.md).

## Planned installation flow

Once a release exists, installation will follow standard Unraid conventions:

1. In the Unraid WebUI, go to **Plugins → Install Plugin**.
2. Paste the `.plg` URL (or install via Community Applications, once listed).
3. Unraid downloads and runs `podman.plg`, which:
   - installs the Slackware `.txz` packages under `packages/`,
   - stages default configuration under `/boot/config/plugins/podman/`,
   - registers the boot hook in `/boot/config/go`,
   - starts the Podman service for the first time.

## Planned requirements

- Unraid version: TBD minimum (depends on kernel/cgroup v2 requirements — see
  [ARCHITECTURE.md, section 5.3](ARCHITECTURE.md#53-abhängigkeitsprüfung)).
- A cache pool (recommended) or a dedicated array disk path for
  `podman.img` — see [ARCHITECTURE.md, section 4.3](ARCHITECTURE.md#43-persistente-nutzdaten-cache-pool-bevorzugt-array-als-fallback).
- Sufficient free space on that pool/disk for the container storage image.

## Uninstallation (planned)

Removing the plugin removes the installed packages and init hooks but
**preserves** data under `/mnt/*/system/podman/` and
`/boot/config/plugins/podman/` by default. A separate, explicit option will be
provided for full data removal.

## Verifying the installation (planned)

```sh
rc.podman status
podman info
```