docs(alpha): simplify native setup and verify generic starter creation

This commit is contained in:
2026-10-20 21:42:34 +01:00
parent dce2d759d7
commit a40898f79a
10 changed files with 272 additions and 529 deletions
+15 -6
View File
@@ -13,11 +13,14 @@ what is done; this file covers how to run, test and verify it.
headless Chrome against a live server (`test/ui-smoke.mjs`); a unit test alone
never marks a parity row done.
## Safety (unchanged from the Android client)
## Safety
- **Trusted LAN/VPN only.** The Pipelines API has **no authentication** and is
**not internet-safe**. Do not expose the server or this page to untrusted
networks.
- **Authenticated browser proxy.** Pages, assets, artifacts, and `/connect`
require a signed session cookie. The proxy refuses to start without its
configured password/secret file. Never disable authentication on a real service.
- **Private control APIs.** Pipelines and harness APIs have **no authentication**.
Keep them on loopback; expose only the authenticated proxy on a trusted LAN/VPN.
Use TLS/VPN for remote access, not an Internet-facing raw API.
- **No secrets.** The page stores only the server URL and its own small UI
preferences (sort/filter choices, attention dismissals, device-local chat
overrides) in `localStorage`; nothing is sent anywhere but the configured
@@ -25,7 +28,12 @@ what is done; this file covers how to run, test and verify it.
- **No hardcoded server.** The URL is entered by the user, prefilled from the page
origin, and can be overridden.
## Run it
## Run it for development
For normal installation, use [`./install`](../docs/install.md). The following
commands are for a separate development process with an existing web-auth file
(`PIPELINES_WEB_AUTH_FILE`, default `~/.config/pipelines/web-auth.json`). They do
not create an account or configure autostart.
```sh
cd web
@@ -40,7 +48,8 @@ first time; the endpoint is then remembered and re-opened on later loads. Nothin
is baked in.
On a deployment where ntfy already uses 8090, pick another port for the page
(e.g. `--port 8095`). The page is a foreground Node process, not a service.
(e.g. `--port 8095`). These commands are foreground processes; managed startup is
described in the [installation guide](../docs/install.md).
## Test it