Unraid

Use the native Docker template for the Basic setup, or the Compose Manager alternative below. The app needs its own 4 GiB memory budget alongside Immich. These steps follow the Compose Manager documentation; a recorded installation on Unraid is still pending.

Not yet tested on Unraid

We have not tested these steps on this platform. Local template, manifest and browser checks do not establish a tested installation. Please report your results, including platform/app versions and whether preflight and the first film worked. The deployment matrix tracks status by platform.

Native Docker template

Download the Unraid XML template. This is a distributable Community Applications format template; it is not yet listed in the Community Applications catalog.

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

mkdir -p /boot/config/plugins/dockerMan/templates-user
curl --fail --location https://raw.githubusercontent.com/sam-dumont/immich-memories/main/deploy/unraid/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. Choose the published image tag in Repository if pinning a release. The default image is latest, matching the standalone Compose file.

Choose persistent host directories for configuration/models and finished films. They must be writable by UID/GID 1000; allow at least 25 GB 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:8080:8080/tcp mapping is deliberately private. There is no separate port entry. For direct LAN access, set both UI username and UI password before changing this mapping. Host networking bypasses it. The Unraid admin login does not protect the app.

title_screens.locale: auto follows the host's LANG, but the container sets none, so a film always renders in English until you set title_screens.locale: fr (or add a LANG: fr_FR.UTF-8 variable to the template) for a French one.

Click Apply, then use the container console instructions below to fetch models and check readiness. No SSH is needed for these steps. 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. Open its stack manager and add a stack named immich-memories. Compose Manager versions differ: the maintainer's guide documents Docker → Compose → Add Stack for that fork.

2. Paste and start

Enter your connection details below. Copy the generated docker-compose.yml into the stack's Compose editor, save, and use the manager's Compose Up action. This file needs no separate .env.

Setup files for docs build v1.0.0-rc.1. The app image and release assets use this same version.

Immich URLImmich API keyUI host portChoose a free port if another app already uses 8080. The UI stays localhost-only.

Create a key with the ten required read permissions. Add the five upload permissions only to send films back; asset.delete is optional. Avoid the All preset.

Choose a tier

BasicA complete film from metadata and small classifiers.GPUPicture descriptions, intent and extra sharing checks.FullA text reader refines the draft and writes titles.

Single file for a stack editorIncludes your credentials and a browser-generated settings key. Store the downloaded file privately.

Can I run this? Check the version and topology matrix.

Not yet tested as an end-to-end generated installation on Linux Docker Compose. Files are checked with Compose/Kustomize and the form is checked in a browser. Those checks do not run this installation. Earlier NAS, Mac and GPU Kubernetes checks are recorded in the measured results. Tried it? Report your platform, release and preflight result.

Your choices produce files in this browser. Nothing is sent to an Immich or model server.

Enter your Immich API key.

Keep Single file for a stack editor selected. Enter the Immich address your container can reach and its API key. The generated file includes a private Settings encryption key; keep the download with your backups. No .env file or hand-written YAML is needed.

The default Basic setup needs no separate model service. Set your home, people and optional service URLs in Settings. The config and output volumes keep settings, cached facts and films across container replacement. Download films through the app or enable upload-back. Include both volumes and the encryption key in your backups.

To keep films in a NAS share instead, replace the generated output volume mount with an absolute host path after creating that folder and giving UID/GID 1000 write access. See NAS folder permissions. That storage change is optional; the generated file works with its named volumes.

3. Prepare and check

On the Docker tab, click the immich-memories container icon and select Console. The template selects sh. Run these commands inside that console:

immich-memories models fetch
immich-memories preflight

These are container commands: do not add docker exec. Fix reported connection or storage errors before making a film. See Unraid's container controls.

4. Open the app

From your computer, tunnel to the Unraid host:

Use the Private UI access command generated above; it uses your selected UI port. Replace your-ssh-user@your-host with your NAS login and address.

Open the localhost URL shown by the builder and make your first film. For direct LAN access, enable authentication before changing the port binding. If 8080 is occupied, choose a different UI host port in the builder.