mirror of
https://github.com/maziggy/bambuddy.git
synced 2026-09-30 03:01:21 +02:00
114 lines
4.2 KiB
Markdown
114 lines
4.2 KiB
Markdown
# Bambuddy
|
|
|
|
**Self-hosted print archive and management system for Bambu Lab 3D printers.**
|
|
|
|
No cloud dependency. Complete privacy. Full control.
|
|
|
|
[](https://github.com/maziggy/bambuddy)
|
|
[](https://github.com/maziggy/bambuddy/blob/main/LICENSE)
|
|
[](https://discord.gg/aFS3ZfScHM)
|
|
|
|
## Quick Start
|
|
|
|
```bash
|
|
mkdir bambuddy && cd bambuddy
|
|
curl -O https://raw.githubusercontent.com/maziggy/bambuddy/main/docker-compose.yml
|
|
docker compose up -d
|
|
```
|
|
|
|
Open **http://localhost:8000** and add your printer.
|
|
|
|
> **Requirements:** Bambu Lab printer with Developer Mode enabled, on the same local network.
|
|
|
|
## Supported Architectures
|
|
|
|
| Architecture | Tag |
|
|
|---|---|
|
|
| x86-64 (Intel/AMD) | `amd64` |
|
|
| arm64 (Raspberry Pi 4/5) | `arm64` |
|
|
|
|
## Features
|
|
|
|
- **Real-Time Monitoring** — Live printer status, camera streaming, HMS error tracking (853 codes translated), resizable multi-printer dashboard
|
|
- **Print Archive** — Automatic 3MF archiving with metadata, interactive 3D model viewer (Three.js), photo attachments, failure analysis, side-by-side comparison
|
|
- **Print Scheduling** — Drag-and-drop queue, multi-printer assignment by model or location, time-based scheduling, re-print with AMS mapping
|
|
- **Smart Automation** — Smart plug control (Tasmota, Home Assistant, MQTT), auto power-on/off, energy monitoring, maintenance reminders
|
|
- **Proxy Mode** — Print remotely from Bambu Studio/OrcaSlicer without VPN or port forwarding, end-to-end TLS encrypted
|
|
- **Notifications** — WhatsApp, Telegram, Discord, Email, Pushover, ntfy with customizable templates and quiet hours
|
|
- **Projects** — Group related prints, track parts and plates, bill of materials, cost tracking, export as ZIP/JSON
|
|
- **File Manager** — Upload and organize sliced files, folder structure, print directly to any printer
|
|
- **Integrations** — Spoolman filament sync, MQTT publishing, Prometheus metrics, Bambu Cloud profiles, REST API, Home Assistant
|
|
- **Virtual Printer** — Appears in your slicer via SSDP discovery, multiple operating modes (archive, review, queue, proxy)
|
|
- **Security** — Optional authentication with group-based permissions (50+ granular), JWT tokens, API key support
|
|
|
|
## Configuration
|
|
|
|
| Variable | Default | Description |
|
|
|---|---|---|
|
|
| `TZ` | `UTC` | Timezone (e.g. `America/New_York`, `Europe/Berlin`) |
|
|
| `PORT` | `8000` | Web UI port |
|
|
| `PUID` | `1000` | User ID for file permissions |
|
|
| `PGID` | `1000` | Group ID for file permissions |
|
|
| `DEBUG` | `false` | Enable debug logging |
|
|
|
|
## Volumes
|
|
|
|
| Path | Purpose |
|
|
|---|---|
|
|
| `/app/data` | Database, archived prints, thumbnails |
|
|
| `/app/logs` | Application logs |
|
|
|
|
## Docker Compose
|
|
|
|
```yaml
|
|
services:
|
|
bambuddy:
|
|
image: maziggy/bambuddy:latest
|
|
container_name: bambuddy
|
|
network_mode: host
|
|
environment:
|
|
- TZ=America/New_York
|
|
- PUID=1000
|
|
- PGID=1000
|
|
volumes:
|
|
- bambuddy_data:/app/data
|
|
- bambuddy_logs:/app/logs
|
|
restart: unless-stopped
|
|
|
|
volumes:
|
|
bambuddy_data:
|
|
bambuddy_logs:
|
|
```
|
|
|
|
> **macOS/Windows:** Docker Desktop doesn't support `network_mode: host`. Replace it with `ports: ["8000:8000"]` and add printers manually by IP.
|
|
|
|
## Updating
|
|
|
|
```bash
|
|
docker compose pull && docker compose up -d
|
|
```
|
|
|
|
## Supported Printers
|
|
|
|
| Series | Models | Status |
|
|
|---|---|---|
|
|
| H2 | H2C, H2D, H2D Pro, H2S | Tested |
|
|
| X1 | X1 Carbon, X1E | Tested |
|
|
| P1 | P1P, P1S | Compatible |
|
|
| P2 | P2S | Compatible |
|
|
| A1 | A1, A1 Mini | Compatible |
|
|
|
|
All printers require **Developer Mode** enabled for LAN access.
|
|
|
|
## Links
|
|
|
|
- **Website:** [bambuddy.cool](https://bambuddy.cool)
|
|
- **Documentation:** [wiki.bambuddy.cool](http://wiki.bambuddy.cool)
|
|
- **GitHub:** [github.com/maziggy/bambuddy](https://github.com/maziggy/bambuddy)
|
|
- **Discord:** [discord.gg/aFS3ZfScHM](https://discord.gg/aFS3ZfScHM)
|
|
- **Issues:** [GitHub Issues](https://github.com/maziggy/bambuddy/issues)
|
|
|
|
## License
|
|
|
|
MIT License - see [LICENSE](https://github.com/maziggy/bambuddy/blob/main/LICENSE) for details.
|