Immich Distribution is an independent community project that packages Immich as a snap. It bundles the Immich server, machine learning, a database, and supporting services into a single installable package with automatic updates. Extra tools for backup, restore, file sync, and HTTPS are included but optional.
This project is not affiliated with the upstream Immich project, its developers, or FUTO. If you prefer the official Docker-based installation, see the upstream docs. Please only report bugs upstream if they also occur in the official images.
sudo snap install immich-distribution
Open http://<your-server-ip> in your browser to complete setup. For detailed installation instructions, including hardware requirements and configuration, see the installation guide.
| Component | Description |
|---|---|
| Immich Server | API, microservices, and web interface |
| Immich Machine Learning | Object detection and image classification |
| PostgreSQL | Relational database |
| Redis | Key-value store for caching and job queues |
| HAProxy | Reverse proxy for HTTP/HTTPS traffic |
| lego | Let's Encrypt ACME client for TLS certificates |
| Sync Service | Two-way folder synchronization with Immich |
| Backup & Restore | Database and asset backup tools |
Configure the snap with snap set and snap get:
# Enable HTTPS with Let's Encrypt
sudo snap set immich-distribution acme-domain=photos.example.com acme-email=you@example.com
# Enable daily database backups
sudo snap set immich-distribution backup-database-daily=trueSee the configuration documentation for all available options.
All commands are available as immich-distribution.<command>:
| Command | Description |
|---|---|
immich-admin |
Immich server administration CLI |
backup |
Back up database and/or assets |
restore |
Restore from a backup |
psql |
PostgreSQL client |
lets-encrypt |
Initialize Let's Encrypt certificate setup |
Full documentation at immich-distribution.nsg.cc.
All files in this repository are released under the MIT license. Upstream Immich was also licensed under MIT but changed to AGPLv3 after 2024-02-12.
