explewd/waste-go
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 5 Wiki Activity

docs: fix placeholder URLs in QUICKSTART; add committed example scripts

Browse Source 
QUICKSTART.md had the author's personal domain as the example anchor URL
(wss://waste.dev.xplwd.com/ws) which would confuse anyone reading it.
Replaced with wss://YOUR_ANCHOR_DOMAIN/ws and added a new Option 3
section explaining the example scripts.

Added committed *.example versions of the four local-workflow scripts
(launch-tui, launch-web, deploy-web, serve-web). The real filenames are
gitignored so local edits (HOST, ANCHOR, etc.) are never accidentally
committed; the .example files serve as templates users copy once.
Each script fails fast if the placeholder URL/host is still set.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
Fredrik Johansson
2026-07-02 11:51:02 +02:00
parent f425e0bb8e
commit d07342e97e
5 changed files with 264 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
QUICKSTART.md
View File

@@ -41,13 +41,33 @@ On Linux and Windows a tray icon appears — closing the window hides to tray ra
---
## Option 3 — Run the daemon manually (headless / power users)
## Option 3 — Run the daemon + TUI or web UI locally (power users / dev)
Example scripts are provided for the common local workflows. Copy them and fill in your anchor URL:
```bash
# TUI (terminal UI):
cp launch-tui.sh.example launch-tui.sh
$EDITOR launch-tui.sh # set ANCHOR=wss://your-anchor/ws
./launch-tui.sh
# Web UI in daemon mode (Vite dev server + daemon):
cp launch-web.sh.example launch-web.sh
$EDITOR launch-web.sh # set ANCHOR=wss://your-anchor/ws
./launch-web.sh
```
The real script files are gitignored so your local edits (anchor URL, alias, network) are never accidentally committed.
---
## Option 4 — Run the daemon manually (headless)
If you want the daemon running in the background without the desktop UI — on a server, over SSH, or with the web UI in a browser pointed at your local machine:
```bash
# Download waste-daemon from the releases page, then:
./waste-daemon -alias yourname -anchor wss://your-anchor-server/ws
./waste-daemon -alias yourname -anchor wss://YOUR_ANCHOR_DOMAIN/ws
```
Then open the web UI in a browser at the anchor URL, or point the web UI's daemon mode at `ws://127.0.0.1:17338`.
@@ -83,7 +103,7 @@ The anchor is a tiny signaling server that helps peers find each other — it ne
```bash
# On your VPS:
./waste-anchor -bind 127.0.0.1:8080
./waste-anchor -bind 127.0.0.1:8080 -turn-secret YOUR_COTURN_SECRET
```
Put it behind nginx with a `/ws` WebSocket proxy and serve the web UI static files at `/`. See [README.md](README.md#hosting-on-a-vps) for the full nginx setup.
Put it behind nginx with `/ws` and `/turn-credentials` proxied to the anchor, and the web UI static files at `/`. See [README.md](README.md#hosting-on-a-vps) for the full nginx setup.