mirror of
https://github.com/maziggy/bambuddy.git
synced 2026-09-30 03:01:21 +02:00
maziggy
3407afc0c7
Two related failure modes have been biting Docker users repeatedly, most recently in #1211: 1. Docker named volumes are created by the daemon as root:root, and the previous `chmod 777 /app/data` Dockerfile workaround only covered the named-volume root — so subdirs Bambuddy creates at runtime (virtual_printer/uploads, virtual_printer/certs, etc.) inherited wrong ownership when the container ran as 1000:1000. 2. The shipped docker-compose.yml ships `./virtual_printer:/app/data/virtual_printer` uncommented, and dockerd creates a missing bind-mount source on the host as root before the container starts — leaving the host directory unwritable by uid 1000 inside the container even though the named volume above it had the chmod-777 workaround. Symptom either way: [Errno 13] Permission denied: '/app/data/virtual_printer/uploads', no virtual printer ever starts, "VP doesn't work" support reports follow. Replace the chmod-777 hack with a proper entrypoint: - deploy/docker-entrypoint.sh runs as root, chowns /app/data and /app/logs (and /app/data/virtual_printer when bind-mounted) to PUID:PGID, then drops to that uid via gosu before exec'ing the app. The chown is gated behind a top-level ownership check so subsequent restarts skip the recursive traversal — no multi- second startup penalty on multi-GB archive directories. - A sentinel .bambuddy file in each data path prevents Docker from re-syncing image directory metadata on every mount (otherwise empty volumes have their ownership reverted from the image on each restart, defeating the idempotency). - When the container is started with an explicit `user:` directive or `--user` flag the entrypoint detects it isn't root and falls through to direct exec — preserving compatibility for users who pin a specific uid. Compose template changes: - Remove `user: "${PUID:-1000}:${PGID:-1000}"` (entrypoint owns privilege drop now). - Add PUID / PGID env vars with the same defaults. - Comment out the ./virtual_printer:/app/data/virtual_printer bind mount by default, with explicit "only needed if you also run a native install of Bambuddy on the same host and want both to share the VP CA cert" guidance. The entrypoint chowns the host-side dir through the bind mount the first time it sees wrong ownership, so existing uncomented installs continue to work and #1211 specifically gets fixed.
112 lines
5.2 KiB
YAML
112 lines
5.2 KiB
YAML
services:
|
|
bambuddy:
|
|
image: ghcr.io/maziggy/bambuddy:latest
|
|
build: .
|
|
# Usage:
|
|
# docker compose up -d → pulls pre-built image from ghcr.io
|
|
# docker compose up -d --build → builds locally from source
|
|
container_name: bambuddy
|
|
# File ownership inside the data and logs volumes is normalised by the
|
|
# entrypoint at startup (chowns to PUID:PGID and drops privileges via
|
|
# gosu before running the app). Override PUID / PGID below to match
|
|
# your host user if needed — defaults to 1000:1000 to match the
|
|
# historical compose `user:` directive.
|
|
#
|
|
# Allow binding to privileged ports (322, 990) as non-root user — required
|
|
# for FTPS in every VP mode and for the RTSPS camera proxy in proxy mode +
|
|
# non-proxy modes that have a target printer configured. Without this, the
|
|
# FTP and RTSP listeners silently fail.
|
|
cap_add:
|
|
- NET_BIND_SERVICE
|
|
#
|
|
# LINUX: Use host mode for printer discovery and camera streaming
|
|
network_mode: host
|
|
#
|
|
# macOS/WINDOWS: Docker Desktop doesn't support host mode.
|
|
# Comment out "network_mode: host" above and uncomment "ports:" below.
|
|
# Note: Printer discovery won't work - add printers manually by IP.
|
|
#ports:
|
|
# - "${PORT:-8000}:8000"
|
|
# - "3000:3000" # Virtual printer bind/detect
|
|
# - "3002:3002" # Virtual printer bind/detect
|
|
# - "8883:8883" # Virtual printer MQTT
|
|
# - "990:990" # Virtual printer FTP control
|
|
# - "6000:6000" # Virtual printer file transfer tunnel
|
|
# - "322:322" # Virtual printer RTSP camera (X1/H2/P2; proxy mode + non-proxy modes with a target printer)
|
|
# - "2024-2026:2024-2026" # Virtual printer proprietary ports (A1/P1S)
|
|
# - "50000-50100:50000-50100" # Virtual printer FTP passive data
|
|
volumes:
|
|
- bambuddy_data:/app/data
|
|
- bambuddy_logs:/app/logs
|
|
#
|
|
# OPTIONAL — only needed if you ALSO run a native install of Bambuddy
|
|
# on the same host and want both installs to share the same Virtual
|
|
# Printer CA certificate (so the slicer only has to trust one CA).
|
|
# Most Docker-only users should leave this commented out — the
|
|
# entrypoint will keep the VP data inside the named volume above.
|
|
# If uncommented, the entrypoint chowns the host directory to
|
|
# PUID:PGID on first start so the container user can write to it.
|
|
#- ./virtual_printer:/app/data/virtual_printer
|
|
#
|
|
# Mount scheduled backup output to NAS or external storage
|
|
# Backups default to DATA_DIR/backups/ inside the data volume.
|
|
# Uncomment to store them externally (e.g. on a NAS share).
|
|
#- /path/to/nas/bambuddy-backups:/app/data/backups
|
|
#
|
|
# Tailscale integration (optional): mount the host's tailscaled socket
|
|
# so Bambuddy can request Let's Encrypt certs for virtual printers via
|
|
# your tailnet's MagicDNS name. Requires:
|
|
# 1. Tailscale installed + `tailscale up` completed on the host
|
|
# 2. `sudo tailscale set --operator=<container-user>` on the host so
|
|
# the user running the container can call `tailscale cert`
|
|
# Without this mount, the Tailscale toggle in the UI is harmless —
|
|
# Bambuddy falls back to self-signed certs.
|
|
#- /var/run/tailscale/tailscaled.sock:/var/run/tailscale/tailscaled.sock
|
|
environment:
|
|
- TZ=${TZ:-Europe/Berlin}
|
|
# User/group the container drops to after the entrypoint normalises
|
|
# ownership on /app/data and /app/logs. Match your host user (run
|
|
# `id -u` / `id -g`) if you want files written by the container to
|
|
# show up as your user on the host. Defaults to 1000:1000.
|
|
- PUID=${PUID:-1000}
|
|
- PGID=${PGID:-1000}
|
|
# Port BamBuddy runs on (default: 8000)
|
|
# Usage: PORT=8080 docker compose up -d
|
|
- PORT=${PORT:-8000}
|
|
# Virtual printer: Set to the Docker host's IP when using bridge mode (ports:).
|
|
# Required for FTP passive mode to work behind NAT.
|
|
# Example: VIRTUAL_PRINTER_PASV_ADDRESS=192.168.1.100
|
|
#- VIRTUAL_PRINTER_PASV_ADDRESS=
|
|
#
|
|
# External PostgreSQL (optional — uses SQLite by default)
|
|
# Example: DATABASE_URL=postgresql+asyncpg://bambuddy:password@db-host:5432/bambuddy
|
|
#- DATABASE_URL=
|
|
#
|
|
# Slicer API sidecar (optional — Settings → "Use Slicer API" toggles this on).
|
|
# Default points at the OrcaSlicer sidecar on the docker host; change if you
|
|
# run the sidecar on a different host/port. The matching docker-compose.yml
|
|
# for the sidecars lives in the orca-slicer-api fork
|
|
# (https://github.com/maziggy/orca-slicer-api).
|
|
#- SLICER_API_URL=http://localhost:3003
|
|
restart: unless-stopped
|
|
|
|
# Optional: External PostgreSQL database
|
|
# Uncomment to run Postgres alongside Bambuddy (or use an external Postgres host)
|
|
#postgres:
|
|
# image: postgres:16-alpine
|
|
# container_name: bambuddy-db
|
|
# restart: unless-stopped
|
|
# environment:
|
|
# POSTGRES_USER: bambuddy
|
|
# POSTGRES_PASSWORD: changeme
|
|
# POSTGRES_DB: bambuddy
|
|
# volumes:
|
|
# - bambuddy_pgdata:/var/lib/postgresql/data
|
|
# ports:
|
|
# - "5432:5432"
|
|
|
|
volumes:
|
|
bambuddy_data:
|
|
bambuddy_logs:
|
|
#bambuddy_pgdata:
|