v1.5.0 — one-command fresh install (#47)

Author: epheterson

.github/workflows/ci.yml

@@ -52,9 +52,78 @@ jobs:
         # "slow step failed" rather than masking the fast ones.
         run: pytest -v tests/test_fresh_install.py -m slow
 
+  fresh-install-docker:
+    # Docker E2E: generates compose from template, starts the full
+    # Immich stack, validates API + detection. Runs on Ubuntu where
+    # Docker is pre-installed (macOS runners can't run Docker VMs).
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: true
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+      - name: Generate compose from template
+        run: |
+          python3 -c "
+          import sys, os, secrets
+          from pathlib import Path
+          sys.path.insert(0, '.')
+          from immich_accelerator.__main__ import _COMPOSE_TEMPLATE
+          test_dir = Path('/tmp/fresh-install-ci')
+          test_dir.mkdir(parents=True, exist_ok=True)
+          photos = '/tmp/test-photos'
+          os.makedirs(photos, exist_ok=True)
+          data = str(test_dir / 'data')
+          os.makedirs(data, exist_ok=True)
+          compose = _COMPOSE_TEMPLATE.replace('{photos_mount}', f'{photos}:{photos}:ro')
+          (test_dir / 'docker-compose.yml').write_text(compose)
+          pw = secrets.token_urlsafe(24)
+          env = f'UPLOAD_LOCATION={data}\nDB_PASSWORD={pw}\nDB_HOSTNAME=immich_postgres\nDB_USERNAME=postgres\nDB_DATABASE_NAME=immich\nREDIS_HOSTNAME=immich_redis\n'
+          (test_dir / '.env').write_text(env)
+          print('Compose generated')
+          "
+      - name: Validate compose syntax
+        run: docker compose -f /tmp/fresh-install-ci/docker-compose.yml config > /dev/null
+      - name: Start Immich stack
+        run: |
+          cd /tmp/fresh-install-ci
+          docker compose up -d
+          echo "Waiting for API..."
+          for i in $(seq 1 90); do
+            if curl -sf http://localhost:2283/api/server/ping 2>/dev/null | grep -q pong; then
+              echo "API up after ${i}x3s"
+              break
+            fi
+            sleep 3
+          done
+          curl -sf http://localhost:2283/api/server/ping | grep -q pong || { echo "API never came up"; docker logs immich_server; exit 1; }
+      - name: Verify all containers running
+        run: |
+          docker ps --format "{{.Names}}\t{{.Status}}" | grep immich
+          [ $(docker ps --format "{{.Names}}" | grep -c immich) -eq 3 ] || { echo "Not all containers running"; exit 1; }
+      - name: Verify setup detection
+        run: |
+          python3 -c "
+          import sys
+          sys.path.insert(0, '.')
+          from immich_accelerator.__main__ import detect_immich
+          immich = detect_immich('docker')
+          assert immich['version'], 'no version'
+          assert immich['workers_include'] == 'api', f'wrong workers: {immich[\"workers_include\"]}'
+          assert immich.get('media_location'), 'no media_location'
+          print(f'Detected: v{immich[\"version\"]}, workers={immich[\"workers_include\"]}')
+          print(f'Media: {immich[\"media_location\"]}')
+          print('Detection: OK')
+          "
+      - name: Tear down
+        if: always()
+        run: cd /tmp/fresh-install-ci && docker compose down -v 2>/dev/null || true
+
   auto-tag:
     if: github.event_name == 'push' && github.ref == 'refs/heads/main'
-    needs: [lint, fresh-install-macos]
+    needs: [lint, fresh-install-macos, fresh-install-docker]
     runs-on: ubuntu-latest
     permissions:
       contents: write

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 1.5.0 — 2026-05-19
+
+### Features
+- **One-command fresh install.** `immich-accelerator setup` on a bare Mac now sets up everything — installs OrbStack if no Docker is found, creates the Immich Docker stack, configures the native worker, and starts all services. Two questions: where your photos are, where Immich should store its data. No manual docker-compose editing.
+- **Managed Docker stack.** The generated compose file lives at `~/.immich-accelerator/docker/`. Re-running setup detects it and restarts if stopped, without re-prompting.
+
 ## 1.4.13 — 2026-05-18
 
 ### Fixes

README.md

@@ -43,67 +43,32 @@ The microservices worker is extracted directly from your running Immich Docker i
 ## Requirements
 
 - macOS on Apple Silicon (M1/M2/M3/M4)
-- Immich already running in Docker (on this Mac or a remote host like a NAS)
-- [Homebrew](https://brew.sh) (setup will offer to install Node.js and libvips if missing)
-- Python 3.11+ for the ML service
+- [Homebrew](https://brew.sh)
 
-> **FFmpeg:** Downloaded automatically during setup ([jellyfin-ffmpeg](https://github.com/jellyfin/jellyfin-ffmpeg) — the same ffmpeg Immich uses in Docker).
+That's it. Setup installs everything else (Docker, Node.js, ffmpeg, ML dependencies).
 
 ## Quick start
 
-### 1. Install and run setup
-
 ```bash
 brew tap epheterson/immich-accelerator
 brew install immich-accelerator
 immich-accelerator setup
 ```
 
-Or from source:
-
-```bash
-git clone --recursive https://github.com/epheterson/immich-apple-silicon.git
-cd immich-apple-silicon
-python3 -m immich_accelerator setup
-```
-
-Setup handles everything: installs dependencies, downloads jellyfin-ffmpeg, creates the ML service venv, extracts the server from Docker, and guides you through the docker-compose changes.
-
-For NAS + Mac or manual setups, see [Split deployment](#split-deployment-nas--mac) below.
-
-### 2. Configure Docker
-
-The setup command prints the required changes. The key settings:
-
-```yaml
-services:
-  immich-server:
-    environment:
-      - IMMICH_WORKERS_INCLUDE=api
-      - IMMICH_MACHINE_LEARNING_URL=http://host.internal:3003  # OrbStack
-      # Docker Desktop: use http://host.docker.internal:3003 instead
-      - IMMICH_MEDIA_LOCATION=/your/upload/path
-    volumes:
-      # IMPORTANT: use the same absolute path on both sides (not the Docker default)
-      - /your/upload/path:/your/upload/path
-      - /your/photos:/your/photos:ro
-```
-
-Then: `docker compose up -d`
+If no Docker is found, setup offers to install [OrbStack](https://orbstack.dev). If no Immich is running, setup creates the entire Docker stack for you — just answer two questions:
 
-### Understanding path mapping
+1. **Where are your photos?** (e.g., `~/Pictures`) — mounted read-only for Immich to import
+2. **Where should Immich store its data?** (e.g., `~/.immich-accelerator/data`) — thumbnails, transcoded video, backups
 
-Immich stores absolute file paths in Postgres. Docker and the native worker must resolve those paths to the same files. `IMMICH_MEDIA_LOCATION` is the lever: set it to the real host path (like `/Users/you/immich/upload`) and mount that same path inside Docker with `-v /Users/you/immich/upload:/Users/you/immich/upload`. Both sides now see the same bytes at the same path.
+Setup generates the docker-compose, starts Immich, extracts the native worker, and starts everything. Open `http://localhost:2283` to create your admin account.
 
-Setup detects your upload directory and tells you exactly what to use. For cross-machine setups see [Split deployment](#split-deployment-nas--mac-or-any-two-hosts) — the requirements are stricter.
+For existing Immich installs, setup detects the running containers and configures the accelerator to work alongside them.
 
-### 3. Start the accelerator
+For NAS + Mac setups, see [Split deployment](#split-deployment-nas--mac) below.
 
-```bash
-immich-accelerator start
-```
+### Understanding `IMMICH_MEDIA_LOCATION`
 
-Starts the native microservices worker and ML service. Immich's web UI works as usual. Uploads go through Docker's API, compute happens natively.
+This is the directory Immich uses as its media root. It contains these subdirectories: `upload/`, `thumbs/`, `encoded-video/`, `library/`, `profile/`, `backups/`. Both Docker and the native worker must see this directory at the same absolute path. Setup handles this automatically for same-machine installs.
 
 ## Commands
 

VERSION

@@ -1 +1 @@
-1.4.13
+1.5.0