Need help with OctoPrint?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

6.1K Stars 1.5K Forks GNU Affero General Public License v3.0 8.1K Commits 258 Opened issues


OctoPrint is the snappy web interface for your 3D printer!

Services available


Need anything else?

Contributors list

OctoPrint's logo


GitHub release PyPI Build status Community Forum Discord Twitter Follow Contributor Covenant Code style: black Code style: prettier Imports: isort pre-commit

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

The community forum is available at It also serves as central knowledge base.

An invite to the Discord server can be found at

The FAQ can be accessed by following

The documentation is located at

The official plugin repository can be reached at

OctoPrint's development wouldn't be possible without the financial support by its community. If you enjoy OctoPrint, please consider becoming a regular supporter!


You are currently looking at the source code repository of OctoPrint. If you already installed it (e.g. by using the Raspberry Pi targeted distribution OctoPi) and only want to find out how to use it, the documentation might be of more interest for you. You might also want to subscribe to join the community forum at where there are other active users who might be able to help you with any questions you might have.


Contributions of all kinds are welcome, not only in the form of code but also with regards to the official documentation, debugging help in the bug tracker, support of other users on the community forum at or the official discord at and also financially.

If you think something is bad about OctoPrint or its documentation the way it is, please help in any way to make it better instead of just complaining about it -- this is an Open Source Project after all :)

For information about how to go about submitting bug reports or pull requests, please see the project's Contribution Guidelines.


Installation instructions for installing from source for different operating systems can be found on the forum.

If you want to run OctoPrint on a Raspberry Pi, you really should take a look at OctoPi which is a custom SD card image that includes OctoPrint plus dependencies.

The generic steps that should basically be done regardless of operating system and runtime environment are the following (as regular user, please keep your hands off of the

command here!) - this assumes you already have Python 2.7, 3.6 or 3.7, pip and virtualenv and their dependencies set up on your system:
  1. Create a user-owned virtual environment therein:
    virtualenv venv
    . If you want to specify a specific python to use instead of whatever version your system defaults to, you can also explicitly require that via the
    parameter, e.g.
    virtualenv --python=python3 venv
  2. Install OctoPrint into that virtual environment:
    ./venv/bin/pip install OctoPrint

You may then start the OctoPrint server via

, see Usage for details.

After installation, please make sure you follow the first-run wizard and set up access control as necessary.


OctoPrint depends on a few python modules to do its job. Those are automatically installed when installing OctoPrint via


OctoPrint currently supports Python 2.7, 3.6 and 3.7.


Running the pip install via

pip install OctoPrint

installs the

script in your Python installation's scripts folder (which, depending on whether you installed OctoPrint globally or into a virtual env, will be in your
or not). The following usage examples assume that the
script is on your

You can start the server via

octoprint serve

By default it binds to all interfaces on port 5000 (so pointing your browser to
will do the trick). If you want to change that, use the additional command line parameters
, which accept the host ip to bind to and the numeric port number respectively. If for example you want the server to only listen on the local interface on port 8080, the command line would be
octoprint serve --host= --port=8080

Alternatively, the host and port on which to bind can be defined via the config file.

If you want to run OctoPrint as a daemon (only supported on Linux), use

octoprint daemon {start|stop|restart} [--pid PIDFILE]

If you do not supply a custom pidfile location via

, it will be created at

You can also specify the config file or the base directory (for basing off the

folders), e.g.:
octoprint serve --config /path/to/another/config.yaml --basedir /path/to/my/basedir

To start OctoPrint in safe mode - which disables all third party plugins that do not come bundled with OctoPrint - use the

octoprint serve --safe


octoprint --help
for more information on the available command line parameters.

OctoPrint also ships with a

script in its source directory. You can invoke it to start the server. It takes the same command line arguments as the


If not specified via the command line, the config file

for OctoPrint is expected in the settings folder, which is located at
on Linux, at
on Windows and at
~/Library/Application Support/OctoPrint
on MacOS.

A comprehensive overview of all available configuration settings can be found in the docs. Please note that the most commonly used configuration settings can also easily be edited from OctoPrint's settings dialog.

Special Thanks

Cross-browser testing services are kindly provided by BrowserStack.

Profiling is done with the help of PyVmMonitor.

Error tracking is powered and sponsored by Sentry.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.