mirror of
https://github.com/maziggy/bambuddy.git
synced 2026-09-30 11:12:35 +02:00
maziggy
b362f159ac
Local build via Docker git context required `git` in the BuildKit worker,
which QNAP Container Station and Synology DSM don't provide. Both sidecar
images are now published to ghcr.io/maziggy/{orca-slicer-api,bambu-studio-api}
and docker.io/maziggy/{orca-slicer-api,bambu-studio-api}; compose pulls
:latest by default, SIDECAR_TAG=bambuddy-X.Y.Z pins per release.
Wiki, slicer-api README, .env.example, and CHANGELOG aligned. Build-from-source
path kept under "Building from source (advanced)" for forks / dev work.
Both images are linux/amd64 only — OrcaSlicer ARM64 on hold pending upstream
fix; BambuStudio doesn't publish ARM64.
117 lines
4.3 KiB
Markdown
117 lines
4.3 KiB
Markdown
# Slicer-API sidecar (optional)
|
|
|
|
Self-contained Docker Compose stack that runs HTTP wrappers around the
|
|
OrcaSlicer and/or Bambu Studio CLI. Bambuddy's **Slice** action calls
|
|
these to slice models server-side, no desktop slicer required.
|
|
|
|
This folder is **optional**. Bambuddy works without it — Slice falls back
|
|
to opening the model in the user's local desktop slicer via URI scheme.
|
|
Enable the API path by:
|
|
|
|
1. Starting one or both services here
|
|
2. **Settings → Slicer → Use Slicer API** = on
|
|
3. Set **Slicer sidecar URL** for whichever slicer you've started
|
|
|
|
## Quick start
|
|
|
|
```bash
|
|
cd slicer-api/
|
|
cp .env.example .env # edit ports if you like
|
|
|
|
# OrcaSlicer only (default profile):
|
|
docker compose up -d
|
|
curl http://localhost:3003/health
|
|
|
|
# Both slicers:
|
|
docker compose --profile bambu up -d
|
|
curl http://localhost:3001/health # bambu-studio-api
|
|
curl http://localhost:3003/health # orca-slicer-api
|
|
```
|
|
|
|
First start pulls pre-built images from GHCR (~110 MB OrcaSlicer,
|
|
~220 MB BambuStudio). No local build, no git in the BuildKit worker,
|
|
works on QNAP / Synology / Container Station out of the box.
|
|
|
|
Both images are `linux/amd64` only. OrcaSlicer's ARM64 build is on hold
|
|
pending an upstream extraction fix; BambuStudio doesn't publish ARM64
|
|
at all. For ARM64 hosts (Raspberry Pi 4/5, Apple Silicon Linux), run
|
|
the sidecar on a separate x86_64 box and point Bambuddy at it via the
|
|
**Sidecar URL** field — the sidecar doesn't need to live next to Bambuddy.
|
|
|
|
## Ports
|
|
|
|
| Service | Default host port | Why this port |
|
|
|---|---|---|
|
|
| `orca-slicer-api` | **3003** | Bambuddy's virtual-printer feature reserves 3000 and 3002 |
|
|
| `bambu-studio-api` | **3001** | First free port in that range |
|
|
|
|
Override via `ORCA_API_PORT` / `BAMBU_API_PORT` in `.env`.
|
|
|
|
## Bambuddy wiring
|
|
|
|
In the Bambuddy UI: **Settings → Slicer**:
|
|
|
|
- **Preferred Slicer**: pick OrcaSlicer or Bambu Studio.
|
|
- **Use Slicer API**: turn on.
|
|
- **Sidecar URL**: paste the full URL of the chosen slicer's sidecar.
|
|
Default values match the Compose defaults:
|
|
- OrcaSlicer: `http://localhost:3003`
|
|
- Bambu Studio: `http://localhost:3001`
|
|
|
|
Leaving the URL field blank uses the `SLICER_API_URL` /
|
|
`BAMBU_STUDIO_API_URL` environment defaults from Bambuddy's config.
|
|
|
|
## Where the images live
|
|
|
|
Pre-built images are published to two registries on every Bambuddy
|
|
stable release:
|
|
|
|
- `ghcr.io/maziggy/orca-slicer-api:latest` / `docker.io/maziggy/orca-slicer-api:latest`
|
|
- `ghcr.io/maziggy/bambu-studio-api:latest` / `docker.io/maziggy/bambu-studio-api:latest`
|
|
|
|
Each release also publishes a versioned tag (`:bambuddy-X.Y.Z`) so you
|
|
can pin to the sidecar that shipped alongside a specific Bambuddy
|
|
release — set `SIDECAR_TAG=bambuddy-0.2.5` in `.env`.
|
|
|
|
Both images are built from the
|
|
[`maziggy/orca-slicer-api`](https://github.com/maziggy/orca-slicer-api)
|
|
fork (`bambuddy/profile-resolver` branch). The fork patches AFKFelix's
|
|
upstream wrapper with the `inherits:` chain resolver, `from: "User"`
|
|
→ `"system"` rewrite, `# ` clone-prefix strip, and sentinel-value
|
|
strip — all empirically required to slice real GUI exports without
|
|
segfaulting the CLI. Once those land upstream, the compose file can be
|
|
flipped back to `ghcr.io/afkfelix/orca-slicer-api`.
|
|
|
|
## Updating
|
|
|
|
```bash
|
|
docker compose pull
|
|
docker compose --profile bambu up -d
|
|
```
|
|
|
|
That's it — Compose pulls the current `:latest` (or whatever
|
|
`SIDECAR_TAG` you've pinned to) and recreates the containers.
|
|
|
|
To roll back to the sidecar that shipped with a previous Bambuddy
|
|
release, set `SIDECAR_TAG=bambuddy-X.Y.Z` in `.env` and re-run the two
|
|
commands above.
|
|
|
|
## Troubleshooting
|
|
|
|
- **`address already in use` on port 3000 or 3002** — Bambuddy's
|
|
virtual-printer feature owns those. Don't change `ORCA_API_PORT` to
|
|
3000 or 3002.
|
|
- **`/health` reports `version: "unknown"`** — cosmetic. The bundled
|
|
binary works; the wrapper just couldn't parse the version string from
|
|
the slicer's `--help` output (BambuStudio's format differs from
|
|
OrcaSlicer's, which is what the wrapper was tuned for).
|
|
- **Slice returns "Failed to slice the model"** — the wrapper hides the
|
|
CLI's stderr. Re-run inside the container to see it:
|
|
|
|
```bash
|
|
docker exec orca-slicer-api /app/squashfs-root/AppRun --slice 1 \
|
|
--load-settings "/path/to/printer.json;/path/to/preset.json" \
|
|
--load-filaments /path/to/filament.json \
|
|
--allow-newer-file --outputdir /tmp/out /path/to/model.3mf
|
|
```
|