Skip to content

Commit 07f2579

Browse files
committed
docs: improve windows preview release guide
1 parent eba2992 commit 07f2579

2 files changed

Lines changed: 156 additions & 16 deletions

File tree

docs/deployment/windows-preview-release-template.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -43,10 +43,10 @@ This is a Windows preview build of LoRA Pilot delivered through a WSL-backed ins
4343
### Install Notes
4444

4545
- Run `LoRAPilotSetup.exe` as Administrator.
46-
- Tagged releases are intended to work as a single-download web installer: users run `LoRAPilotSetup.exe` and the runtime bundles are fetched automatically.
47-
- If Windows asks for a reboot during WSL setup, reboot and sign back in. Setup should resume automatically.
48-
- The installer downloads runtime bundles from the public URLs referenced by `windows-runtime-manifest.json`, not from GitHub release attachments.
49-
- If you downloaded both `windows-installer` and `windows-runtime-artifacts` preview artifacts instead of using a tagged release, run `Install-LoRAPilotPreview.ps1` from an elevated PowerShell after installing.
46+
- This tagged preview is intended to work as a single-download web installer. The runtime bundles are fetched automatically from the public URLs embedded in `windows-runtime-manifest.json`.
47+
- If WSL setup requires a reboot, reboot and sign back in. If setup does not resume automatically, run the installer again as Administrator.
48+
- The bundled `PREVIEW-INSTALL.md` file contains the real install flow, troubleshooting steps, and launcher commands. Users should read that first instead of improvising.
49+
- CI artifact smoke builds are a different path. If someone is testing raw workflow artifacts instead of the tagged release, `Install-LoRAPilotPreview.ps1` is the fallback helper.
5050

5151
### Known Limitations
5252

@@ -70,6 +70,7 @@ This is a Windows preview build of LoRA Pilot delivered through a WSL-backed ins
7070
- WSL setup / reboot edge cases
7171
- Port conflicts
7272
- SmartScreen / Defender behavior
73+
- R2 / CDN download behavior on real Windows machines
7374
- General launcher reliability
7475
```
7576

Lines changed: 151 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,162 @@
1-
# Windows Preview Installer
1+
# LoRA Pilot Windows Preview
22

3-
This preview build ships the installer and launcher, but the runtime payload still lives in the separate `windows-runtime-artifacts` download because GitHub Actions prefers absurdity over convenience.
3+
This is a preview Windows release of LoRA Pilot delivered through a WSL2-backed installer.
44

5-
## Preview install flow
5+
It is meant to be testable, not invisible. Expect a few rough edges, especially around first-time WSL setup, SmartScreen, and GPU-specific behavior. The basic install/start path works. That is already more than many preview installers can say with a straight face.
66

7-
1. Download and extract both artifacts into the same folder:
8-
- `windows-installer`
9-
- `windows-runtime-artifacts`
10-
2. Run `LoRAPilotSetup.exe` as Administrator.
11-
3. Open an elevated PowerShell in that folder and run:
7+
## What This Release Includes
8+
9+
- `LoRAPilotSetup.exe`
10+
- `windows-runtime-manifest.json`
11+
- runtime checksum files
12+
- public runtime bundles hosted on Cloudflare R2 and downloaded during setup
13+
14+
You do not need to manually download the large runtime bundles when using a tagged preview release. The installer fetches them for you.
15+
16+
## Requirements
17+
18+
- Windows 11 or Windows 10 22H2+
19+
- Administrator rights
20+
- WSL2 support enabled or installable on the machine
21+
- roughly 100 GB free disk space if you want enough room for the runtime, models, and workspace data
22+
- a decent internet connection, because the runtime bundle is not small and pretending otherwise would be unserious
23+
- NVIDIA Windows drivers with WSL GPU support if you want GPU acceleration
24+
25+
## Quick Start
26+
27+
1. Download `LoRAPilotSetup.exe` from the GitHub pre-release.
28+
2. Run it as Administrator.
29+
3. Let the installer:
30+
- check Windows support
31+
- enable or reuse WSL
32+
- download the runtime manifest and runtime bundle
33+
- import the managed `LoRAPilot` WSL distro
34+
- create Start Menu shortcuts
35+
4. If Windows requires a reboot for WSL setup, reboot and sign in again.
36+
5. Start `LoRA Pilot` from the Start Menu.
37+
38+
ControlPilot should open on `http://127.0.0.1:7878` once the runtime becomes healthy.
39+
40+
## What Gets Installed
41+
42+
- Windows launcher:
43+
`%LOCALAPPDATA%\Programs\LoRAPilot\LoRAPilotLauncher.exe`
44+
- State, logs, downloads, and managed WSL files:
45+
`%LOCALAPPDATA%\LoRAPilot`
46+
- Managed WSL distro name:
47+
`LoRAPilot`
48+
- Distro storage location:
49+
`%LOCALAPPDATA%\LoRAPilot\wsl\LoRAPilot`
50+
51+
Persistent app data remains inside the distro under `/workspace`.
52+
53+
## Start Menu Entries
54+
55+
- `LoRA Pilot`: starts the runtime and opens ControlPilot
56+
- `Open ControlPilot`: opens the browser if ControlPilot is already running
57+
- `Stop LoRA Pilot`: stops the managed runtime
58+
- `Uninstall LoRA Pilot`: removes the Windows launcher and optionally the managed distro
59+
60+
## Useful Commands
61+
62+
Open an elevated PowerShell and use:
63+
64+
```powershell
65+
$exe = "$env:LOCALAPPDATA\Programs\LoRAPilot\LoRAPilotLauncher.exe"
66+
67+
& $exe status --json
68+
& $exe start
69+
& $exe stop
70+
& $exe open
71+
```
72+
73+
That is much more informative than angrily clicking the same shortcut five times and expecting Windows to develop empathy.
74+
75+
## Troubleshooting
76+
77+
### Installer says WSL needs a reboot
78+
79+
- Reboot Windows.
80+
- Sign back in.
81+
- If setup does not resume automatically, run the installer again as Administrator.
82+
83+
### Installer fails during the WSL import step
84+
85+
Clean stale state and retry:
86+
87+
```powershell
88+
wsl --unregister LoRAPilot
89+
Remove-Item -Recurse -Force "$env:LOCALAPPDATA\LoRAPilot\wsl\LoRAPilot" -ErrorAction SilentlyContinue
90+
Remove-Item -Force "$env:LOCALAPPDATA\LoRAPilot\state.json" -ErrorAction SilentlyContinue
91+
```
92+
93+
Then rerun `LoRAPilotSetup.exe`.
94+
95+
### ControlPilot does not open
96+
97+
Check launcher status:
1298

1399
```powershell
14-
.\Install-LoRAPilotPreview.ps1
100+
$exe = "$env:LOCALAPPDATA\Programs\LoRAPilot\LoRAPilotLauncher.exe"
101+
& $exe status --json
15102
```
16103

17-
4. If WSL setup required a reboot, rerun:
104+
Check launcher logs:
105+
106+
- `%LOCALAPPDATA%\LoRAPilot\logs\launcher.log`
107+
108+
### Windows warns that the installer is suspicious
109+
110+
That is still possible on preview builds, especially before signing and reputation are fully in place. If Windows blocks execution, use the usual SmartScreen “More info” path only if you trust the source of the release.
111+
112+
### Port conflicts
113+
114+
LoRA Pilot expects these localhost ports:
115+
116+
- `7878`
117+
- `8888`
118+
- `8443`
119+
- `5555`
120+
- `6666`
121+
- `4444`
122+
- `9090`
123+
- `8675`
124+
- `7879`
125+
126+
If `7878` is taken, for example:
18127

19128
```powershell
20-
.\Install-LoRAPilotPreview.ps1 -Resume
129+
netstat -ano | findstr :7878
21130
```
22131

23-
The helper patches `windows-runtime-manifest.json` to local file paths, writes a BOM-free `windows-runtime-manifest.local.json`, and calls `LoRAPilotLauncher.exe install --manifest-url ...` for you.
132+
Stop the conflicting process, then start LoRA Pilot again.
133+
134+
### GPU is missing inside WSL
135+
136+
Run:
137+
138+
```powershell
139+
nvidia-smi
140+
wsl --status
141+
wsl --update
142+
```
143+
144+
If the Windows NVIDIA driver is wrong, LoRA Pilot cannot compensate with optimism.
145+
146+
## Current Limitations
147+
148+
- Preview quality, not GA
149+
- No offline single-file installer
150+
- Windows GPU validation is still thinner than it should be
151+
- Some install/retry edge cases are still being tightened
152+
153+
## If You Are Testing CI Artifacts Instead of a Tagged Preview Release
154+
155+
That is a separate, more annoying path.
156+
157+
Use:
158+
159+
- `LoRAPilotSetup.exe`
160+
- `Install-LoRAPilotPreview.ps1`
161+
162+
The helper script exists for artifact-based smoke tests where the runtime is not published like a normal release yet. If you are using a tagged GitHub pre-release, you should not need it.

0 commit comments

Comments
 (0)