2023-06-15 12:58:13 +08:00
|
|
|
# Welcome to Moonraker Documentation
|
|
|
|
|
|
|
|
|
|
Moonraker is a Python 3 based web server that exposes APIs with which
|
|
|
|
|
client applications may use to interact with the 3D printing firmware
|
2024-09-02 13:31:06 +08:00
|
|
|
[Klipper](https://github.com/Klipper3d/klipper). Communication between
|
2023-06-15 12:58:13 +08:00
|
|
|
the Klippy host and Moonraker is done over a Unix Domain Socket. Tornado
|
|
|
|
|
is used to provide Moonraker's server functionality.
|
|
|
|
|
|
|
|
|
|
Users should refer to the [Installation](installation.md) and
|
|
|
|
|
[Configuration](configuration.md) sections for documentation on how
|
|
|
|
|
to install and configure Moonraker.
|
|
|
|
|
|
|
|
|
|
Client developers may refer to the [Client API](web_api.md)
|
|
|
|
|
documentation.
|
|
|
|
|
|
|
|
|
|
Backend developers should refer to the
|
2024-09-02 13:31:06 +08:00
|
|
|
[contributing](contributing.md) section for basic contribution
|
2023-06-15 12:58:13 +08:00
|
|
|
guidelines prior to creating a pull request. The
|
|
|
|
|
[components](components.md) document provides a brief overview
|
|
|
|
|
of how to create a component and interact with Moonraker's
|
|
|
|
|
primary internal APIs.
|
