# Operate and configure

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

Start with [Quick start](https://sam-dumont.github.io/immich-memories/docs/get-started/quick-start.md) for Basic, GPU or Full beside Immich. Use this section when you need a different deployment or want to manage it over time.

**Diagram: Everything runs on your machine. Nothing leaves your network unless you switch it on.** [(image)](https://sam-dumont.github.io/immich-memories/diagrams/architecture-overview.svg)

```text
┌───────────────────────────┐  ┌──────────────┐
│                           │  │              │
│           Web UI          │  │    FFmpeg    │
│        Daily timer        │  │    Store     │
└─────────────┬─────────────┘  └──────────────┘
              │
              │
              │
              │
              ▼
┌───────────────────────────┐
│      immich-memories      │
└───────────────────────────┘
              │
              │
              ├────────────────────────┬─────────────────────┐
              │                        │                     │
              ▼                        ▼                     ▼
┌───────────────────────────┐  ┌──────────────┐  ┌───────────────────────┐
│           Immich          │  │   GPU box    │  │                       │
│     reads your photos,    │  │ Reader model │  │only what you switch on│
│uploads the film if you ask│  │ACE-Step music│  │                       │
└───────────────────────────┘  └──────────────┘  └───────────┬───────────┘
                                                             │
                                                             │
                                                             │
                                                             │
                                                             │
┌───────────────────────────┐                                │
│        Place names,       │                                │
│         map tiles         │                                │
│           Hosted          │                                │
│           reader          │◄───────────────────────────────┘
│       Notifications       │
│           Model           │
│         downloads         │
└───────────────────────────┘
```

Groups:

- Your network
  - Your machine
    - Web UI Daily timer
    - immich-memories
    - FFmpeg Store
  - Optional, on your own hardware
    - GPU box Reader model ACE-Step music
  - Immich
- The internet: each one off until you turn it on
  - Place names, map tiles Hosted reader Notifications Model downloads

Arrows:

- Web UI Daily timer → immich-memories
- immich-memories → Immich
- immich-memories → GPU box Reader model ACE-Step music
- immich-memories → only what you switch on
- only what you switch on → Place names, map tiles Hosted reader Notifications Model downloads

## Choose a deployment

| Your setup | Start here |
| - | - |
| Docker on a server or desktop | [Docker Compose](https://sam-dumont.github.io/immich-memories/docs/run/docker.md) |
| Synology or Unraid | [On a NAS](https://sam-dumont.github.io/immich-memories/docs/run/nas.md) |
| Python on your own host | [pip / uv](https://sam-dumont.github.io/immich-memories/docs/run/uv-pip.md) |
| Kubernetes cluster | [Kubernetes](https://sam-dumont.github.io/immich-memories/docs/run/kubernetes.md) |
| Infrastructure managed as code | [Terraform](https://sam-dumont.github.io/immich-memories/docs/run/terraform.md) |

[Requirements](https://sam-dumont.github.io/immich-memories/docs/run/requirements.md) explains hardware limits and what extra resources buy you.

Already running the app and ready to move work elsewhere? Choose [one GPU service](https://sam-dumont.github.io/immich-memories/docs/run/reference-setup.md) for a shared NVIDIA worker, [distributed Kubernetes services](https://sam-dumont.github.io/immich-memories/docs/run/reference/cluster-example.md) for independently managed workloads, or [local Apple Silicon services](https://sam-dumont.github.io/immich-memories/docs/run/reference/mac-example.md) for a native Mac installation. Each guide explains what you must provide and what stays on the app host.

For an example of independently managed services, [How I run it](https://sam-dumont.github.io/immich-memories/docs/run/how-i-run-it.md) describes my own setup: the app and one GPU worker on Kubernetes, the reader on a Mac, and what each piece costs.

## Protect access and keep your data

The UI asks for a sign-in by default and generates the first password for you ([where to find it](https://sam-dumont.github.io/immich-memories/docs/run/authentication.md#the-generated-password)). It holds an Immich API key: keep [authentication](https://sam-dumont.github.io/immich-memories/docs/run/authentication.md) on before publishing it to other machines. Run one UI replica.

- [Network and security](https://sam-dumont.github.io/immich-memories/docs/run/network-security.md): bind addresses, proxies and service access.
- [Privacy](https://sam-dumont.github.io/immich-memories/docs/run/privacy.md): what leaves your network and the switches that enable it.
- [Storage and backups](https://sam-dumont.github.io/immich-memories/docs/run/maintenance/storage-backups.md): what to preserve and how to restore it.
- [Database](https://sam-dumont.github.io/immich-memories/docs/run/database.md): SQLite or PostgreSQL for the store.

## Configure and maintain it

Use [Configuration](https://sam-dumont.github.io/immich-memories/docs/run/config-file.md) to understand where settings come from, then look up an individual key in the [config reference](https://sam-dumont.github.io/immich-memories/docs/reference/config-reference.md). [Environment variables](https://sam-dumont.github.io/immich-memories/docs/run/environment-variables.md) are useful for container deployments.

[Upgrading](https://sam-dumont.github.io/immich-memories/docs/run/maintenance/upgrading.md) covers a version change. [Health, logs and caches](https://sam-dumont.github.io/immich-memories/docs/run/maintenance/health-logs-cache.md) covers a service that is slow or not starting.

For optional caption, text or GPU services, start with [Optional upgrades](https://sam-dumont.github.io/immich-memories/docs/better/overview.md). Add them to solve a specific need; the default film does not require them.
