Skip to content
 
 

Latest commit

 

History

10,831 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation


License: AGPLv3 Discord

High performance self-hosted photo and video management solution



Català Español Français Italiano 日本語 한국어 Deutsch Nederlands Türkçe 简体中文 正體中文 Українська Русский Български Português Brasileiro Svenska العربية Tiếng Việt ภาษาไทย മലയാളം

Warning

⚠️ Always follow 3-2-1 backup plan for your precious photos and videos!

Note

You can find the main documentation, including installation guides, at https://immich.app/.

This fork

This is mguptahub/immich, a fork of immich-app/immich that adds S3-compatible object storage as an alternative to local disk. Set STORAGE_PROVIDER=s3 and the matching S3_* variables (see docker/example.env) to store uploaded photos/videos, thumbnails, encoded video, profile images, and database backups in a bucket — AWS S3, MinIO, Backblaze B2, Cloudflare R2, or anything else that speaks the S3 API — instead of the local UPLOAD_LOCATION volume. Everything else about Immich works the same; external/watched libraries always stay on local disk.

For local testing, docker/docker-compose.dev.yml includes an optional MinIO service (docker compose -f docker-compose.dev.yml --profile s3 up).

Custom development happens on the production branch; main stays a clean mirror of upstream. Published Docker images are built from production and tagged releases — see Releases.

Quick start (production, no clone required)

Every release attaches a ready-to-use docker-compose.prod.yml and example.env. Download the latest release's copies and bring the stack up directly — no need to clone this repo:

mkdir immich-app && cd immich-app

curl -fsSL -O https://github.com/mguptahub/immich/releases/latest/download/docker-compose.prod.yml
curl -fsSL -o .env https://github.com/mguptahub/immich/releases/latest/download/example.env

# Edit .env: set DB_PASSWORD and UPLOAD_LOCATION, and uncomment the
# STORAGE_PROVIDER/S3_* lines if you want S3-compatible storage instead of local disk.

docker compose -f docker-compose.prod.yml up -d

To pin a specific release instead of always tracking latest, swap releases/latest/download for releases/download/<tag> (e.g. releases/download/v3.1.0-mgh-1/docker-compose.prod.yml) and set IMMICH_SERVER_IMAGE_TAG in .env to match.

Links

Demo

Access the demo here. For the mobile app, you can use https://demo.immich.app for the Server Endpoint URL.

Login credentials

Email Password
demo@immich.app demo

Features

Features Mobile Web
Upload and view videos and photos Yes Yes
Auto backup when the app is opened Yes N/A
Prevent duplication of assets Yes Yes
Selective album(s) for backup Yes N/A
Download photos and videos to local device Yes Yes
Multi-user support Yes Yes
Album and Shared albums Yes Yes
Scrubbable/draggable scrollbar Yes Yes
Support raw formats Yes Yes
Metadata view (EXIF, map) Yes Yes
Search by metadata, objects, faces, and CLIP Yes Yes
Administrative functions (user management) No Yes
Background backup Yes N/A
Virtual scroll Yes Yes
OAuth support Yes Yes
API Keys N/A Yes
LivePhoto/MotionPhoto backup and playback Yes Yes
Support 360 degree image display No Yes
User-defined storage structure Yes Yes
Public Sharing Yes Yes
Archive and Favorites Yes Yes
Global Map Yes Yes
Partner Sharing Yes Yes
Facial recognition and clustering Yes Yes
Memories (x years ago) Yes Yes
Offline support Yes No
Read-only gallery Yes Yes
Stacked Photos Yes Yes
Tags No Yes
Folder View Yes Yes

Translations

Read more about translations here.

Translation status

Repository activity

Activities

Star history

Star History Chart

Contributors

About

High performance self-hosted photo and video management solution.

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages