Document the network defaults, LAN opt-in and migration
This commit is contained in:
+11
-5
@@ -88,11 +88,13 @@ one; it does not touch that binary.
|
||||
|
||||
| Service | Default | Flag |
|
||||
| --- | --- | --- |
|
||||
| Web proxy (sign-in, web app, `/updates/`) | `0.0.0.0:8082` | `--web-port`, `--web-host` |
|
||||
| Web proxy (sign-in, web app, `/updates/`) | port 8082, loopback + tailnet only | `--web-port`, `--web-host`, `--web-lan` |
|
||||
| Server API (no auth) | `127.0.0.1:8080` | `--port`, `--bind-address` |
|
||||
| ntfy | `:8090` | `--ntfy-port`, `--ntfy-url` |
|
||||
|
||||
Expose only the web proxy. A reinstall keeps the saved ports and bind
|
||||
Expose only the web proxy. It listens on loopback and this machine's Tailscale
|
||||
addresses unless you opt into the LAN; see
|
||||
[network defaults](notes/network-and-update-signing.md). A reinstall keeps the saved ports and bind
|
||||
addresses unless you pass the flag again, so an installation set up with
|
||||
`--web-port 8083` stays on 8083.
|
||||
|
||||
@@ -101,7 +103,8 @@ so the phone app's "Find servers on this network" lists it. The advertised port
|
||||
is the web proxy's (when it listens beyond loopback; the supervisor passes
|
||||
`-mdns-port`), or the server's own `-addr` port when that is a LAN address.
|
||||
TXT records: `v` (version), `name` (host), `path=/connect`, `tls=0`,
|
||||
`auth=password|none`. Set `PIPELINES_MDNS=off` (or `-mdns=false`) to disable
|
||||
`auth=password|none`, plus `ts=`/`public=` routes; without `--web-lan` the
|
||||
advert carries no LAN route (`lan=0`, address records are the tailnet IPs). Set `PIPELINES_MDNS=off` (or `-mdns=false`) to disable
|
||||
it; a failure to advertise is logged and never stops the server.
|
||||
|
||||
`PIPELINES_WEB_PUBLIC_URL` is the address phones and notification links use.
|
||||
@@ -111,7 +114,8 @@ Set it once; reinstalls keep it:
|
||||
PIPELINES_WEB_PUBLIC_URL=https://mymac.tailnet-name.ts.net ./install
|
||||
```
|
||||
|
||||
Without it the installer records `http://<LAN IP>:<web-port>`. Use HTTPS or a
|
||||
Without it the installer records the tailnet IP (or `127.0.0.1`), or
|
||||
`http://<LAN IP>:<web-port>` where LAN sign-in is allowed. Use HTTPS or a
|
||||
VPN for remote access; plain HTTP does not protect the password.
|
||||
|
||||
## Flags
|
||||
@@ -124,7 +128,9 @@ From `arguments()` in `scripts/setup-native.py`:
|
||||
| `--port N` | server API port (default 8080) |
|
||||
| `--bind-address IP` | server API bind (default `127.0.0.1`) |
|
||||
| `--web-port N` | web proxy port (default 8082) |
|
||||
| `--web-host IP` | web proxy bind (default `0.0.0.0`) |
|
||||
| `--web-host tailnet\|IP` | web proxy access: `tailnet` (default for new installs: loopback and Tailscale addresses only) or a literal IPv4 bind such as `0.0.0.0`; existing installs keep theirs and get a warning |
|
||||
| `--web-lan` | also accept plain-HTTP LAN connections; sign-in over them stays refused |
|
||||
| `--web-lan-plain-login` | allow sign-in over plain-HTTP LAN (unencrypted password and cookie; trusted networks only) |
|
||||
| `--ntfy-port N` | ntfy port (default 8090) |
|
||||
| `--ntfy-url URL` | ntfy address given to phones (default `http://<LAN IP>:<ntfy-port>`) |
|
||||
| `--timezone TZ` | override the detected timezone (fallback UTC) |
|
||||
|
||||
Reference in New Issue
Block a user