Portainer Templates logo

Portainer Templates

Klipper[Testing], Mainsail, Moonraker Klipper[Testing], Mainsail, Moonraker

Stack

Other3D PrintersTools

Klipper is a 3d-Printer firmware. It combines the power of a general purpose computer with one or more micro-controllers. See the features document for more information on why you should use Klipper.

Configuration

Type
Compose
Platform
linux
Env vars
3D_PRINTER_DEVICE=/dev/ttymxc3
Restart
unless-stopped
Source
Repo

Template by novaspirit·Source

Notes

Template created by Pi-Hosted Series
Check our Github page: https://github.com/pi-hosted/pi-hosted

Official Webpage: https://hub.docker.com/r/mkuf/klipper
Official Docker Documentation: https://hub.docker.com/r/mkuf/klipper

Pre-installation script must be RAN before you install: wget -qO- https://raw.githubusercontent.com/pi-hosted/pi-hosted/master/tools/install_klipper.sh | bash



First you will need to download a printer.conf file from https://github.com/Klipper3d/klipper/tree/master/config and copy it to

Services

klipper

Configuration

Image
mkuf/klipper:latest
Volumes
/opt/printer_data/config/printer.cfg : /portainer/Files/AppData/Config/klipper/klipper/printer.cfg/opt/printer_data/logs : /portainer/Files/AppData/Config/klipper/klipper/logs/opt/printer_data/run : /portainer/Files/AppData/Config/klipper/run/opt/printer_data/gcodes : /portainer/Files/AppData/Config/klipper/gcode
Restart
unless-stopped

Image details

Pulls: 286k
User: mkuf
Created: Oct 24, 2021
Updated: 1 day ago
Status: active

moonraker

Configuration

Image
mkuf/moonraker:latest
Ports
7125:7125
Volumes
/opt/printer_data/config/moonraker.conf : /portainer/Files/AppData/Config/klipper/moonraker/moonraker.conf/opt/printer_data/logs : /portainer/Files/AppData/Config/klipper/moonraker/logs/opt/printer_data/run : /portainer/Files/AppData/Config/klipper/run/opt/printer_data/gcodes : /portainer/Files/AppData/Config/klipper/gcode
Restart
unless-stopped

Image details

Pulls: 145k
User: mkuf
Created: Oct 24, 2021
Updated: 8 days ago
Status: active

mainsail

Configuration

Image
ghcr.io/mainsail-crew/mainsail:edge
Ports
4070:80
Volumes
/usr/share/nginx/html/config.json : /portainer/Files/AppData/Config/klipper/mainsail/config.json
Restart
unless-stopped

Image details

User: mainsail-crew

Standalone Install

Select an install method, to see config/commands for deploying Klipper[Testing], Mainsail, Moonraker

Installation method

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select Klipper[Testing], Mainsail, Moonraker, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo
Original stackfile

The compose file this template deploys, straight from its repo:

version: "3"
services:
  klipper:
    hostname: klipper
    image: mkuf/klipper:latest
    devices:
      - ${3D_PRINTER_DEVICE}:${3D_PRINTER_DEVICE}
    volumes:
      - /portainer/Files/AppData/Config/klipper/klipper/printer.cfg:/opt/printer_data/config/printer.cfg
      - /portainer/Files/AppData/Config/klipper/klipper/logs:/opt/printer_data/logs
      - /portainer/Files/AppData/Config/klipper/run:/opt/printer_data/run
      - /portainer/Files/AppData/Config/klipper/gcode:/opt/printer_data/gcodes
    restart: unless-stopped
    networks:
      - klipper

  moonraker:
    hostname: moonraker
    image: mkuf/moonraker:latest
    ports:
      - "7125:7125"
    volumes:
      - /portainer/Files/AppData/Config/klipper/moonraker/moonraker.conf:/opt/printer_data/config/moonraker.conf
      - /portainer/Files/AppData/Config/klipper/moonraker/logs:/opt/printer_data/logs
      - /portainer/Files/AppData/Config/klipper/run:/opt/printer_data/run
      - /portainer/Files/AppData/Config/klipper/gcode:/opt/printer_data/gcodes
    restart: unless-stopped
    networks:
      - klipper

  mainsail:
    hostname: mainsail
    image: ghcr.io/mainsail-crew/mainsail:edge
    ports:
      - "4070:80"
    volumes:
      - /portainer/Files/AppData/Config/klipper/mainsail/config.json:/usr/share/nginx/html/config.json
    restart: unless-stopped
    networks:
      - klipper

networks:
  klipper:

Or deploy it directly from the source:

git clone https://github.com/pi-hosted/pi-hosted/
cd pi-hosted
docker compose -f stack/klipper.yml up -d

More install options in our documentation.

Container Documentation

klipper Documentation

Klipper is a 3d-Printer firmware.

moonraker Documentation

Web API used to interact with the 3D printing firmware Klipper.

Serve Klipper[Testing], Mainsail, Moonraker on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxying klipper-testing-mainsail-moonraker.example.com to http://mainsail:80

Add this to your Caddyfile

klipper-testing-mainsail-moonraker.example.com {
	reverse_proxy http://mainsail:80
}

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs <container>
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Port already in use

If deployment fails with "Bind for 0.0.0.0:7125 failed: port is already allocated", something else on your server is using that port.

  • Find what's using it: sudo ss -tlnp | grep :7125
  • Stop the other service, or pick a different host port. In 7125:7125 only the left number is yours to change, the right one belongs to the app.

Running but the page won't load

The container is up but nothing appears in your browser.

  • Use your server's real IP: http://your-server-ip:4070. The 0.0.0.0 link Portainer shows isn't a real address.
  • Give it a minute after first deploy, klipper-mainsail-moonraker can take a while to initialise.
  • Make sure your firewall allows the port, e.g. sudo ufw allow 4070

Permission denied on volumes

If the logs show "permission denied", the app can't write to its data folder on the host.

  • Fix the ownership: sudo chown -R 1000:1000 /portainer/Files/AppData/Config/klipper/klipper/printer.cfg (and the same for the other mapped folders)

Image won't pull

Test the pull directly on the host: docker pull mkuf/klipper:latest

  • "manifest unknown" means the tag no longer exists. This template uses latest, so try pinning a specific version instead.
  • "toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
  • "no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Container keeps restarting

The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.

  • Check the logs right after a restart, the last few lines before it died are the useful ones.
  • Get the exit code with docker inspect <container> --format '{{.State.ExitCode}}'
  • Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Stack won't deploy

Compose stacks fail fast on small mistakes, and Portainer shows the reason just above the editor.

  • YAML only accepts spaces for indentation, a single tab breaks the whole file.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

A Compose stack

Klipper[Testing], Mainsail, Moonraker is a Compose stack, a set of containers (3 of them) defined in one file and brought up together by Portainer, then started and stopped as a single app.

The services

This stack is built from 3 containers that run side by side. Here's each one, with the image it runs and anything it waits for first:

  • klipper runs mkuf/klipper:latest
  • moonraker runs mkuf/moonraker:latest
  • mainsail runs ghcr.io/mainsail-crew/mainsail:edge

Ports

A port is the door the app answers on. A mapping like 7125:7125 means it's reachable on port 7125 of your server, where the left number is yours to change and the right one belongs to the app. Once it's running, open http://your-server-ip:4070 in a browser. It opens:

  • 7125:7125
  • 4070:80, likely the web interface

Volumes

A volume is where Klipper[Testing], Mainsail, Moonraker keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:

  • /opt/printer_data/config/printer.cfg from /portainer/Files/AppData/Config/klipper/klipper/printer.cfg on the host
  • /opt/printer_data/logs from /portainer/Files/AppData/Config/klipper/klipper/logs on the host
  • /opt/printer_data/run from /portainer/Files/AppData/Config/klipper/run on the host
  • /opt/printer_data/gcodes from /portainer/Files/AppData/Config/klipper/gcode on the host
  • /opt/printer_data/config/moonraker.conf from /portainer/Files/AppData/Config/klipper/moonraker/moonraker.conf on the host
  • /opt/printer_data/logs from /portainer/Files/AppData/Config/klipper/moonraker/logs on the host
  • /usr/share/nginx/html/config.json from /portainer/Files/AppData/Config/klipper/mainsail/config.json on the host

Restart policy

The restart policy here is unless-stopped, so Docker restarts Klipper[Testing], Mainsail, Moonraker after a crash or reboot, but leaves it off when you stop it on purpose. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).

Networking

Portainer puts these services on one shared private network, so they can find each other by name (like klipper) while only the ports above are open to you.

Platform

The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Klipper[Testing], Mainsail, Moonraker up. Add the template list to Portainer once, then deploying Klipper[Testing], Mainsail, Moonraker is a click rather than a wall of config.