diff --git a/docs/development.md b/docs/development.md index c76e87b61..982d80996 100644 --- a/docs/development.md +++ b/docs/development.md @@ -158,12 +158,14 @@ Every `scripts` entry with `"type": "service"` receives these environment variab | Variable | Value | | --------------------------- | ------------------------------------------------------------------------------------------------------------------------- | -| `PASEO_SERVICE__URL` | Proxied daemon URL for a declared peer service. Prefer this for peer discovery; it survives peer restarts. | +| `PASEO_SERVICE__URL` | Proxied URL for a declared peer service. Prefer this for peer discovery; it survives peer restarts. | | `PASEO_SERVICE__PORT` | Raw ephemeral port for a declared peer service. Use only as a bypass escape hatch; it can go stale if that peer restarts. | | `PASEO_URL` | Self alias for `PASEO_SERVICE__URL`. | | `PASEO_PORT` | Self alias for `PASEO_SERVICE__PORT`. | | `HOST` | Bind host for the service process. | +Service proxy hostnames use the double-dash shape: `web--feature-auth--project.localhost` or, on the default branch, `web--project.localhost`. Optional public aliases use the same leftmost label under the configured public base host. + `` is normalized from the script name by uppercasing it, replacing each run of non-`A-Z0-9` characters with `_`, and trimming leading or trailing `_`. For example, `app-server` and `app.server` both normalize to `APP_SERVER`; that collision fails at spawn time with an actionable error. `PORT` is not injected by default. If a framework requires `PORT`, set it in the command: diff --git a/docs/service-proxy.md b/docs/service-proxy.md index 822a4c3e5..6e11f3e99 100644 --- a/docs/service-proxy.md +++ b/docs/service-proxy.md @@ -1,6 +1,6 @@ # Service Proxy -Paseo can proxy HTTP traffic to services running inside your workspaces and expose them at stable, publicly-accessible URLs. This lets you open a running dev server from your phone or share it with a teammate without any tunneling tools. +Paseo proxies HTTP traffic to services running inside your workspaces. Localhost service URLs are always enabled; optional public aliases and a separate service-only listener can be layered on through config. ## How it works @@ -9,22 +9,22 @@ When a `paseo.json` script of `"type": "service"` starts, Paseo assigns it a loc The generated hostname is built from the script name, branch, and project: ``` -