docs(install): polish Windows section + Service/Update/Troubleshooting

entries

  PR #1529 added the Windows installer but the rendered README sections
  had a stray blank line inside the install one-liner's code fence and
  the cross-platform Service Management / Updating / Troubleshooting
  sections still only covered Linux + macOS + Docker. Fold in Windows
  entries (Start-Service, Get-NetTCPConnection, NSSM runtime log path)
  and link the README description to the Windows Installer wiki page so
  users know where the parameter reference and unattended examples live.
This commit is contained in:
maziggy
2026-06-02 15:25:31 +02:00
parent 873c78a6ff
commit bd19a8ccb4
2 changed files with 38 additions and 6 deletions
+3 -3
View File
@@ -629,13 +629,13 @@ Open **http://localhost:8000** and add your printer!
### Windows Native Installation
Windows PowerShell:
Windows PowerShell (run as Administrator — the installer self-elevates via UAC if not):
```powershell
powershell -ExecutionPolicy Bypass -Command "iwr -useb https://raw.githubusercontent.com/maziggy/bambuddy/main/install/windows-installer.ps1 -OutFile windows-installer.ps1; .\windows-installer.ps1"
```
> Installs Bambuddy natively on Windows using Git, Python, a virtual environment, separate data/log directories, and optional NSSM Windows Service registration.
> Installs Bambuddy natively on Windows using Git, Python, a virtual environment, separate data/log directories, and optional NSSM Windows Service registration. See the [Windows Installer Guide](http://wiki.bambuddy.cool/getting-started/windows-installer/) for parameters and unattended-install options.
### Enabling Developer Mode
+35 -3
View File
@@ -93,13 +93,13 @@ Installs BamBuddy with Python virtual environment and optional systemd/launchd s
```
### `windows-installer.ps1` (Windows)
Windows PowerShell:
Windows PowerShell (run as Administrator — the installer self-elevates via UAC if not):
```powershell
powershell -ExecutionPolicy Bypass -Command "iwr -useb https://raw.githubusercontent.com/maziggy/bambuddy/main/install/windows-installer.ps1 -OutFile windows-installer.ps1; .\windows-installer.ps1"
```
> Installs Bambuddy natively on Windows using Git, Python, a virtual environment, and optional NSSM Windows Service registration.
> Installs Bambuddy natively on Windows using Git, Python, a virtual environment, and optional NSSM Windows Service registration. See the [Windows Installer Guide](https://wiki.bambuddy.cool/getting-started/windows-installer/) for full parameter reference.
**Parameters:**
```powershell
@@ -233,6 +233,15 @@ launchctl load ~/Library/LaunchAgents/com.bambuddy.app.plist # Start
launchctl unload ~/Library/LaunchAgents/com.bambuddy.app.plist # Stop
```
**Windows (NSSM service):**
```powershell
Get-Service Bambuddy # Check status
Start-Service Bambuddy # Start
Stop-Service Bambuddy # Stop
Restart-Service Bambuddy # Restart
Get-Content "C:\Bambuddy\bambuddy-runtime.log" -Tail 100 -Wait # View logs
```
**Docker:**
```bash
docker compose ps # Check status
@@ -288,6 +297,13 @@ git pull
docker compose up -d --build
```
**Windows (native):** rerun the installer; it detects the existing checkout and offers `git pull`, leaving `INSTALL_DIR\data` and `INSTALL_DIR\logs` untouched. Stop the service first if it is registered:
```powershell
Stop-Service Bambuddy
.\windows-installer.ps1 -Yes
Start-Service Bambuddy
```
---
## Troubleshooting
@@ -318,6 +334,22 @@ Choose a different port during installation or stop the conflicting service:
sudo lsof -i :8000 # Linux/macOS
```
```powershell
# Windows
Get-NetTCPConnection -LocalPort 8000 -State Listen
```
### Windows: Service Won't Start
Test the start script manually first:
```powershell
powershell.exe -ExecutionPolicy Bypass -File "C:\Bambuddy\Start-Bambuddy.ps1"
```
Then check the NSSM runtime logs:
```powershell
Get-Content "C:\Bambuddy\bambuddy-runtime-error.log" -Tail 100
```
---
## Requirements