summaryrefslogtreecommitdiff
path: root/immich/README.md
blob: 788372af77bc2909ba6ae6ebae523b483f0254fd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# Immich

Self-hosted photo and video management solution.

## Setup

1. Copy `.env.example` to `.env`:
   ```
   cp .env.example .env
   ```

2. Edit `.env`:
   - Set `DB_PASSWORD` to a secure random string.
   - Set `UPLOAD_LOCATION` to where you want photos stored.
   - Set `DB_DATA_LOCATION` to where you want the database stored (avoid network shares).
   - Set `TZ` to your timezone.

3. Start:
   ```
   docker compose up -d
   ```

## Access

- Web UI: `http://<host>:2283`

## What to Configure

- **`.env`** — All primary configuration lives here. See the [Immich docs](https://docs.immich.app/install/environment-variables) for all options.
- **Hardware acceleration** — Uncomment the `extends` sections in `docker-compose.yml` for transcoding/ML hardware acceleration.
- **`backup.sh`** — Example borg backup script for database and photo backups. Edit the paths and remote host to match your setup before using.