Welcome to OctoPrint’s documentation!
OctoPrint provides a snappy web interface for controlling consumer 3D printers. It is Free Software and released under the GNU Affero General Public License V3.
Its website can be found at octoprint.org.
The community forum is available at community.octoprint.org.
The FAQ can be accessed by following faq.octoprint.org.
The official plugin repository can be reached at plugins.octoprint.org.
OctoPrint’s development wouldn’t be possible without the financial support by its community. If you enjoy OctoPrint, please consider becoming a regular supporter!
Note
This documentation currently focuses primarily on developers and less on end users. If you are interested in helping to change this, please get in touch on the forum!
Contents
- Features
- Bundled Plugins
- Action Command Notification support
- Action Command Prompt support
- Announcement Plugin
- Anonymous Usage Tracking Plugin
- Application Keys Plugin
- Backup Plugin
- Discovery Plugin
- Error Tracking Plugin
- File Check
- Firmware Check
- GCode Viewer Plugin
- Logging
- Plugin Manager
- Software Update Plugin
- Virtual Printer
- Configuration
- REST API
- Events
- Development
- Developing Plugins
- Internal Modules
- octoprint.access.users
- octoprint.cli
- octoprint.cli.dev
- octoprint.cli.plugins
- octoprint.cli.server
- octoprint.filemanager
- octoprint.filemanager.analysis
- octoprint.filemanager.destinations
- octoprint.filemanager.storage
- octoprint.filemanager.util
- octoprint.plugin
- octoprint.plugin.core
- octoprint.plugin.types
- octoprint.printer
- octoprint.printer.profile
- octoprint.schema
- octoprint.schema.config
- octoprint.schema.webcam
- octoprint.server
- octoprint.server.util
- octoprint.server.util.flask
- octoprint.server.util.sockjs
- octoprint.server.util.tornado
- octoprint.settings
- octoprint.slicing
- octoprint.slicing.exceptions
- octoprint.util
- octoprint.util.commandline
- octoprint.util.platform
- JavaScript Client Library
OctoPrintClient
OctoPrintClient.browser
OctoPrintClient.connection
OctoPrintClient.control
OctoPrintClient.files
OctoPrintClient.job
OctoPrintClient.languages
OctoPrintClient.logs
OctoPrintClient.printer
OctoPrintClient.printerprofiles
OctoPrintClient.settings
OctoPrintClient.slicing
OctoPrintClient.socket
OctoPrintClient.system
OctoPrintClient.timelapse
OctoPrintClient.users
OctoPrintClient.util
OctoPrintClient.wizard