summaryrefslogtreecommitdiff
path: root/immich/README.md
diff options
context:
space:
mode:
authorTyler Hoang <tyler@tylerhoang.xyz>2026-07-09 21:49:56 -0700
committerTyler Hoang <tyler@tylerhoang.xyz>2026-07-09 21:49:56 -0700
commit1d043702ef136e8f2e516c5304a57be5718f1f6f (patch)
tree9b3ad070f11dad5994c58acd41a15db8043745aa /immich/README.md
Initial commit: docker compose files for all self-hosted servicesHEADmaster
12 services: adguard, ampache, azuracast, flood, glance, glances, grafana, immich, invidious, jellyfin, openwebui, watchtower Each service includes a docker-compose.yml, README.md with setup instructions, and .env.example where applicable.
Diffstat (limited to 'immich/README.md')
-rw-r--r--immich/README.md31
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.