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 LAN Mode

Enable LAN 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 LAN Mode

Bambuddy connects to your printer via LAN Mode - a local connection that works without internet.

Why LAN Mode?

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

  • Works offline - No internet required
  • Fast response - Direct local connection
  • Your data stays local - No cloud dependency

Step 1: Enable Developer Mode (if required)

Some printer models require Developer Mode first:

  1. On your printer's touchscreen, go to Settings
  2. Navigate to General or About
  3. Look for Developer Mode and enable it

Note

Not all printers require this step. If you don't see Developer Mode, proceed to Step 2.

Step 2: Enable LAN Mode

  1. Go to Settings Network LAN Mode
  2. Toggle LAN Mode to ON
  3. Note down the Access Code displayed (8 characters)

Access Code Changes

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

Step 3: 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 LAN 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?