moonraker/README.md

Moonraker - API Web Server for Klipper

Moonraker is a Python 3 based web server that exposes APIs with which client applications may use to interact with Klipper. Communcation between the Klippy host and Moonraker is done over a Unix Domain Socket. Tornado is used to provide Moonraker's server functionality.

Documentation for users and developers can be found on Read the Docs.

Clients

Note that Moonraker does not come bundled with a client, you will need to install one. The following clients are currently available:

• Mainsail by Mainsail-Crew
• Fluidd by Cadriel
• KlipperScreen by jordanruthe
• mooncord by eliteSchwein

Raspberry Pi Images

Moonraker is available pre-installed with the following Raspberry Pi images:

• MainsailOS by Mainsail-Crew
  • Includes Klipper, Moonraker, and Mainsail
• FluiddPi by Cadriel
  • Includes Klipper, Moonraker, and Fluidd

Docker Containers

The following projects deploy Moonraker via Docker:

• prind by mkuf
  • A suite of containers which allow you to run Klipper in Docker. Includes support for OctoPrint and Moonraker.

Changes

This section contains changelogs that users and developers may reference to see if any action is necessary on their part. The date of the most recent change is included.

Users:
user_changes.md - Febuary 22nd 2022

Developers:
api_changes.md - March 4th 2022