-
Notifications
You must be signed in to change notification settings - Fork 36
docs: Add Windows (WSL2) setup instructions for Flash #623
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
a0b5b5c
Add Windows (WSL2) setup instructions for Flash
promptless[bot] eae606e
Merge branch 'main' into promptless/flash-windows-wsl2
promptless[bot] 9538305
Merge branch 'main' into promptless/flash-windows-wsl2
promptless[bot] 8abf915
Merge branch 'main' into promptless/flash-windows-wsl2
promptless[bot] 6be19b9
Merge branch 'main' into promptless/flash-windows-wsl2
promptless[bot] 48e1c3c
Merge branch 'main' into promptless/flash-windows-wsl2
promptless[bot] 00ba336
Merge branch 'main' into promptless/flash-windows-wsl2
promptless[bot] 55bd3c2
Merge branch 'main' into promptless/flash-windows-wsl2
promptless[bot] 57b7af6
Update from greg.wester@runpod.io
promptless[bot] 218a07b
Group Windows WSL2 under Quickstart in navigation
promptless[bot] 0cfb688
Update from greg.wester@runpod.io
promptless[bot] File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,130 @@ | ||
| --- | ||
| title: "Use Flash on Windows" | ||
| sidebarTitle: "Windows prerequisites" | ||
| 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. | ||
|
|
||
| <Tip> | ||
| If WSL is already installed on your system, you can install Ubuntu specifically with: | ||
|
|
||
| ```powershell | ||
| wsl --install -d Ubuntu | ||
| ``` | ||
| </Tip> | ||
|
|
||
| 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. | ||
|
|
||
| <Tip> | ||
| Alternatively, you can set your API key directly: | ||
|
|
||
| ```bash | ||
| export RUNPOD_API_KEY="your_key" | ||
| ``` | ||
| </Tip> | ||
|
|
||
| ## 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. | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Created this Windows WSL2 setup page based on Greg's Slack request to document Flash on WSL2. Greg confirmed "flash all works fine in Windows WSL. No problem."
Source: https://Team.slack.com/archives/C0B0F3J4D50/p1777530835743549