Articles on: About SimplyPrint

How to install an OctoPrint plugin

Finding the plugin manager



Plugins can enhance the experience and features built into OctoPrint. This is a guide to the 3 different ways of installing them on your Raspberry Pi. All plugins are installed manually by opening OctoPrint. Press the wrench at the top bar and a menu will open where you will find most of the options for OctoPrint. In the list on the left, you will find "Plugin manager" under the section "OctoPrint". After clicking on that, a menu will appear with a list of all the plugins already installed on your Raspberry Pi. above that list is a button called "Get More". Click that and it will open a new menu where you will get 3 different methods of installing:

Find the plugin the list



At the top is a search bar where you can type the name of the plugin you want to install and then it should appear in the list below. Once you have found the desired plugin, all you have to do is click on the blue "Install" button and OctoPrint will take care of the rest. When done, it will read "Done!" in the window that opened and a yellow box will appear on the right side with a "Reboot" button. When clicked it will restart your Raspberry and the installation will be complete. (some plugins won't need a reboot)

Install from GitHub link



If you have found an OctoPrint plugin on the plugin repository page you want to install and you can not find it by name in the plugin list, you can copy the URL section and paste it into OctoPrint. After it is inserted you can click install and when it is done it will read "Done!" in the window that opens and a yellow box will appear on the right side with a "Reboot" button. When clicked it will restart your Raspberry and the installation will be complete. (some plugins won't need a reboot)




Install from local file



If you have found an OctoPrint plugin on Github you would like to install and you can not find it by name in the plugin list you can click on the "Code" button in Github and then "Download Zip". Once downloaded, you can go back to Octoprint and click the "Browse" button and select the file from your computer. The Install button should now become active and you can click on it. When done, it will read "Done!" in the window that opens and a yellow box will appear on the right side with a "Reboot" button. When clicked it will restart your Raspberry and the installation will be complete. (some plugins won't need a reboot)


Updated on: 01/08/2021

Was this article helpful?

Share your feedback

Cancel

Thank you!