mirror of
https://github.com/maziggy/bambuddy.git
synced 2026-09-30 11:12:35 +02:00
maziggy
6deaa513af
Adds an optional slicer-api/ Compose stack and wires Bambuddy's File
Manager, Archives, and MakerWorld pages to a new server-side Slice flow.
Slicing runs as an in-memory background job (POST returns 202 + job_id,
polled via GET /api/v1/slice-jobs/{id}) so a multi-minute slice no
longer pins the modal; result lands as a new .gcode.3mf in the same
folder (or new archive for archive sources) with the embedded
thumbnail extracted.
Backend
- New services: slice_dispatch (in-memory dispatcher, 30min retention
sweep) and slicer_api (HTTP bridge with 4xx/5xx/connection error
split that drives the 3MF embedded-settings fallback retry path).
- New schemas: SliceRequest, SliceResponse, SliceArchiveResponse,
SliceJobEnqueueResponse.
- New routes: POST /library/files/{id}/slice,
POST /archives/{id}/slice, GET /api/v1/slice-jobs/{id} (gated on
LIBRARY_READ since job IDs are sequential and the body leaks source
filenames and result IDs).
- AppSettings + env defaults: use_slicer_api, orcaslicer_api_url,
bambu_studio_api_url. DB-stored values override env defaults.
Frontend
- New SliceModal handles preset gating; enqueues then closes
immediately.
- New SliceJobTrackerProvider polls active jobs at app level, surfaces
a single toast per job (queued -> running -> completed / failed)
and invalidates library/archives queries on terminal status.
- Settings -> Workflow -> Slicer card: preferred slicer dropdown,
Use Slicer API toggle, contextual sidecar URL field.
- File Manager / Archives / MakerWorld get a Slice button gated on
the Use Slicer API setting.
- gcode-viewer adapter learns ?library_file=<id> so sliced library
files preview inline.
i18n
- New slice.* and settings.{useSlicerApi,slicerCard,orcaslicerApiUrl,
bambuStudioApiUrl,slicerApiUrlDescription,useSlicerApiDescription}
+ fileManager.noPermissionSlice keys across all 8 locales (en, de,
fr, it, ja, pt-BR, zh-CN, zh-TW). English fully translated, German
fully translated, the other six seeded with English fallbacks
pending native translation.
Tests
- 10 backend integration tests in test_library_slice_api.py covering
validation (404/400), happy-path enqueue, sidecar-down, 3MF
embedded-settings fallback, STL no-fallback, and preset-error ->
failed job paths.
- New unit tests in test_slicer_api.py for the HTTP bridge.
- 5 new SliceModal frontend tests covering preset gating, library +
archive enqueue paths, error surface, and preset-load failure.
- Existing SettingsPage tests adjusted: slicer dropdown asserts now
switch to the Workflow tab first; added a beforeEach URL reset so
one test's tab click doesn't bleed into sibling tests.
Sidecar
- New slicer-api/ folder is self-contained and optional. Two services
(orca-slicer-api on 3003, bambu-studio-api on 3001 behind --profile
bambu) build via Docker git-build-context from
maziggy/orca-slicer-api@bambuddy/profile-resolver. The fork patches
the OrcaSlicer CLI's profile compatibility quirks (inherits-chain
resolver, from:User -> system rewrite, '# ' clone-prefix strip,
sentinel-value strip) empirically required to slice real GUI
exports without segfaulting the CLI.
Docs
- CHANGELOG entry under [0.2.4b1] - Unreleased Added.
- README File Manager bullet for the new server-side Slice button.
- bambuddy-website features.html: new card under "Configurable Slicer".
- bambuddy-wiki: new page features/slicer-api.md + nav entry +
features index card.
Notes
- Opt-in: with Use Slicer API off, the existing "open in desktop
slicer via URI" flow is the default and unchanged.
- 3MF inputs that segfault the CLI on --load-settings transparently
retry with embedded settings; the resulting job carries
used_embedded_settings: true.
- Sliced files always export as .gcode.3mf so File Manager picks up
the embedded thumbnail; file_type is set to "gcode" (blue badge).
97 lines
4.2 KiB
YAML
97 lines
4.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
|
|
# Run as current user to avoid permission issues with mounted volumes
|
|
# Override with: PUID=$(id -u) PGID=$(id -g) docker compose up -d
|
|
user: "${PUID:-1000}:${PGID:-1000}"
|
|
#
|
|
# Proxy mode: allow binding to privileged ports (322, 990) as non-root user.
|
|
# Without this, the FTP and RTSP proxies 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)
|
|
# - "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
|
|
#
|
|
# Share virtual printer certs with native installation
|
|
# This ensures the slicer only needs to trust one CA certificate.
|
|
- ./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}
|
|
# 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:
|