Add curl one-liner install and rebuild-before-commit note

README: install straight from git with curl | sh, and a reminder to
rebuild dist/install-cabinchat.sh before every commit. Installer: usage
text no longer depends on reading its own file, so --help works when
piped into sh.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
Pascal Suter
2026-11-16 11:32:53 +01:00
co-authored by Claude Opus 5.5
parent 7e8d07e6c1
commit 863d30eeba
3 changed files with 26 additions and 5 deletions
+15
View File
@@ -10,6 +10,15 @@ the built-in `uhttpd` web server with one small shell CGI script.
## Install on the router
Straight from git, in an SSH session on the router (`ssh root@192.168.8.1`):
curl -fsSL https://git.psuter.ch/psuter/cabinchat/raw/branch/main/dist/install-cabinchat.sh | sh
Add options after `sh -s --`, e.g. `... | sh -s -- -p 8090`. If `curl` is
missing, `wget -qO- <same URL> | sh` works too.
Or copy it over from a checkout:
scp -O dist/install-cabinchat.sh root@192.168.8.1:/tmp/
ssh root@192.168.8.1 sh /tmp/install-cabinchat.sh
@@ -38,6 +47,12 @@ Edit `www/`, reload the browser. Chat data lives in `data/` and photos in
normal and a private window) to test private chats and typing notices. When you're happy: bump `www/VERSION`, run `sh build.sh`, copy
`dist/install-cabinchat.sh` to the router.
> **Before every commit, run `sh build.sh` and commit the rebuilt
> `dist/install-cabinchat.sh` together with your changes.** The built
> installer is tracked in git on purpose: the curl one-liner above installs
> whatever is in `dist/` on `main`, so a stale installer means people get an
> old version.
## Storage
On the router's flash: `/www-chat/data/messages` (one line per message) and