diff options
Diffstat (limited to 'immich/README.md')
| -rw-r--r-- | immich/README.md | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/immich/README.md b/immich/README.md new file mode 100644 index 0000000..788372a --- /dev/null +++ b/immich/README.md @@ -0,0 +1,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. |