2022-11-04 13:50:26 -07:00
< p align = "center" >
< br / >
2022-03-16 08:19:31 -07:00
< a href = "https://opensource.org/licenses/MIT" > < img src = "https://img.shields.io/badge/license-MIT-green.svg?color=3F51B5&style=for-the-badge&label=License&logoColor=000000&labelColor=ececec" alt = "License: MIT" > < / a >
2022-06-29 21:50:24 -07:00
< a href = "https://discord.gg/D8JsnBEuKb" >
2023-11-07 11:57:30 -07: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-11 21:42:28 -07:00
< / a >
2022-03-16 08:19:31 -07:00
< br / >
2022-08-18 06:31:00 -07:00
< br / >
2022-02-03 15:00:14 -07:00
< / p >
2022-11-04 13:50:26 -07:00
< p align = "center" >
< img src = "design/immich-logo.svg" width = "150" title = "Login With Custom URL" >
< / p >
< h3 align = "center" > Immich - High performance self-hosted photo and video backup solution< / h3 >
< br / >
2022-11-04 13:58:08 -07:00
< a href = "https://immich.app" >
2022-11-04 13:50:26 -07:00
< img src = "design/immich-screenshots.png" title = "Main Screenshot" >
< / a >
< br / >
2022-12-03 21:03:29 -07:00
< p align = "center" >
2023-07-06 15:28:59 -07:00
< a href = "README_ca_ES.md" > Català< / a >
2023-08-02 04:51:08 -07:00
< a href = "README_es_ES.md" > Español< / a >
2023-09-07 23:48:39 -07:00
< a href = "README_fr_FR.md" > Français< / a >
2023-10-19 16:10:32 -07:00
< a href = "README_it_IT.md" > Italiano< / a >
2023-11-19 20:10:59 -07:00
< a href = "README_ja_JP.md" > 日本語< / a >
< a href = "README_ko_KR.md" > 한국어< / a >
2023-11-22 05:49:01 -07:00
< a href = "README_de_DE.md" > Deutsch< / a >
2023-11-19 20:10:59 -07:00
< a href = "README_nl_NL.md" > Nederlands< / a >
< a href = "README_tr_TR.md" > Türkçe< / a >
< a href = "README_zh_CN.md" > 中文< / a >
2022-12-03 21:03:29 -07:00
< / p >
2022-12-04 16:15:41 -07:00
2022-11-04 13:50:26 -07:00
## Disclaimer
2022-09-19 14:00:51 -07:00
2022-11-04 13:50:26 -07:00
- ⚠️ The project is under **very active** development.
- ⚠️ Expect bugs and breaking changes.
2023-08-08 11:19:52 -07: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 14:00:51 -07:00
2022-08-18 06:31:00 -07:00
## Content
2022-11-04 13:50:26 -07:00
2022-12-21 14:01:50 -07:00
- [Official Documentation ](https://immich.app/docs )
2022-12-27 13:28:25 -07:00
- [Roadmap ](https://github.com/orgs/immich-app/projects/1 )
2022-11-04 13:50:26 -07:00
- [Demo ](#demo )
2022-08-18 06:31:00 -07:00
- [Features ](#features )
2022-11-04 13:58:08 -07:00
- [Introduction ](https://immich.app/docs/overview/introduction )
2022-12-21 14:01:50 -07:00
- [Installation ](https://immich.app/docs/install/requirements )
- [Contribution Guidelines ](https://immich.app/docs/overview/support-the-project )
2022-11-04 13:50:26 -07:00
- [Support The Project ](#support-the-project )
2022-02-03 14:27:31 -07:00
2022-11-10 07:20:23 -07:00
## Documentation
You can find the main documentation, including installation guides, at https://immich.app/.
2022-11-04 13:50:26 -07:00
## Demo
2022-08-06 21:42:50 -07:00
2022-11-04 13:50:26 -07:00
You can access the web demo at https://demo.immich.app
2022-08-06 21:42:50 -07:00
2022-11-04 13:50:26 -07:00
For the mobile app, you can use `https://demo.immich.app/api` for the `Server Endpoint URL`
2022-08-06 21:42:50 -07:00
2022-11-04 13:50:26 -07:00
```bash title="Demo Credential"
The credential
email: demo@immich.app
password: demo
2022-02-19 21:42:10 -07:00
```
2022-02-03 14:27:31 -07:00
2022-08-06 21:42:50 -07:00
```
2022-11-04 13:50:26 -07:00
Spec: Free-tier Oracle VM - Amsterdam - 2.4Ghz quad-core ARM64 CPU, 24GB RAM
2022-07-13 05:23:48 -07:00
```
2022-03-12 11:37:04 -07:00
2023-10-29 11:58:26 -07:00
## Features
2022-07-29 11:41:29 -07:00
2023-05-18 07:48:43 -07:00
| Features | Mobile | Web |
| -------------------------------------------- | ------ | --- |
| Upload and view videos and photos | Yes | Yes |
| Auto backup when the app is opened | Yes | N/A |
| 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 13:23:55 -07:00
| Support raw formats | Yes | Yes |
2023-05-18 07:48:43 -07: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 15:54:06 -07:00
| LivePhoto/MotionPhoto backup and playback | Yes | Yes |
2023-05-18 07:48:43 -07:00
| User-defined storage structure | Yes | Yes |
| Public Sharing | No | Yes |
| Archive and Favorites | Yes | Yes |
2023-09-07 15:40:24 -07:00
| Global Map | Yes | Yes |
2023-06-16 07:39:06 -07:00
| Partner Sharing | Yes | Yes |
2023-06-29 13:23:55 -07:00
| Facial recognition and clustering | Yes | Yes |
| Memories (x years ago) | Yes | Yes |
2023-06-21 11:49:35 -07:00
| Offline support | Yes | No |
2023-06-29 13:23:55 -07:00
| Read-only gallery | Yes | Yes |
2023-11-14 15:54:06 -07:00
| Stacked Photos | Yes | Yes |
2022-07-29 11:41:29 -07:00
2023-10-29 11:58:26 -07:00
## Support the project
2022-07-29 11:41:29 -07:00
2022-11-04 13:50:26 -07:00
I've committed to this project, and I will not stop. I will keep updating the docs, adding new features, and fixing bugs. But I can't do it alone. So I need your help to give me additional motivation to keep going.
2022-04-29 11:10:42 -07:00
2022-11-04 13:50:26 -07:00
As our hosts in the [selfhosted.show - In the episode 'The-organization-must-not-be-name is a Hostile Actor' ](https://selfhosted.show/79?t=1418 ) said, this is a massive undertaking of what the team and I are doing. And I would love to someday be able to do this full-time, and I am asking for your help to make that happen.
2022-03-12 11:37:04 -07:00
2022-11-04 13:50:26 -07:00
If you feel like this is the right cause and the app is something you are seeing yourself using for a long time, please consider supporting the project with the option below.
2022-03-12 11:37:04 -07:00
2023-10-29 11:58:26 -07:00
### Donation
2022-02-05 23:23:45 -07:00
2022-11-04 13:50:26 -07:00
- [Monthly donation ](https://github.com/sponsors/alextran1502 ) via GitHub Sponsors
2023-02-27 21:05:22 -07:00
- [One-time donation ](https://github.com/sponsors/alextran1502?frequency=one-time&sponsor=alextran1502 ) via GitHub Sponsors
2024-01-06 11:31:10 -07:00
- [Liberapay ](https://liberapay.com/alex.tran1502/ )
2023-01-25 09:07:58 -07:00
- [buymeacoffee ](https://www.buymeacoffee.com/altran1502 )
- Bitcoin: 1FvEp6P6NM8EZEkpGUFAN2LqJ1gxusNxZX
2023-11-16 08:36:35 -07:00
- ZCash: u1smm4wvqegcp46zss2jf5xptchgeczp4rx7a0wu3mermf2wxahm26yyz5w9mw3f2p4emwlljxjumg774kgs8rntt9yags0whnzane4n67z4c7gppq4yyvcj404ne3r769prwzd9j8ntvqp44fa6d67sf7rmcfjmds3gmeceff4u8e92rh38nd30cr96xw6vfhk6scu4ws90ldzupr3sz
2023-10-29 11:58:26 -07:00
## Contributors
< a href = "https://github.com/alextran1502/immich/graphs/contributors" >
< img src = "https://contrib.rocks/image?repo=immich-app/immich" width = "100%" / >
< / a >