Skip to main content

Install OpenRAG on Microsoft Windows

If you're using Windows, you must install OpenRAG within the Windows Subsystem for Linux (WSL).

warning

Nested virtualization isn't supported.

OpenRAG isn't compatible with nested virtualization, which can cause networking issues. Don't install OpenRAG on a WSL distribution that is installed inside a Windows VM. Instead, install OpenRAG on your base OS or a non-nested Linux VM.

Install OpenRAG in the WSL​

  1. Install WSL with an Ubuntu distribution using WSL 2:

    wsl --install -d Ubuntu

    For new installations, the wsl --install command uses WSL 2 and Ubuntu by default.

    For existing WSL installations, you can change the distribution and check the WSL version.

  2. Start your WSL Ubuntu distribution if it doesn't start automatically.

  3. Set up a username and password for your WSL distribution.

  4. Install Docker Desktop for Windows with WSL 2. When you reach the Docker Desktop WSL integration settings, make sure your Ubuntu distribution is enabled, and then click Apply & Restart to enable Docker support in WSL.

    The Docker Desktop WSL integration makes Docker available within your WSL distribution. You don't need to install Docker or Podman separately in your WSL distribution before you install OpenRAG.

  5. Install and run OpenRAG from within your WSL Ubuntu distribution. You can install OpenRAG in your WSL distribution using any of the OpenRAG installation methods.

Troubleshoot OpenRAG in WSL​

If you encounter issues with port forwarding or the Windows Firewall, you might need to adjust the Hyper-V firewall settings to allow communication between your WSL distribution and the Windows host. For more troubleshooting advice for networking issues, see Troubleshooting WSL common issues.