# Immich

Deploy Immich photo management platform using Docker Compose.

## Description

Immich is a self-hosted photo and video backup solution with mobile apps, AI features, and automatic organization. Includes web server, machine learning, PostgreSQL database, and Redis.

## Variables

### Required (Set in Vault)

| Variable | Description |
|----------|-------------|
| `immich_db_password` | PostgreSQL database password (use only A-Za-z0-9 characters) |

### Optional

| Variable | Default | Description |
|----------|---------|-------------|
| `immich_http_port` | `2283` | Web interface port |
| `immich_library_path` | `{{ app_dir }}/library` | Photo and video upload storage location |
| `immich_pgdata_path` | `{{ app_dir }}/pgdata` | PostgreSQL database storage location |
| `immich_container_version` | `v2` | Immich version tag (can pin to specific version like "v2.1.0") |
| `immich_container_name` | `{{ app_name }}` | Container name |
| `immich_restart_policy` | `{{ app_restart_policy }}` | Container restart policy |
| `immich_timezone` | `{{ app_timezone }}` | Container timezone |

## Example

```yaml
- role: patrickj.docker_apps.immich
  vars:
    immich_db_password: "{{ vault_immich_db_password }}"
    immich_library_path: /storage/photos
    immich_container_version: "v2.1.0"
```