Setting up OctoPrint on Windows

foosel · February 6, 2021, 10:06am

The guide does not say to install python from the windows store but from python.org.

Tremayne_Oglesby · February 6, 2021, 6:18pm

WARNING: You are using pip version 20.3.3; however, version 21.0.1 is available.
You should consider upgrading via the 'c:\users\me\appdata\local\programs\python\python39\python.exe -m pip install --upgrade pip' command.

C:\WINDOWS\system32>pip install --upgrade pip
Requirement already satisfied: pip in c:\users\me\appdata\local\programs\python\python39\lib\site-packages (20.3.3)
Collecting pip
Downloading pip-21.0.1-py3-none-any.whl (1.5 MB)
|████████████████████████████████| 1.5 MB 6.4 MB/s
Installing collected packages: pip
Attempting uninstall: pip
Found existing installation: pip 20.3.3
Uninstalling pip-20.3.3:
Successfully uninstalled pip-20.3.3
ERROR: Could not install packages due to an EnvironmentError: [WinError 5] Access is denied: 'C:\Users\ME\AppData\Local\Temp\pip-uninstall-sxzvgzqv\pip.exe'
Consider using the --user option or check the permissions.
Can someone help me understand this

foosel · February 6, 2021, 6:22pm

It told you to run python -m pip install --upgrade pip. What you ran is pip install --upgrade pip. That won't work because under Windows it's not possible to modify a file that's currently being executed (pip). Do what pip told you to run

Tremayne_Oglesby · February 6, 2021, 6:49pm

thank you.

neoOpus · February 7, 2021, 5:11am

The guide doesn't say but some people have it already installed via the store (including me) and we don't want to install another copy via regular installer, some other have it installed via choco and other package distribution... so I just posted to help some figure out the issue! I stopped with the experimentation myself as I didn't want to install the other stuff now... so I am going back to this later.

Zack_Jones · February 14, 2021, 10:13pm

When I try to do the command C:\OctoPrint\venv\Scripts\octoprint.exe serve I get this error. How do I fix this?

(venv) C:\OctoPrint>octoprint serve
Traceback (most recent call last):
  File "c:\users\zack\appdata\local\programs\python\python39\lib\runpy.py", line 197, in _run_module_as_main
    return _run_code(code, main_globals, None,
  File "c:\users\zack\appdata\local\programs\python\python39\lib\runpy.py", line 87, in _run_code
    exec(code, run_globals)
  File "C:\OctoPrint\venv\Scripts\octoprint.exe\__main__.py", line 7, in <module>
  File "c:\octoprint\venv\lib\site-packages\octoprint\__init__.py", line 933, in main
    from octoprint.util.fixes import patch_sarge_async_on_py2
  File "c:\octoprint\venv\lib\site-packages\octoprint\util\__init__.py", line 41, in <module>
    from octoprint.util.connectivity import ConnectivityChecker  # noqa: F401
  File "c:\octoprint\venv\lib\site-packages\octoprint\util\connectivity.py", line 12, in <module>
    from octoprint.util.net import resolve_host, server_reachable
  File "c:\octoprint\venv\lib\site-packages\octoprint\util\net.py", line 14, in <module>
    import netifaces
ImportError: DLL load failed while importing netifaces: %1 is not a valid Win32 application.

Charlie_Powell · February 15, 2021, 10:32am

Sounds like the Python install has not gone correctly. How did you install it? What version of Python have you installed? You could try reinstalling it I guess.

The_Ben · March 18, 2021, 1:27am

I am wondering the same thing.
In the setting, Server what do we input for "Restart OctoPrint" ? Instead of killing the process and running the .vbs again ?

ChukG · June 2, 2021, 6:04pm

I have this same problem too. Python works, correct version shows up, but "import netifaces" gives an error whether I do it in python or as part of the OctoPrint install.

Charlie_Powell · June 2, 2021, 8:24pm

How did you install it? Through the windows store, did you install for all users (as admin)?

ChukG · June 2, 2021, 9:38pm

From the installer from python.org. It was working until I tried to update OctoPrint last week.

bcat · September 19, 2021, 5:48am

Thanks to all who've contributed to this guide so far! I know Linux is the most common environment for OctoPrint, but given the limited availability of Raspberry Pi units in my area and the fact that I have a Windows PC (old desktop repurposed as backup server, basic workstation for Chrome & Cura, etc.) already running right near my printer, I figured I'd see how well I could make this setup work.

The PC in question is shared by multiple users, rebooted periodically, etc., so I wanted to come up with a foolproof Windows service setup. I also tried to mirror the Pi setup where I could (e.g., running a reverse proxy even though it's not strictly needed) to avoid weird issues down the line.

So, here's a guide to setting up OctoPrint, cam2web (MJPEG server), and Caddy (reverse proxy) as Windows services that automatically start on reboot, can easily be stopped/restarted at will, redirect stderr to files for debugging, etc.

OctoPrint setup

First off, install OctoPrint itself, but don't run it yet:

Install Python and Visual Studio Build tools as described in the core guide above.
Since we're going to run as a service and try to follow idiomatic Windows practices, install OctoPrint to C:\Program Files\OctoPrint rather than the recommended path. (You'll need to elevate via a UAC prompt, but don't worry, the actual service will run as a user with limited privileges.)
Since we don't have a virtual service account for OctoPrint yet, skip the steps involving running octoprint serve at this time.

cam2web (MJPEG server) setup

The standard guide recommends Yawcam, and there's really nothing wrong with it, but it's a Java application. I strongly dislike having to install the JRE on home PCs, and as a Java app I've seen Yawcam use more than 1 GiB of RAM.

That's not ideal in my opinion, so I prefer cam2web. It requires no special dependencies, has a much cleaner UI, and uses almost no RAM. Set it up as follows:

Download the latest release from GitHub..
Since cam2web doesn't ship with a sample configuration file, this time you will want to run it once manually as your normal user account.
Set up your camera as appropriate in the cam2web GUI, making sure you can access it at http://127.0.0.1:8000/camera/mjpeg.
Exit the cam2web GUI, stopping the streaming server in the process.
Navigate to the %USERPROFILE%\cam2web folder and copy (or move, if you prefer) the app.cfg file from that directory to C:\Program Files\cam2web.

As I write this in September 2021, the latest prebuilt Windows binary on cam2web's GitHub is outdated (from 2017). The latest Git HEAD has been improved to use a lot less CPU when not actively serving traffic, dropping from around 8% idle CPU usage (comparable to YawCam) to around 0.1% on my system. As such, you may want to build from source (which can be done with the free Visual Studio Community) instead.

Caddy (reverse proxy) setup

OctoPi uses HAProxy as a reverse proxy to make both OctoPrint and mjpg-streamer accessible on port 80, but HAProxy doesn't seem to have a Windows port. The de facto standard nginx does have a Windows port, but it has a number of limitations compared to the Linux version, and additionally, nginx requires extra configuration to proxy WebSocket traffic correctly (required for OctoPrint to work).

Instead, let's use Caddy, a lightweight, cross-platform reverse proxy written in Go. Here's how we'll set it up:

Download the latest release from Caddy's Web site and unpack it to C:\Program Files\Caddy.
Create a Caddy configuration file in C:\Program Files\Caddy\Caddyfile with the following contents:

{
	# Disable the REST API that listens on port 2019 by default since we do not
	# need to dynamically reconfigure Caddy.
	admin off
}
:80 {
	# Proxy traffic to OctoPrint backend by default.
	reverse_proxy 127.0.0.1:5000
	# Proxy webcam traffic to the cam2web backend instead.
	reverse_proxy /camera/* 127.0.0.1:8000 {
		# Disable buffering for MJPEG streams to reduce latency.
		flush_interval -1
		# Disable chunked encoding since the OctoEverywhere plugin's HTTP proxy
		# doesn't handle it correctly (truncating the webcam stream instead).
		header_down Transfer-encoding identity
	}
}

Caddy is really powerful, and I encourage y'all to read their docs and see what it can do. But the above should be enough to get you started. It's probably fine to leave their admin API on (I think it only listens on localhost), but I had no need for it and felt safer turning it off, so that's what I did for my own setup.

You can remove the Transfer-encoding: identity hack if you don't care about using OctoEverywhere for remote access, or if they fix the relevant bug in their HTTP proxy. For now, though, it doesn't hurt to leave it around, since there's really no reason to care about keep-alive for the camera backend anyway.

Creating Windows services

At this point, you should have all the relevant software installed and configured, and none of it running. Let's fix that. Since none of these applications natively implement Windows services, we'll need a service wrapper to run them. There's a number of options, but I've found nssm to be easy and effective:

Download the latest release of nssm and unpack it to C:\Program Files\nssm.
Open an elevated Command Prompt (right click and select "Run as administrator"), then CD "C:\Program Files\nssm".

Now we're ready to install some services! Rather than running as a highly privileged user, we'll give each binary its own virtual service account that will only have access to the files it actually needs at runtime.

OctoPrint service

From the elevated Command Prompt, run nssm install OctoPrint. Configure as follows:

Application > Application > Path: C:\Program Files\OctoPrint\venv\Scripts\octoprint.exe
Application > Application > Startup directory: C:\Program Files\OctoPrint\venv
Application > Application > Arguments: --basedir "C:\Program Files\OctoPrint\config" serve
Log on > Log on as > Virtual service account
I/O > I/O redirection > Output (stdout): C:\Program Files\OctoPrint\service.log
I/O > I/O redirection > Error (stderr): C:\Program Files\OctoPrint\service.log

cam2web service

From the elevated Command Prompt, run nssm install cam2web. Configure as follows:

Application > Application > Path: C:\Program Files\cam2web\cam2web.exe
Application > Application > Startup directory: C:\Program Files\cam2web\cam2web
Application > Application > Arguments: /start /fcfg:"C:\Program Files\cam2web\app.cfg"
Log on > Log on as > Virtual service account
I/O > I/O redirection > Output (stdout): C:\Program Files\cam2web\service.log
I/O > I/O redirection > Error (stderr): C:\Program Files\cam2web\service.log

Caddy service

From the elevated Command Prompt, run nssm install Caddy. Configure as follows:

Application > Application > Path: C:\Program Files\Caddy\caddy.exe
Application > Application > Startup directory: C:\Program Files\Caddy\caddy.exe
Application > Application > Arguments: run
Log on > Log on as > Virtual service account
I/O > I/O redirection > Output (stdout): C:\Program Files\Caddy\service.log
I/O > I/O redirection > Error (stderr): C:\Program Files\Caddy\service.log

Setting folder permissions for service accounts

Now we've got all the relevant software installed and services set up, but if we start any of the services now, they'll fail in various ways since their virtual service accounts don't have access to the appropriate files yet. Fix that as follows:

Open C:\Program Files\OctoPrint in File Explorer.
Right click on the folder and select "Properties".
Switch to the "Security" tab.
Click "Edit", then click "Add".
In the "Enter the object names to select" text box, type NT Service\OctoPrint (the name of the virtual service account that Windows automatically created).
Click "Okay".
Now, under "Permissions for OctoPrint", find the row saying "Full control" and check the "Allow box".
Click "OK" to save the security settings, then close the Properties dialog.

This gives OctoPrint access to the relevant directory, but not the rest of your filesystem. Repeat these steps for the directories where you installed cam2web and Caddy, using the NT Service\cam2web and NT Service\Caddy user names, respectively.

Wrapping up

Okay! At this point you can safely start the services. Open the "Services" management console, find the three services you created, right click on each, and select start.

You should now have an accessible OctoPrint instance listening port 80 that starts automatically on reboot. Browse to http://127.0.0.1/ and configure OctoPrint to your hearts content, using these webcam settings (if you followed my recommended cam2web and Caddy setup):

Stream URL: /camera/mjpeg
Snapshot URL: http://127.0.0.1/camera/jpeg

If you want to see console output from OctoPrint, look in C:\Program Files\OctoPrint\service.log. Same for the other services you set up. To update OctoPrint, stop and start the service through usual means, just like any other Windows service.

Bonus: Restarting OctoPrint from server UI

OctoPrint on Windows doesn't prepopulate the commands to restart itself or the system, but with this service setup, you can do this pretty easily. In the OctoPrint Web app, go to "Settings > OctoPrint > Server > Commands" and enter the following:

Restart OctoPrint: START "" "C:\Program Files\nssm\nssm.exe" restart OctoPrint
Restart system: shutdown /r /c "Restart initiated from OctoPrint."
Shutdown system shutdown /s /c "Shutdown initiated from OctoPrint."

(Note the START command for "Restart OctoPrint". Without this, nssm will end up killing its own restart command when it stops the service, and the service will never come back up. Oops!)

In the weirdness of Windows, the virtual service account has permission to restart (or shut down) the whole system by default... but not to stop or start the service itself. It turns out there's not a convenient way to grant that permission by default, but the SetACL third-party utility makes this easy:

SetACL -on OctoPrint -ot srv -actn ace -ace "n:NT Service\OctoPrint;p:start_stop"

Bonus: Persistent camera settings

Does it frustrate you that your webcam settings (focus, exposure, etc.) reset themselves on every reboot? You can use the WebCameraConfig program to work around that by restoring webcam settings from a file.

If you used nssm to install the cam2web service, you can use the "Hooks" tab of your nssm settings (nssm edit cam2web if you already made the service) to create an "Application start > Successful application startup hook" to restore camera settings every time the cam2web service (re)starts.

Note that my camera seems to require I restore the settings twice for them to actually take effect. I use the following batch file in my "Successful application startup" hook and it works fine:

@ECHO OFF
:: Restore camera settings (focus, exposure, etc.) that do not normally persist
:: across system restarts. Some settings must be set in a particular order or
:: else they have no effect, so we brute force this by simply running twice.
::
:: See also: https://community.octoprint.org/t/setting-up-octoprint-on-windows/383/134?u=bcat
"C:\Program Files (x86)\WebCameraConfig\WebCameraConfig.exe"
"C:\Program Files (x86)\WebCameraConfig\WebCameraConfig.exe"

TTalkington · September 19, 2021, 3:17pm

It's nice to see an alternative streamer for Windows.

My guess is that it's similar to setting those settings on Linux: some settings can only be altered during certain conditions. Such as, you can only set Focus Absolute after setting Focus Auto to manual. The program probably doesn't know the inter-dependencies since they'll vary by camera, so it's just setting things at random, more or less. So, if things are 'out of order' it will take multiple passes to get everything set.

bcat · September 19, 2021, 5:12pm

Oh, yeah, that's a good point. It would explain the behavior I saw. At first I thought it was a race condition between cam2web startup and when the camera settings got applied, but a 30-second sleep didn't change anything. Undocumented ordering dependencies between the individual settings makes sense more sense.

mahdi.eng · November 8, 2021, 2:05pm

Hi foosel, I installed octoprint on my windows .
now my question is how can I connect my windows to the printer and control my 3D printer?

PrintedWeezl · November 8, 2021, 4:08pm

you connect your printer in the webinterface
http://localhost:5000 or http://ip-of-your-pc:5000

Charlie_Powell · November 8, 2021, 4:15pm

You'll need a USB cable as well to connect the printer to the windows machine physically.

mahdi.eng · November 9, 2021, 8:28am

I did not mean that

mahdi.eng · November 9, 2021, 8:30am

thank you. It works.
now how can I access my octo from another computer?

foosel · November 9, 2021, 9:27am

@PrintedWeezl already told you.