f24269c675 | ||
---|---|---|
build_scripts | ||
Dockerfile | ||
LICENSE | ||
README.md | ||
docker-compose.yaml | ||
klippy.sudoers | ||
klippyoctostart.py | ||
runklipper.py | ||
start.py |
README.md
OctoPrint-Klipper
My version of a Docker image for running OctoPrint and Klipper in a single container. Includes a few plugins I find useful.
Big thanks to sillyfrog for laying the groundwork for this image.
This is very much written for my purposes, so you'll likely need to modify it for your setup. I've been using it for a while now and it's going well. I've successfully run it on these platforms:
- Orange Pi Zero 512MB
- AtomicPi
- Raspberry Pi 4B 1GB (current)
Running the container
Create a directory on your host that will persist config files. I use /home/docker/octoprint-klipper
.
Pull the image. Until I figure out multi platform aware images, you need to specify your arch. Both arm
and amd64
images are on DockerHub. If using Raspberry Pi or similar use arm
in place of [tag]
.
docker pull seanauff/octoprint-klipper:[tag]
Start the container once to populate your config folder:
docker run -d --name octoprint-klipper -e TZ=America/New_York -v /home/docker/octoprint-klipper:/home/octoprint/.octoprint --device /dev/ttyUSB0:/dev/ttyUSB0 -p 5000:5000 seanauff/octoprint-klipper:[tag]
Stop the container, and modify your Klipper printer.cfg
and Octoprint config.yaml
in the config directory as needed.
Restart the container.
A sample docker-compose file is also provided.
If you have any questions, feel free to log an issue on this project, and I'll see if I can help.
Build the image yourself
Clone the repository and build the image:
git clone https://github.com/seanauff/OctoPrint-Klipper.git
docker build -t seanauff/octoprint-klipper OctoPrint-Klipper