Setting up power tools

There are two ways to setup immich power tools.

🐬 Using Docker

Power-tools is designed to be used alongside Immich, and there are two ways you can run it.

Method 1 - Docker Compose ( Recommended )

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 file for reference.

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

Add the Immich API Key and immich url's to the env file (which you already have for the immich)

IMMICH_API_KEY= # your_immich_api_key
IMMICH_URL = "http://local-ip-of-immich:port" # Your immich instace ip address and port
EXTERNAL_IMMICH_URL = "https://external-address" # External address of immich

# Optional
GOOGLE_MAPS_API_KEY= # Google Maps API Key
GEMINI_API_KEY= # Gemini API Key

For DB Using Individual Keys
DB_USERNAME="" # Postgress Database Username
DB_PASSWORD = "" # Postgres Database Password
DB_HOST = "" # Postgres Host (IP address or hostname of the database)
DB_PORT = "" # Postgres Port number (Default: 5432)
DB_DATABASE_NAME = "" # Name of the database 

For DB using DB URL
DB_URL = ""

Refer here for obtaining Immich API Key: https://immich.app/docs/features/command-line-interface#obtain-the-api-key

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.

# Run the power tools from docker 
docker run -d --name immich_power_tools -p 8001:3000 --env-file .env ghcr.io/varun-raj/immich-power-tools:latest

# Add Power tools to the same network as immich
docker network connect immich_default immich_power_tools