2022-11-04 20:50:26 +00:00
< p align = "center" >
< br / >
2024-02-12 15:31:59 +00:00
< a href = "https://opensource.org/license/agpl-v3" > < img src = "https://img.shields.io/badge/License-AGPL_v3-blue.svg?color=3F51B5&style=for-the-badge&label=License&logoColor=000000&labelColor=ececec" alt = "License: AGPLv3" > < / a >
2024-06-14 00:27:01 +00:00
< a href = "https://discord.immich.app" >
2023-11-07 18:57:30 +00:00
< img src = "https://img.shields.io/discord/979116623879368755.svg?label=Discord&logo=Discord&style=for-the-badge&logoColor=000000&labelColor=ececec" alt = "Discord" / >
2022-06-12 04:42:28 +00:00
< / a >
2022-03-16 15:19:31 +00:00
< br / >
2022-08-18 13:31:00 +00:00
< br / >
2022-02-03 22:00:14 +00:00
< / p >
2022-11-04 20:50:26 +00:00
< p align = "center" >
2024-03-11 16:16:57 +00:00
< img src = "design/immich-logo-stacked-light.svg" width = "300" title = "Login With Custom URL" >
2022-11-04 20:50:26 +00:00
< / p >
2024-03-17 15:46:42 +00:00
< h3 align = "center" > High performance self-hosted photo and video management solution< / h3 >
2022-11-04 20:50:26 +00:00
< br / >
2022-11-04 20:58:08 +00:00
< a href = "https://immich.app" >
2022-11-04 20:50:26 +00:00
< img src = "design/immich-screenshots.png" title = "Main Screenshot" >
< / a >
< br / >
2022-12-04 04:03:29 +00:00
< p align = "center" >
2024-05-08 04:03:41 +00:00
2024-06-24 14:23:09 +00:00
< a href = "readme_i18n/README_ca_ES.md" > Català< / a >
< a href = "readme_i18n/README_es_ES.md" > Español< / a >
< a href = "readme_i18n/README_fr_FR.md" > Français< / a >
< a href = "readme_i18n/README_it_IT.md" > Italiano< / a >
< a href = "readme_i18n/README_ja_JP.md" > 日本語< / a >
< a href = "readme_i18n/README_ko_KR.md" > 한국어< / a >
< a href = "readme_i18n/README_de_DE.md" > Deutsch< / a >
< a href = "readme_i18n/README_nl_NL.md" > Nederlands< / a >
< a href = "readme_i18n/README_tr_TR.md" > Türkçe< / a >
< a href = "readme_i18n/README_zh_CN.md" > 中文< / a >
< a href = "readme_i18n/README_ru_RU.md" > Русский< / a >
< a href = "readme_i18n/README_pt_BR.md" > Português Brasileiro< / a >
< a href = "readme_i18n/README_sv_SE.md" > Svenska< / a >
< a href = "readme_i18n/README_ar_JO.md" > العربية< / a >
2022-12-04 04:03:29 +00:00
< / p >
2022-12-04 23:15:41 +00:00
2022-11-04 20:50:26 +00:00
## Disclaimer
2022-09-19 21:00:51 +00:00
2022-11-04 20:50:26 +00:00
- ⚠️ The project is under **very active** development.
- ⚠️ Expect bugs and breaking changes.
2023-08-08 18:19:52 +00:00
- ⚠️ **Do not use the app as the only way to store your photos and videos.**
- ⚠️ Always follow [3-2-1 ](https://www.backblaze.com/blog/the-3-2-1-backup-strategy/ ) backup plan for your precious photos and videos!
2022-09-19 21:00:51 +00:00
2024-06-24 14:23:09 +00:00
> [!NOTE]
> You can find the main documentation, including installation guides, at https://immich.app/.
## Links
2022-11-04 20:50:26 +00:00
2024-06-24 14:23:09 +00:00
- [Documentation ](https://immich.app/docs )
- [About ](https://immich.app/docs/overview/introduction )
- [Installation ](https://immich.app/docs/install/requirements )
- [Roadmap ](https://immich.app/roadmap )
2022-11-04 20:50:26 +00:00
- [Demo ](#demo )
2022-08-18 13:31:00 +00:00
- [Features ](#features )
2024-07-02 20:40:51 +00:00
- [Translations ](https://immich.app/docs/developer/translations )
2024-06-24 14:23:09 +00:00
- [Contributing ](https://immich.app/docs/overview/support-the-project )
2022-11-10 14:20:23 +00:00
2022-11-04 20:50:26 +00:00
## Demo
2022-08-07 04:42:50 +00:00
2024-06-24 14:23:09 +00:00
Access the demo [here ](https://demo.immich.app ). The demo is running on a Free-tier Oracle VM in Amsterdam with a 2.4Ghz quad-core ARM64 CPU and 24GB RAM.
2022-08-07 04:42:50 +00:00
2022-11-04 20:50:26 +00:00
For the mobile app, you can use `https://demo.immich.app/api` for the `Server Endpoint URL`
2022-08-07 04:42:50 +00:00
2024-06-24 14:23:09 +00:00
### Login credentials
2022-02-03 21:27:31 +00:00
2024-06-24 14:23:09 +00:00
| Email | Password |
| --------------- | -------- |
| demo@immich.app | demo |
2024-02-08 20:00:21 +00:00
2023-10-29 18:58:26 +00:00
## Features
2022-07-29 18:41:29 +00:00
2023-05-18 14:48:43 +00:00
| Features | Mobile | Web |
2024-06-24 14:23:09 +00:00
| :------------------------------------------- | ------ | --- |
2023-05-18 14:48:43 +00:00
| Upload and view videos and photos | Yes | Yes |
| Auto backup when the app is opened | Yes | N/A |
2024-01-25 17:17:38 +00:00
| Prevent duplication of assets | Yes | Yes |
2023-05-18 14:48:43 +00:00
| 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 |
2023-06-29 20:23:55 +00:00
| Support raw formats | Yes | Yes |
2023-05-18 14:48:43 +00:00
| 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 |
2023-11-14 22:54:06 +00:00
| LivePhoto/MotionPhoto backup and playback | Yes | Yes |
2024-01-25 17:17:38 +00:00
| Support 360 degree image display | No | Yes |
2023-05-18 14:48:43 +00:00
| User-defined storage structure | Yes | Yes |
| Public Sharing | No | Yes |
| Archive and Favorites | Yes | Yes |
2023-09-07 22:40:24 +00:00
| Global Map | Yes | Yes |
2023-06-16 14:39:06 +00:00
| Partner Sharing | Yes | Yes |
2023-06-29 20:23:55 +00:00
| Facial recognition and clustering | Yes | Yes |
| Memories (x years ago) | Yes | Yes |
2023-06-21 18:49:35 +00:00
| Offline support | Yes | No |
2023-06-29 20:23:55 +00:00
| Read-only gallery | Yes | Yes |
2023-11-14 22:54:06 +00:00
| Stacked Photos | Yes | Yes |
2022-07-29 18:41:29 +00:00
2024-06-24 14:23:09 +00:00
## Translations
2024-01-25 17:17:38 +00:00
2024-06-24 14:23:09 +00:00
Read more about translations [here ](https://immich.app/docs/developer/translations ).
< a href = "https://hosted.weblate.org/engage/immich/" >
< img src = "https://hosted.weblate.org/widget/immich/immich/multi-auto.svg" alt = "Translation status" / >
2023-10-29 18:58:26 +00:00
< / a >
2024-02-22 14:05:13 +00:00
2024-06-24 14:23:09 +00:00
## Repository activity
![Activities ](https://repobeats.axiom.co/api/embed/9e86d9dc3ddd137161f2f6d2e758d7863b1789cb.svg "Repobeats analytics image" )
## Star history
2024-02-22 14:05:13 +00:00
2024-03-25 12:20:26 +00:00
< a href = "https://star-history.com/#immich-app/immich&Date" >
< picture >
< source media = "(prefers-color-scheme: dark)" srcset = "https://api.star-history.com/svg?repos=immich-app/immich&type=Date&theme=dark" / >
< source media = "(prefers-color-scheme: light)" srcset = "https://api.star-history.com/svg?repos=immich-app/immich&type=Date" / >
< img alt = "Star History Chart" src = "https://api.star-history.com/svg?repos=immich-app/immich&type=Date" width = "100%" / >
< / picture >
2024-02-22 14:05:13 +00:00
< / a >
2024-06-24 14:23:09 +00:00
## Contributors
< a href = "https://github.com/alextran1502/immich/graphs/contributors" >
< img src = "https://contrib.rocks/image?repo=immich-app/immich" width = "100%" / >
< / a >