Skip to content

Getting Started

Welcome to Bambuddy! This guide will help you get your print archive up and running quickly.

🚀 Quick Install

git clone https://github.com/maziggy/bambuddy.git
cd bambuddy
docker compose up -d

Open http://localhost:8000 in your browser.

Full Docker Guide

git clone https://github.com/maziggy/bambuddy.git
cd bambuddy
python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt
uvicorn backend.app.main:app --host 0.0.0.0 --port 8000

Open http://localhost:8000 in your browser.

Full Installation Guide

👣 Next Steps

Enable Developer Mode

Enable Developer Mode on your printer and note the access code.

See instructions

Add Your Printer

Enter your printer's IP, access code, and serial number.

Add first printer

Start Printing!

Bambuddy automatically archives every print.

Explore features

Enabling Developer Mode

Bambuddy connects to your printer via Developer Mode - a local connection that provides full control without internet.

Why Developer Mode?

Developer Mode provides direct communication between Bambuddy and your printer over your local network. This means:

  • Works offline - No internet required
  • Full control - Start/stop prints, upload files, control lights
  • Your data stays local - No cloud dependency

Developer Mode vs LAN Only Mode

Since the January 2025 firmware update, standard LAN Only Mode (without Developer Mode) only provides read-only access. You can monitor your printer, but you cannot control it. Developer Mode is required for full functionality with Bambuddy.

Step 1: Enable LAN Only Mode

  1. On your printer's touchscreen, go to Settings
  2. Navigate to Network or WLAN
  3. Toggle LAN Only Mode to ON

Step 2: Enable Developer Mode

  1. After enabling LAN Only Mode, a Developer Mode option will appear
  2. Toggle Developer Mode to ON
  3. Note down the Access Code displayed (8 characters)

Access Code Changes

The access code changes every time you toggle these modes off and on. If you re-enable Developer Mode, you'll need to update the access code in Bambuddy.

Step 3: Insert SD Card

SD Card Required

An SD card must be inserted in your printer for Bambuddy to work properly. The SD card is required for:

  • File transfers to/from the printer
  • Starting prints from Bambuddy
  • Archiving completed prints

Without an SD card, Bambuddy cannot transfer files or start prints on your printer.

Step 4: Gather Printer Information

You'll need these details to add your printer:

Information Where to Find
IP Address Settings Network
Serial Number Settings Device Info
Access Code Shown when Developer Mode is enabled

🏁 What's Next?

Add Your Printer
Connect your first printer

Print Archiving
How automatic archiving works

Notifications
Get alerts on your phone

Troubleshooting
Having issues?