diff --git a/README.md b/README.md index dd34e29..f7bcb20 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,18 @@ - # ![Logo](./public/favicon-32x32.png) Immich Power Tools A unofficial immich client to provide better tools to organize and manage your immich account. Building it to speed up your workflows in Immich to organize your people and albums. - [Watch Demo Video here](https://www.loom.com/embed/13aa90d8ab2e4acab0993bdc8703a750?sid=71498690-b745-473f-b239-a7bdbe6efc21) [![Immich Power Tools](./screenshots/screenshot-1.jpeg)](https://www.loom.com/embed/13aa90d8ab2e4acab0993bdc8703a750?sid=71498690-b745-473f-b239-a7bdbe6efc21) - -### 💭 Back story +## 💭 Back story Recently I've migrated my entire Google photos library to Immich, I was able to successfully migrate all my assets along with its albums to immich. But there were few things like people match that was lacking. I loved Immich UI on the whole but for organizing content I felt its quite restricted and I had to do a lot of things in bulk instead of opening each asset and doing it. Hence I built this tool (continuing to itereate) to make my life and any other Immich user's life easier. +## 🚀 Getting Started -### 🚀 Getting Started - -#### 🐬 Using Docker +### 🐬 Using Docker You can run the project using `docker-compose.yml` file. @@ -24,8 +20,46 @@ You can run the project using `docker-compose.yml` file. wget https://raw.githubusercontent.com/varun-raj/immich-power-tools/main/docker-compose.yml docker compose up -d ``` +If you're running docker inside a network, you can use the power tools in two way -#### 🚀 Using Local Setup +#### Method 1 - Docker Compose + +Add the following into your docker compose as a new service along side other immich services. Make sure you've `power-tools` in same network as immich. + +See the sample [docker-compose-all-immich.yml](./docker-compose-all-immich) file for reference. + +```yaml +services: + # Other services... + + power-tools: + container_name: immich_power_tools + image: ghcr.io/varun-raj/immich-power-tools:latest + ports: + - "8001:3000" + env_file: + - .env + +``` + +And the env file will have the following values format + + +```bash +IMMICH_URL=http://192.168.0.200:3001 // This should be the immich url which is accessible in your browser +IMMICH_API_KEY= # your_immich_api_key +DATABASE_URL=postgresql://:@:/ +``` +#### Method 2 - Portainer + +If you're using portainer, run the docker using `docker run` and add the power tools to the same network as immich. + +```bash +docker run -d --name immich_power_tools -p 8001:3000 --env-file .env ghcr.io/varun-raj/immich-power-tools:latest +``` + + +### 🚀 Using Local Setup > [!NOTE] > Please use `bun` to run the project. If you don't have `bun` installed, checkout [bun.sh](https://bun.sh/) for installation. @@ -34,7 +68,7 @@ Copy paste the `.env.example` to `.env` and fill in the values. ```bash IMMICH_URL="" # Immich API URL -IMMICH_API_KEY="" # Immich API Key +IMMICH_API_KEY="" # Immich API Key DATABASE_URL="" # Postgress Database URL ``` @@ -46,12 +80,12 @@ Run the development server: bun run dev ``` -### Features +## Features **Immich Related** -- [x] Manage People - - [ ] Smart Merge +- [x] Manage People + - [ ] Smart Merge - [ ] Manage Albums - [ ] Bulk Delete - [ ] Bulk Edit @@ -65,15 +99,15 @@ bun run dev - [x] Dark Mode - [x] Dockerize - [ ] Authentication -- [ ] Push to [dockerhub](https://hub.docker.com/) +- [x] Push to github packages -### Tech Stack +## Tech Stack - [Next.js](https://nextjs.org/) for infrastructure - [Tailwind CSS](https://tailwindcss.com/) for styling - [Shadcn](https://shadcn.com/) for UI Components - [Axios](https://axios-http.com/) for API calls -### Contributing +## Contributing -Feel free to contribute to this project, I'm open to any suggestions and improvements. Please read the [CONTRIBUTING.md](./CONTRIBUTING.md) for more details. \ No newline at end of file +Feel free to contribute to this project, I'm open to any suggestions and improvements. Please read the [CONTRIBUTING.md](./CONTRIBUTING.md) for more details. diff --git a/docker-compose-all-immich.yml b/docker-compose-all-immich.yml new file mode 100644 index 0000000..1dfaefc --- /dev/null +++ b/docker-compose-all-immich.yml @@ -0,0 +1,66 @@ +name: immich + +services: + immich-server: + container_name: immich_server + image: ghcr.io/immich-app/immich-server:${IMMICH_VERSION:-release} + volumes: + - ${UPLOAD_LOCATION}:/usr/src/app/upload + - /etc/localtime:/etc/localtime:ro + env_file: + - .env + ports: + - 2283:3001 + depends_on: + - redis + - database + restart: always + + immich-machine-learning: + container_name: immich_machine_learning + # For hardware acceleration, add one of -[armnn, cuda, openvino] to the image tag. + # Example tag: ${IMMICH_VERSION:-release}-cuda + image: ghcr.io/immich-app/immich-machine-learning:${IMMICH_VERSION:-release} + # extends: # uncomment this section for hardware acceleration - see https://immich.app/docs/features/ml-hardware-acceleration + # file: hwaccel.ml.yml + # service: cpu # set to one of [armnn, cuda, openvino, openvino-wsl] for accelerated inference - use the `-wsl` version for WSL2 where applicable + volumes: + - model-cache:/cache + env_file: + - .env + restart: always + + redis: + container_name: immich_redis + image: registry.hub.docker.com/library/redis:6.2-alpine@sha256:84882e87b54734154586e5f8abd4dce69fe7311315e2fc6d67c29614c8de2672 + restart: always + + database: + container_name: immich_postgres + image: registry.hub.docker.com/tensorchord/pgvecto-rs:pg14-v0.2.0@sha256:90724186f0a3517cf6914295b5ab410db9ce23190a2d9d0b9dd6463e3fa298f0 + environment: + POSTGRES_PASSWORD: ${DB_PASSWORD} + POSTGRES_USER: ${DB_USERNAME} + POSTGRES_DB: ${DB_DATABASE_NAME} + POSTGRES_INITDB_ARGS: '--data-checksums' + ports: + - 5432:5432 + volumes: + - ${DB_DATA_LOCATION}:/var/lib/postgresql/data + restart: always + command: ["postgres", "-c" ,"shared_preload_libraries=vectors.so", "-c", 'search_path="$$user", public, vectors', "-c", "logging_collector=on", "-c", "max_wal_size=2GB", "-c", "shared_buffers=512MB", "-c", "wal_compression=on"] + + power-tools: + container_name: immich_power_tools + image: ghcr.io/varun-raj/immich-power-tools:latest + ports: + - "8001:3000" + env_file: + - .env + +volumes: + model-cache: + +networks: + hexabase-network: + external: true