c-l/immich

mirror of https://github.com/immich-app/immich.git synced 2024-12-28 06:31:58 +00:00

* Fixed problem with docker-compose not updating new files in the multi-stage build.
* Update readme with a new screenshot

2022-03-28 15:21:15 -05:00

5.4 KiB

Raw Blame History

Immich

Self-hosted photo and video backup solution directly from your mobile phone.

Loading ~4000 images/videos

Screenshots

Note

!! NOT READY FOR PRODUCTION! DO NOT USE TO STORE YOUR ASSETS !!

This project is under heavy development, there will be continous functions, features and api changes.

Features

Upload and view assets(videos/images).
Multi-user supported.
Quick navigation with drag scroll bar.
Auto Backup.
Support HEIC/HEIF Backup.
Extract and display EXIF info.
Real-time render from multi-device upload event.
Image Tagging/Classification based on ImageNet dataset
Object detection based on COCO SSD.
Search assets based on tags and exif data (lens, make, model, orientation)
Upload assets from your local computer/server using immich cli tools
[Optional] Reserve geocoding using Mapbox (Generous free-tier of 100,000 search/month)
Show asset's location information on map (OpenStreetMap).
Show curated places on the search page
Show curated objects on the search page

Development

You can use docker compose for development, there are several services that compose Immich

NestJs
PostgreSQL
Redis
Nginx
TensorFlow

Populate .env file

Navigate to docker directory and run

cp .env.example .env

Then populate the value in there.

Notice that if set ENABLE_MAPBOX to true, you will have to provide MAPBOX_KEY for the server to run.

Pay attention to the key UPLOAD_LOCATION, this directory must exist and is owned by the user that run the docker-compose command below.

To start, run

docker-compose -f ./docker/docker-compose.yml up --build -V

The server will be running at http://your-ip:2283 through Nginx

Register User

Use the command below on your terminal to create user as we don't have user interface for this function yet.

curl --location --request POST 'http://your-server-ip:2283/auth/signUp' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": "testuser@email.com",
    "password": "password"
}'

Run mobile app

Android

Download apk in release tab and run on your phone. You can follow this guide on how to do that

Run APK on Android

iOS

You can download the app from Apple AppStore here:

Apple App Store

Support

If you like the app, find it helpful, and want to support me to offset the cost of publishing to AppStores, you can sponsor the project with Github Sponsore.

This is also a meaningful way to give me motivation and encounragment to continue working on the app.

Cheer! 🎉

Known Issue

TensorFlow doesn't run with older CPU architecture, it requires CPU with AVX and AVX2 instruction set. If you encounter the error illegal instruction core dump when running the docker-compose command above, check for your CPU flags with the command and make sure you see AVX and AVX2. Otherwise, switch to a different VM/desktop with different architecture.

more /proc/cpuinfo | grep flags

If you are running virtualization in Promox, the VM doesn't have the flag enable.

You need to change the CPU type from kvm64 to host under VMs hardware tab.

Hardware > Processors > Edit > Advanced > Type (dropdown menu) > host

5.4 KiB Raw Blame History