self-hosted/immich
1
0
Fork 0
mirror of https://github.com/immich-app/immich.git synced 2024-11-24 08:52:28 +02:00
Code Issues Releases Activity
Self-hosted photo and video backup solution directly from your mobile phone.
45 Commits 102 Branches 227 Tags 400 MiB
TypeScript 46.8%
Dart 28.8%
Svelte 19.6%
Python 2.1%
Swift 0.5%
Other 1.9%
38c968d47e
Go to file
Alex 38c968d47e
Support HEIC/HEIF (#16) 
* Support HEIC/HEIF backup
* Storing backup directly from original file from the phone
* Directly read and backup video file - Improve performance on video backup
2022-02-09 20:48:06 -06:00
.github Update Artifact path 2022-02-08 11:57:49 -06:00
design Update readme with screenshots 2022-02-08 14:18:51 -06:00
mobile Support HEIC/HEIF (#16) 2022-02-09 20:48:06 -06:00
server Support HEIC/HEIF (#16) 2022-02-09 20:48:06 -06:00
.DS_Store Added toast message component 2022-02-04 17:20:23 -06:00
LICENSE Initial commit 2022-02-03 09:56:28 -06:00
Makefile Added fluent ffmpeg 2022-02-05 01:33:08 -06:00
README.md Support HEIC/HEIF (#16) 2022-02-09 20:48:06 -06:00

README.md

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

[x] Upload assets(videos/images)

[x] View assets

[x] Quick navigation with drag scroll bar

[x] Auto Backup

[x] Support HEIC

Development

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

  1. NestJs
  2. PostgreSQL
  3. Redis
  4. 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": "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

iOS

  • Get a MacOS
  • Download and setup Flutter development environment
  • Navigate to mobile folder
  • 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 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