Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions docs/devpod.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ The workspace uses the external image referenced there, which is expected to pro
- If on Windows, edit the advanced options to specify the "Host" as `tcp://127.0.0.1:2375` and change "Docker Path" to "podman".
6. Select VS Code as your IDE
7. Click Create - the dev container will be pulled down and started for you, and VS Code should open
- If you have trouble with this step on Windows, see [Troubleshooting DevPod on Windows](#troubleshooting-devpod-on-windows)
8. After the workspace starts, open a terminal in VS Code and run
```bash
uv sync --dev --all-extras
Expand Down Expand Up @@ -149,3 +150,26 @@ You're all set! Now when you run the app locally, it will come up in your web br
- If your DevPod or dev container image defines shell aliases that reference the placeholder project name, update that environment after renaming the project.
- This workspace intentionally uses an external dev container image for fast startup.
- The repo's Docker-based workflow is still available in [`docs/container.md`](docs/container.md) for building runnable images and the optional browser-served GUI (Xpra HTML) target.

### Troubleshooting DevPod on Windows

After applying any of these fixes, be sure to fully stop Podman and DevPod (making sure their icons are not still present in the taskbar hidden icons menu) restart them, and then create a new DevPod workspace from scratch (starting from [step 4](#setup) above)

#### `podman` binary not found in `%PATH%` during DevPod workspace build

Run in PowerShell to extend your path, replacing `[your user]` with your username:

```PowerShell
[Environment]::SetEnvironmentVariable("PATH", $env:PATH + ";C:\Users\[your user]\.local\bin", "User")
```

Also try deleting any pre-existing `C:\Users\[your user]\.docker` folder, as this may interfere with the Podman configuration.

#### VS Code fails to connect to running workspace with `Bad owner or permissions on C:\\Users\\[username]/.ssh/config` error in terminal

Run in PowerShell to set the correct permissions for the SSH config folder:

```PowerShell
icacls "$env:USERPROFILE\.ssh\config" /setowner "$env:USERNAME"
icacls "$env:USERPROFILE\.ssh\config" /inheritance:r /grant:r "${env:USERNAME}:(F)"
```