mattdavis90/immich-stacker repository overview

⁠Immich Stacker

github.com/mattdavis90/immich-stacker⁠

A small application to help you stack images in Immich⁠.

The Immich web app allows you to manually stack your files but doesn't give you any automation. This app adds a small automation layer that can be run periodically to stack your photos.

⁠Use Cases

Below are some sample use cases.

⁠Raw + JPG

You shoot in Raw+JPG on your DSLR / smart phone and you'd like Immich to dedupe the photos while preserving the raw files. The below config searches for RW2 and JPG files with the same filename other than the extension and stacks them, with the JPG becoming the parent image.

IMMITCH_MATCH=\.(JPG|RW2)$
IMMITCH_PARENT=\.JPG$

⁠Burst Mode

Modern smart phones provide a burst option. Below is a config for detecting bursts of photos and stacking them with the cover image becoming the parent.

IMMITCH_MATCH=BURST[0-9]{3}(_COVER)?\.jpg$
IMMITCH_PARENT=_COVER\.jpg$

⁠Deployment

Running the application is straightforward but it only runs once; there is no loop. Configuration is taken from the environment or a .env file. Care should be taken when using special characters in an environment variable. .env files will handle escaping for you but a docker deployment needs care.

⁠Standalone

Download the prebuilt binary from Github and run it. The example below uses a .env file for repeatability and to minimise mistakes when escaping regexes.

cat > .env << EOF
IMMITCH_API_KEY=abc123
IMMITCH_ENDPOINT=https://immitch.app/api
IMMITCH_MATCH=\.(JPG|RW2)$
IMMITCH_PARENT=\.JPG$
EOF

./immitch-stacker

⁠Docker

Use the prebuilt docker container. The example below uses a .env file for repeatability and to minimise mistakes when escaping regexes.

cat > .env << EOF
IMMITCH_API_KEY=abc123
IMMITCH_ENDPOINT=https://immitch.app/api
IMMITCH_MATCH=\.(JPG|RW2)$
IMMITCH_PARENT=\.JPG$
EOF

docker run -ti --rm --env-file=.env mattdavis90/immitch-stacker-latest

⁠Using Swarm Cronjobs

Since the stacker only runs once then exits. It is recommended to use a cron scheduler if deploying on Docker Swarm or in a docker-compose file. crazymax/swarm-cronjob works reliably and is easy to configure.

Note: Take care when escaping regex in a docker-compose file.

services:
  stacker:
    image: mattdavis90/immich-stacker:latest
    deploy:
      replicas: 0
      labels:
        - "swarm.cronjob.enable=true"
        - "swarm.cronjob.schedule=0 * * * *"
        - "swarm.cronjob.skip-running=false"
      restart_policy:
        condition: none
    environment:
      IMMICH_API_KEY: abc123
      IMMICH_ENDPOINT: "https://immich.com/api"
      IMMITCH_MATCH: "\\.(JPG|RW2)$$"
      IMMITCH_PARENT: "\\.JPG$$"
  swarm-cronjob:
    image: crazymax/swarm-cronjob
    deploy:
      placement:
        constraints:
          - node.role == manager
    environment:
      - "TZ=Europe/London"
      - "LOG_LEVEL=info"
      - "LOG_JSON=false"
    volumes:
      - "/var/run/docker.sock:/var/run/docker.sock"