From a0b5b5c199f4810e597b2a3b6ad61dac2fa07d99 Mon Sep 17 00:00:00 2001 From: "promptless[bot]" Date: Fri, 1 May 2026 01:48:06 +0000 Subject: [PATCH 1/4] Add Windows (WSL2) setup instructions for Flash Create new documentation page with step-by-step instructions for Windows users to install and configure WSL2 with Ubuntu to run Flash. Update existing platform availability notes in quickstart and overview to link to the new WSL2 guide. --- docs.json | 1 + flash/overview.mdx | 5 +- flash/quickstart.mdx | 2 +- flash/windows-wsl2.mdx | 130 +++++++++++++++++++++++++++++++++++++++++ 4 files changed, 134 insertions(+), 4 deletions(-) create mode 100644 flash/windows-wsl2.mdx diff --git a/docs.json b/docs.json index d464abda..ff57c9f5 100644 --- a/docs.json +++ b/docs.json @@ -50,6 +50,7 @@ "pages": [ "flash/overview", "flash/quickstart", + "flash/windows-wsl2", "flash/pricing", "flash/create-endpoints", "flash/custom-docker-images", diff --git a/flash/overview.mdx b/flash/overview.mdx index 4977ae1d..11c79ef1 100644 --- a/flash/overview.mdx +++ b/flash/overview.mdx @@ -55,8 +55,7 @@ Flash requires a Runpod account with a verified email address. ### Install Flash - -Flash requires [Python 3.10, 3.11, 3.12, or 3.13](https://www.python.org/downloads/) and is currently available for macOS and Linux. +Flash requires [Python 3.10, 3.11, 3.12, or 3.13](https://www.python.org/downloads/) and runs natively on macOS and Linux. Windows users can run Flash through [WSL2](/flash/windows-wsl2). Install Flash using `pip` or `uv`: @@ -110,7 +109,7 @@ flash --help ## Limitations -- Flash is currently only available for macOS and Linux. Windows support is in development. +- Flash runs natively on macOS and Linux. Windows users can run Flash through [WSL2](/flash/windows-wsl2). - CPU endpoints are restricted to the `EU-RO-1` datacenter. GPU endpoints can deploy to [multiple datacenters](/flash/configuration/parameters#datacenter). - Flash can rapidly scale workers across multiple endpoints, and you may hit your maximum worker threshold quickly. Contact [Runpod support](https://www.runpod.io/contact) to increase your account's capacity if needed. diff --git a/flash/quickstart.mdx b/flash/quickstart.mdx index 475e8704..5aa223d4 100644 --- a/flash/quickstart.mdx +++ b/flash/quickstart.mdx @@ -20,7 +20,7 @@ This quickstart gets you running GPU workloads on Runpod in minutes. You'll exec ## Step 1: Install Flash -Flash is currently available for macOS and Linux. Windows support is in development. +Flash runs natively on macOS and Linux. Windows users can run Flash through [WSL2](/flash/windows-wsl2). Create a virtual environment and install Flash using [uv](https://docs.astral.sh/uv/): diff --git a/flash/windows-wsl2.mdx b/flash/windows-wsl2.mdx new file mode 100644 index 00000000..66e0ec86 --- /dev/null +++ b/flash/windows-wsl2.mdx @@ -0,0 +1,130 @@ +--- +title: "Use Flash on Windows" +sidebarTitle: "Windows (WSL2)" +description: "Set up WSL2 with Ubuntu to run Flash on Windows." +--- + +Flash runs natively on macOS and Linux. On Windows, you can run Flash through Windows Subsystem for Linux (WSL2), which provides a full Linux environment on your machine. + +## Requirements + +- Windows 10 version 2004 or later, or Windows 11. +- Administrator access to your Windows machine. +- [Runpod account](/get-started/manage-accounts) with a verified email address. +- [An API key](/get-started/api-keys) with **All** access permissions. + +## Step 1: Enable WSL2 + +Open PowerShell or Command Prompt as Administrator (right-click and select "Run as administrator"), then run: + +```powershell +wsl --install +``` + +This command enables WSL, installs the latest Linux kernel, sets WSL2 as the default version, and installs Ubuntu as your Linux distribution. + + +If WSL is already installed on your system, you can install Ubuntu specifically with: + +```powershell +wsl --install -d Ubuntu +``` + + +After the installation completes, restart your computer when prompted. + +## Step 2: Set up Ubuntu + +After restarting, Ubuntu launches automatically and prompts you to create a Linux username and password. These credentials are separate from your Windows account and are used only within the Linux environment. + +If Ubuntu doesn't launch automatically, open it from the Start menu by searching for "Ubuntu". + +Once setup is complete, you'll see the Ubuntu terminal prompt: + +```text +username@hostname:~$ +``` + +Update your package lists to ensure you have access to the latest software: + +```bash +sudo apt update && sudo apt upgrade -y +``` + +## Step 3: Install Python and uv + +Flash requires Python 3.10 or later. Ubuntu typically includes Python, but you should verify the version: + +```bash +python3 --version +``` + +If you need a newer version, install it: + +```bash +sudo apt install python3.12 python3.12-venv -y +``` + +Install [uv](https://docs.astral.sh/uv/), a fast Python package manager: + +```bash +curl -LsSf https://astral.sh/uv/install.sh | sh +``` + +After installation, restart your terminal or run the following to add uv to your path: + +```bash +source $HOME/.local/bin/env +``` + +## Step 4: Install and authenticate Flash + +Create a project directory and set up a virtual environment: + +```bash +mkdir my-flash-project && cd my-flash-project +uv venv +source .venv/bin/activate +``` + +Install Flash: + +```bash +uv pip install runpod-flash +``` + +Authenticate with your Runpod account: + +```bash +flash login +``` + +This opens your browser to authorize Flash. After you approve, your credentials are saved. + + +Alternatively, you can set your API key directly: + +```bash +export RUNPOD_API_KEY="your_key" +``` + + +## Step 5: Verify your installation + +Test that Flash is working correctly: + +```bash +flash --version +``` + +You're now ready to use Flash. Continue with the [quickstart](/flash/quickstart) to run your first GPU workload. + +## Tips for working with WSL2 + +**Accessing Windows files**: Your Windows drives are mounted under `/mnt/`. For example, `C:\Users\YourName\Documents` is accessible at `/mnt/c/Users/YourName/Documents`. + +**Opening WSL from any folder**: In Windows Explorer, type `wsl` in the address bar to open Ubuntu in that directory. + +**VS Code integration**: Install the [WSL extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-wsl) for VS Code to edit files in WSL with full IDE support. Run `code .` from your WSL terminal to open VS Code in the current directory. + +**Default terminal**: You can set Ubuntu as your default terminal in Windows Terminal for quicker access. From 57b7af6ff2b6fff7a4969a4922690c1432f7afcd Mon Sep 17 00:00:00 2001 From: "promptless[bot]" <179508745+promptless[bot]@users.noreply.github.com> Date: Fri, 1 May 2026 23:58:11 +0000 Subject: [PATCH 2/4] Update from greg.wester@runpod.io --- flash/windows-wsl2.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/flash/windows-wsl2.mdx b/flash/windows-wsl2.mdx index 66e0ec86..5f905259 100644 --- a/flash/windows-wsl2.mdx +++ b/flash/windows-wsl2.mdx @@ -1,6 +1,6 @@ --- title: "Use Flash on Windows" -sidebarTitle: "Windows (WSL2)" +sidebarTitle: "Windows Prerequisites" description: "Set up WSL2 with Ubuntu to run Flash on Windows." --- From 218a07b541614d85399e492a1b7eca2ab7b49de3 Mon Sep 17 00:00:00 2001 From: "promptless[bot]" Date: Fri, 1 May 2026 23:59:31 +0000 Subject: [PATCH 3/4] Group Windows WSL2 under Quickstart in navigation Reorganize Flash navigation to place windows-wsl2.mdx under a Quickstart group alongside the main quickstart page for better discoverability. --- docs.json | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/docs.json b/docs.json index ff57c9f5..53b7e698 100644 --- a/docs.json +++ b/docs.json @@ -49,8 +49,13 @@ "group": "Flash", "pages": [ "flash/overview", - "flash/quickstart", - "flash/windows-wsl2", + { + "group": "Quickstart", + "pages": [ + "flash/quickstart", + "flash/windows-wsl2" + ] + }, "flash/pricing", "flash/create-endpoints", "flash/custom-docker-images", From 0cfb6887752d8487b8f951c872a7b94278a8dafc Mon Sep 17 00:00:00 2001 From: "promptless[bot]" <179508745+promptless[bot]@users.noreply.github.com> Date: Sat, 2 May 2026 00:04:46 +0000 Subject: [PATCH 4/4] Update from greg.wester@runpod.io --- flash/windows-wsl2.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/flash/windows-wsl2.mdx b/flash/windows-wsl2.mdx index 5f905259..70a803e4 100644 --- a/flash/windows-wsl2.mdx +++ b/flash/windows-wsl2.mdx @@ -1,6 +1,6 @@ --- title: "Use Flash on Windows" -sidebarTitle: "Windows Prerequisites" +sidebarTitle: "Windows prerequisites" description: "Set up WSL2 with Ubuntu to run Flash on Windows." ---