mirror of
https://github.com/immich-app/immich.git
synced 2024-11-24 08:52:28 +02:00
141 lines
6.6 KiB
Markdown
141 lines
6.6 KiB
Markdown
<p align="center">
|
|
<br/>
|
|
<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>
|
|
<a href="https://discord.gg/D8JsnBEuKb">
|
|
<img src="https://img.shields.io/discord/979116623879368755.svg?label=Discord&logo=Discord&style=for-the-badge&logoColor=000000&labelColor=ececec" alt="Discord"/>
|
|
</a>
|
|
<br/>
|
|
<br/>
|
|
</p>
|
|
|
|
<p align="center">
|
|
<img src="design/immich-logo-stacked-light.svg" width="300" title="Login With Custom URL">
|
|
</p>
|
|
<h3 align="center">High performance self-hosted photo and video management solution</h3>
|
|
<br/>
|
|
<a href="https://immich.app">
|
|
<img src="design/immich-screenshots.png" title="Main Screenshot">
|
|
</a>
|
|
<br/>
|
|
<p align="center">
|
|
<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>
|
|
</p>
|
|
|
|
## Disclaimer
|
|
|
|
- ⚠️ The project is under **very active** development.
|
|
- ⚠️ Expect bugs and breaking changes.
|
|
- ⚠️ **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!
|
|
|
|
## Content
|
|
|
|
- [Official Documentation](https://immich.app/docs)
|
|
- [Roadmap](https://github.com/orgs/immich-app/projects/1)
|
|
- [Demo](#demo)
|
|
- [Features](#features)
|
|
- [Introduction](https://immich.app/docs/overview/introduction)
|
|
- [Installation](https://immich.app/docs/install/requirements)
|
|
- [Contribution Guidelines](https://immich.app/docs/overview/support-the-project)
|
|
- [Support The Project](#support-the-project)
|
|
|
|
## Documentation
|
|
|
|
You can find the main documentation, including installation guides, at https://immich.app/.
|
|
|
|
## Demo
|
|
|
|
You can access the web demo at https://demo.immich.app
|
|
|
|
For the mobile app, you can use `https://demo.immich.app/api` for the `Server Endpoint URL`
|
|
|
|
```bash title="Demo Credential"
|
|
The credential
|
|
email: demo@immich.app
|
|
password: demo
|
|
```
|
|
|
|
```
|
|
Spec: Free-tier Oracle VM - Amsterdam - 2.4Ghz quad-core ARM64 CPU, 24GB RAM
|
|
```
|
|
|
|
## Activities
|
|
|
|
|
|
## 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 | No | 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 |
|
|
|
|
## Support the project
|
|
|
|
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.
|
|
|
|
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.
|
|
|
|
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.
|
|
|
|
### Donation
|
|
|
|
- [Monthly donation](https://github.com/sponsors/immich-app) via GitHub Sponsors
|
|
- [One-time donation](https://github.com/sponsors/immich-app?frequency=one-time&sponsor=alextran1502) via GitHub Sponsors
|
|
- [Liberapay](https://liberapay.com/alex.tran1502/)
|
|
- [buymeacoffee](https://www.buymeacoffee.com/altran1502)
|
|
- Bitcoin: 3QVAb9dCHutquVejeNXitPqZX26Yg5kxb7
|
|
- ZCash: u1smm4wvqegcp46zss2jf5xptchgeczp4rx7a0wu3mermf2wxahm26yyz5w9mw3f2p4emwlljxjumg774kgs8rntt9yags0whnzane4n67z4c7gppq4yyvcj404ne3r769prwzd9j8ntvqp44fa6d67sf7rmcfjmds3gmeceff4u8e92rh38nd30cr96xw6vfhk6scu4ws90ldzupr3sz
|
|
|
|
## Contributors
|
|
|
|
<a href="https://github.com/alextran1502/immich/graphs/contributors">
|
|
<img src="https://contrib.rocks/image?repo=immich-app/immich" width="100%"/>
|
|
</a>
|
|
|
|
## Star History
|
|
|
|
<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>
|
|
</a>
|