# Immich
This was created following the [Docker Compose installation guide](https://docs.immich.app/install/docker-compose/).

**WARNING**: must use `docker compose`. Does not work with older `docker-compose` script.

1. Edit `docker-compose.yml` to set directories and a database password.
2. Create directories needed: library, database, model-cache
3. Run docker compose, create admin account, change instance settings before
   uploading!

## Major Version Upgrades / Breaking Changes
Check the official docs: https://docs.immich.app/install/upgrading/