Skip to content
Product Documentation

Running PageBuilder Engine on Windows

PageBuilder Engine runs on Windows operating systems with standard configuration. There are differences between WSL (Windows Subsystem for Linux) versions when working on your bundle code. We suggest using WSL2 to run PageBuilder Engine which is more natively integrated with Docker Windows Desktop.

DockerDocs: Install Docker Desktop on Windows

Before running PageBuilder Engine

  1. Ensure you are running on the latest version of Docker Desktop
  2. Add DB_ROOT=/data/mongo/ to the .env file

Using WSL command line to run Engine

While using WSL2 for your baseline environment for PageBuilder Engine, it’s a good idea to stick with running your fusion-cli commands inside your WSL terminal instead of Microsoft Terminal (or Powershell) even though fusion-cli runs on windows shell will still communicate with docker properly. To do this, make sure you are in linux shell before running any fusion-cli commands.

Manually creating zip for deployments

fusion zip doesn’t work on Windows. In order to deploy your bundle you will need to zip it first. As a workaround, to run the equivalent of zip on windows select all the files in the fusion folder except data, dist, mocks and node_modules and use the windows zip tool.

Create zip for deployments

If the Engine not re-building automatically when files change - WSL1 vs WSL2 configuration

When running Engine through WSL, there are differences between WSL1 and WSL2. Engine works on both WSL versions but you need to make sure your bundle source is placed in the correct filesystem in each WSL version in order for webpack file watching to work.

  • If you are using WSL1, make sure you place your files in Windows Filesystem (host) in order to get webpack file watching work.
  • If you are using WSL2, your Engine bundle source needs to be placed inside the Linux OS filesystem in order to get webpack file watching working.