# Unraid

Markdown version of <https://sam-dumont.github.io/immich-memories/docs/run/platforms/unraid/>.

Use the native Docker template for Basic, or the Compose Manager route below for any tier. The app
needs its own 4 GiB of memory beside Immich. [Tested deployments](https://sam-dumont.github.io/immich-memories/docs/run/tested-deployments.md) lists
the platforms that were run end to end.

## Native Docker template

Each release publishes an Unraid XML template in the Community Applications format. It is not in
the Community Applications catalog, so install it from the terminal.

In Unraid's **Terminal** in the browser, install the unconfigured template:

**Install the v1.0.0 template:**

```bash
mkdir -p /boot/config/plugins/dockerMan/templates-user
curl --fail --location "https://github.com/sam-dumont/immich-memories/releases/download/v1.0.0/immich-memories.xml" -o /boot/config/plugins/dockerMan/templates-user/my-immich-memories.xml
```

Open **Docker → Add Container**, select **immich-memories** from **Template**, and fill in the required Immich URL and API key. The template names a released app version. To use another one, set **Repository** to `ghcr.io/sam-dumont/immich-memories:X.Y.Z`, replacing `X.Y.Z` with that version (no `v` prefix).

Choose persistent host directories for configuration/models and finished films. They must be writable by UID/GID 1000; allow about 25 GB plus 0.35 GB per 1,000 pictures for state, plus films. Do not change permissions on an entire existing share. Set **Settings encryption key** to a random secret of at least 32 characters if you want to save credentials in Settings, and retain it across upgrades.

Keep **Network Type: Bridge** and the existing **Extra Parameters**. Its `--publish=127.0.0.1:22830:8080/tcp` mapping is deliberately private. There is no separate port entry. Sign-in is on either way: leave **UI username** and **UI password** empty to get a generated password in the container log (the log icon), or fill both. For direct LAN access, change the mapping to `--publish=0.0.0.0:22830:8080/tcp`. Choose another host port if 22830 is taken. Host networking bypasses it. The Unraid admin login does not protect the app.

Set film language after startup in [Settings](https://sam-dumont.github.io/immich-memories/docs/get-started/after-install.md).

Click **Apply**, then continue at [Open the app and download models](#3-prepare-and-check). A configured template contains your API key: do not share it.

## Compose Manager alternative

## 1. Open Compose Manager

Enable Docker in Unraid and install [Docker Compose Manager from Community Applications](https://ca.unraid.net/apps/docker-compose-manager-0mgvgou04hjv2a). Open its stack manager and add a stack named `immich-memories`. Compose Manager versions differ: the [maintainer's guide](https://github.com/mstrhakr/compose_plugin/blob/main/docs/getting-started.md) documents **Docker → Compose → Add Stack** for that fork.

## 2. Paste and start

Choose Basic, GPU or Full and enter your connection details below. GPU/Full need an NVIDIA host with the Container Toolkit or a separate GPU box; Full also needs a reader. Copy the generated `docker-compose.yml` into the stack's Compose editor and replace `replace-with-your-immich-api-key` with your [scoped Immich key](https://sam-dumont.github.io/immich-memories/docs/run/docker.md#the-api-key). For Full, replace the reader-key placeholder too, or empty it if that server does not require one. Configure access below, then save and use the manager's **Compose Up** action. This file needs no separate `.env`.

The setup builder on [the HTML page](https://sam-dumont.github.io/immich-memories/docs/run/platforms/unraid/) generates the setup files for your choices in the browser. Pick a platform, a tier and the options there; nothing is sent anywhere.

Keep **Single file for a stack editor** selected. The generated file includes a Settings
encryption key; keep it with your backups and restrict access after adding your API keys.

Docker-managed volumes retain settings, prepared facts and films across container replacement.
Download films through the app. To use a NAS share instead, follow
[folder permissions](https://sam-dumont.github.io/immich-memories/docs/run/nas.md#the-output-folder) before changing the output mount.

For GPU/Full on this NVIDIA host, select **Use NVIDIA CUDA containers**. For a separate worker,
fill in **GPU box address** and start the provided worker files on that machine first.

The app asks for a sign-in either way. To open it to your trusted LAN, tick **Open the UI to
other machines on my LAN** in the builder above. Leave the login empty to get a generated password
(read it with `docker logs immich-memories` or in the container's log view), or enter a username
and a password of at least 12 characters and the generated file carries them.

To do it by hand, edit the lines the file already has. Do not add a second copy: Compose refuses a
file that defines the same key twice. To pick your own login, change the two empty values under the
app service's `environment:` block:

```yaml
IMMICH_MEMORIES_AUTH_USERNAME: admin
IMMICH_MEMORIES_AUTH_PASSWORD: replace-with-your-own-long-password
```

The password needs at least 12 characters. To publish the port, in the same service's `ports:` change
`127.0.0.1:22830:8080` to `0.0.0.0:22830:8080`. If the host already uses 22830, choose another host
port, for example `0.0.0.0:22831:8080`. The last number remains 8080.

This is the app's login; the container manager's account does not protect this port. These
settings use HTTP on your LAN. For HTTPS or private access through localhost, use the
[other access routes](https://sam-dumont.github.io/immich-memories/docs/run/docker.md#reaching-the-ui-from-another-machine).

## 3. Open the app and download models

Open `http://your-server-address:22830` (or your chosen host port) and sign in with the
login you set, or with the generated password from the container log. With private localhost
access, use the forwarded URL instead.

On **Memory**, click **Download models** and wait for it to finish. The card lists the files and
download hosts; it disappears when the required files are ready. If it is absent and no error is
shown, those files are already present. Downloads are kept on the config volume for later starts.

## 4. Check and make a film

**Basic:** continue to [your first film](https://sam-dumont.github.io/immich-memories/docs/get-started/first-film.md).

**GPU and Full:** the browser download does not check the external model services. On the **Docker** tab, click the `immich-memories` container icon and select **Console**. The template selects `sh`.
Run:

```bash
immich-memories preflight
```

This runs inside the app container, so do not add `docker exec`. Wait for inference and captions
(and the Full reader) to become ready, and resolve any required-service or storage errors before
making [your first film](https://sam-dumont.github.io/immich-memories/docs/get-started/first-film.md). Optional upload permissions can warn
while still allowing local films.

[Installation help](https://sam-dumont.github.io/immich-memories/docs/reference/installation-help.md) covers connection, port, permission and
startup errors. It also gives the CLI model-download command if you need it.
