Skip to content

Commit 5d9b1b9

Browse files
author
Barry KW Suridge
committed
Document Windows GUI installer setup
1 parent 888ec44 commit 5d9b1b9

1 file changed

Lines changed: 46 additions & 12 deletions

File tree

README.md

Lines changed: 46 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -326,43 +326,77 @@ The optional GUI apps are beta desktop builds in `dist/`. They are provided for
326326
testing and may change before a stable GUI release. End users do not need
327327
Python, Tk, PyInstaller, or the private build tooling to run them.
328328

329-
Use the binary that matches your desktop platform:
329+
Use the package that matches your desktop platform:
330330

331331
- Linux: `dist/LocalControl-GUI`
332-
- Windows: `dist/LocalControl-GUI.exe`
332+
- Windows 11: `dist/LocalControl-GUI-Setup.exe`
333333

334334
From a Linux shell in the repository root:
335335

336336
```bash
337337
./dist/LocalControl-GUI
338338
```
339339

340-
From Windows PowerShell in the repository root:
340+
On Windows 11, run the installer from Explorer or PowerShell:
341341

342342
```powershell
343-
.\dist\LocalControl-GUI.exe
343+
.\dist\LocalControl-GUI-Setup.exe
344344
```
345345

346-
You can also start the Windows binary from Explorer by opening `dist` and
347-
double-clicking `LocalControl-GUI.exe`.
346+
The installer adds LocalControl GUI to the current user's Windows profile and
347+
can create shortcuts. The standalone Windows executable is now a build input for
348+
the installer, not the recommended distribution file.
348349

349350
The GUI connects to LocalControl through the same local socket or configured
350351
remote command path as `botctl`. Keep socket files and SSH access restricted to
351352
trusted local users because GUI access can issue owner-level bot commands.
352353

353-
On Windows, SSH mode expects native Windows OpenSSH with a Windows-accessible
354+
On Windows 11, SSH mode uses native Windows OpenSSH with a Windows-accessible
354355
key or ssh-agent identity. Password prompts and WSL-held keys are not available
355-
to the Windows binary.
356+
to the Windows app.
356357

357-
Before using SSH mode on Windows, verify that native OpenSSH can authenticate
358-
without a password prompt:
358+
#### Creating a Windows SSH key for a remote Unix-like server
359+
360+
Open PowerShell on Windows and check whether you already have a key:
361+
362+
```powershell
363+
Test-Path $env:USERPROFILE\.ssh\id_ed25519.pub
364+
```
365+
366+
If that returns `False`, create a new key:
367+
368+
```powershell
369+
ssh-keygen -t ed25519 -f $env:USERPROFILE\.ssh\id_ed25519 -C "$env:USERNAME@Windows"
370+
```
371+
372+
Use a passphrase if you want the key protected at rest. If you use a passphrase,
373+
add the key to the Windows SSH agent:
374+
375+
```powershell
376+
Get-Service ssh-agent | Set-Service -StartupType Automatic
377+
Start-Service ssh-agent
378+
ssh-add $env:USERPROFILE\.ssh\id_ed25519
379+
```
380+
381+
Upload the public key to the remote Unix-like account that runs `botctl`:
382+
383+
```powershell
384+
type $env:USERPROFILE\.ssh\id_ed25519.pub | ssh user@host "umask 077; mkdir -p ~/.ssh; cat >> ~/.ssh/authorized_keys"
385+
```
386+
387+
Replace `user@host` with the remote account and host, for example
388+
`Borg@example.net`. The upload command may ask for the remote account password
389+
once; after the key is installed, the GUI expects key-based authentication.
390+
391+
Verify that Windows OpenSSH can authenticate without a password prompt:
359392

360393
```powershell
361394
ssh -o BatchMode=yes user@host
362395
```
363396

364-
If that command asks for a password or fails, configure a key under
365-
`%USERPROFILE%\.ssh` or add the key to the Windows `ssh-agent` first.
397+
If that command fails, fix Windows OpenSSH authentication before using the GUI.
398+
When it succeeds, enter the same SSH user, host, port, and remote plugin path in
399+
the GUI settings, then use **Test SSH** before sending a Limnoria command.
366400

367401
These beta binaries target recent Linux distributions and current Windows
368402
releases. Older platforms are not a support target for the GUI beta.

0 commit comments

Comments
 (0)