Installation
Prerequisites
- Go (version 1.21 or later)
- Git
From Source
- Clone the repository:
git clone https://github.com/majorfi/immich-stack.git
cd immich-stack
- Build the binary:
go build -o immich-stack ./cmd/...
- Move the binary to your PATH (optional):
sudo mv immich-stack /usr/local/bin/
Using Pre-built Binaries
- Download the latest release from the Releases page
- Extract the archive
- Move the binary to your PATH (optional)
Docker Installation
- Clone the repository:
git clone https://github.com/majorfi/immich-stack.git
cd immich-stack
- Create a
.env
file from the example:
- Edit the
.env
file with your Immich credentials and preferences:
# Required
API_KEY=your_immich_api_key
API_URL=http://your_immich_server:3001/api
# Optional - Default values shown
DRY_RUN=false
RESET_STACKS=false
REPLACE_STACKS=false
PARENT_FILENAME_PROMOTE=edit
PARENT_EXT_PROMOTE=.jpg,.dng
WITH_ARCHIVED=false
WITH_DELETED=false
# Run mode settings
RUN_MODE=once # Options: once, cron
CRON_INTERVAL=86400 # in seconds, only used if RUN_MODE=cron
- Start the service:
- To run in cron mode, set
RUN_MODE=cron
in your .env
file and restart:
docker compose down
docker compose up -d
- To view logs:
- To stop the service: