IMMICH
Self-hosted Photo backup solution directly from your mobile phone.
Note
This project is under heavy development, there will be continous functions, features and api changes.
!! NOT READY FOR PRODUCTION! DO NOT USE TO STORE YOUR ASSETS !!
Development
You can use docker compose for development, there are several services that compose Immich
- The server
- PostgreSQL
- Redis
- Nginx
Populate .env file
Navigate to server directory and run
cp .env.example .env
Then populate the value in there.
To start, run
docker-compose -f ./server/docker-compose.yml up
To force rebuild node modules after installing new packages
docker-compose -f ./server/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": "[email protected]",
"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
iOS
- Get a MacOS
- Download and setup Flutter development environment
- Navigate to
mobilefolder - Run with release build command for best performance.
flutter run --release
Known Issue
TensorFlow doesn’t run with older CPU architecture, it requires CPU with AVX and AVX2 instruction set. If you encounter error illegal instruction core dump when running the docker-compose command above, check for your CPU flags with the command ad 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
