2020-07-02 04:21:35 +03:00
|
|
|
# Moonraker - API Web Server for Klipper
|
|
|
|
|
|
|
|
|
|
Moonraker is a Python 3 based web server that exposes APIs with which
|
2021-03-16 15:35:18 +03:00
|
|
|
client applications may use to interact with
|
|
|
|
|
[Klipper](https://github.com/KevinOConnor/klipper). Communcation between
|
2020-10-01 01:08:41 +03:00
|
|
|
the Klippy host and Moonraker is done over a Unix Domain Socket. Tornado
|
|
|
|
|
is used to provide Moonraker's server functionality.
|
2020-07-02 04:21:35 +03:00
|
|
|
|
2021-03-16 15:35:18 +03:00
|
|
|
Documentation for users and developers can be found on
|
|
|
|
|
[Read the Docs](https://moonraker.readthedocs.io/en/latest/).
|
|
|
|
|
|
2021-11-05 22:21:18 +03:00
|
|
|
### Clients
|
|
|
|
|
|
2020-10-01 01:08:41 +03:00
|
|
|
Note that Moonraker does not come bundled with a client, you will need to
|
2020-12-16 20:39:46 +03:00
|
|
|
install one. The following clients are currently available:
|
2021-11-05 22:26:41 +03:00
|
|
|
|
2021-11-13 22:45:32 +03:00
|
|
|
- [Mainsail](https://github.com/mainsail-crew/mainsail) by Meteyou
|
2021-11-05 22:21:18 +03:00
|
|
|
- [Fluidd](https://github.com/fluidd-core/fluidd) by Cadriel
|
2020-12-16 20:39:46 +03:00
|
|
|
- [KlipperScreen](https://github.com/jordanruthe/KlipperScreen) by jordanruthe
|
2021-03-29 19:05:23 +03:00
|
|
|
- [mooncord](https://github.com/eliteSchwein/mooncord) by eliteSchwein
|
2020-11-19 19:43:54 +03:00
|
|
|
|
2021-11-05 22:26:41 +03:00
|
|
|
### Raspberry Pi Images
|
|
|
|
|
|
|
|
|
|
Moonraker is available pre-installed with the following Raspberry Pi images:
|
|
|
|
|
|
|
|
|
|
- [MainsailOS](https://github.com/raymondh2/MainsailOS) by Ray
|
|
|
|
|
- Includes Klipper, Moonraker, and Mainsail
|
|
|
|
|
- [FluiddPi](https://github.com/fluidd-core/FluiddPi) by Cadriel
|
|
|
|
|
- Includes Klipper, Moonraker, and Fluidd
|
|
|
|
|
|
2021-11-05 22:35:54 +03:00
|
|
|
### Docker Containers
|
|
|
|
|
|
|
|
|
|
The following projects deploy Moonraker via Docker:
|
|
|
|
|
|
|
|
|
|
- [prind](https://github.com/mkuf/prind) by mkuf
|
|
|
|
|
- A suite of containers which allow you to run Klipper in
|
|
|
|
|
Docker. Includes support for Octoprint and Moonraker.
|
|
|
|
|
|
2020-11-19 19:43:54 +03:00
|
|
|
### 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:\
|
2021-12-24 20:35:46 +03:00
|
|
|
[user_changes.md](https://moonraker.readthedocs.io/en/latest/user_changes/) - December 24th 2021
|
2020-11-19 19:43:54 +03:00
|
|
|
|
|
|
|
|
Developers:\
|
2021-03-16 15:35:18 +03:00
|
|
|
[api_changes.md](https://moonraker.readthedocs.io/en/latest/api_changes/) - March 15th 2021
|
