mirror of
https://github.com/nestriness/nestri.git
synced 2026-11-03 22:22:39 +02:00
Wanjohi
6bbce800c7
``` bash <(curl -fsSL https://api.nestri.io/install.sh) -u # update this host bash <(curl -fsSL https://api.nestri.io/install.sh) <install-token> # make this machine a host bash <(curl -fsSL https://api.nestri.io/install.sh) -h # help ``` Piping still works: `curl -fsSL … | sh -s -- -u`. **`-u` / `--update`.** No token and no questions. On a registered machine it downloads and checksum-verifies the current host agent, swaps it in and restarts the service. The agent then pulls whatever its release changed (a raised image layout re-pulls the guest, jail and Proton). It refuses: - on a machine that was never installed, before downloading anything; - while a box is running, since restarting the agent would end that session; - on an unknown option. On a machine that already has the target version, it says so and exits 0. **Root, asked once.** The host agent runs as root, so when the script is started as anyone else it asks sudo once, before it changes anything. Neither a pipe nor `bash <(…)` leaves a file sudo could run again, so it fetches the same script to a private temp file, runs that as root with the same mode and token, and removes the copy as soon as root has it open. Only the settings somebody actually set (`NESTRI_HOST_VERSION`, `NESTRI_BIN_DIR`, `NESTRI_BOX_STORE`) are carried across. **Tested.** - **On an NVIDIA host:** `--update` took it 0.2.17 → 0.2.18, verified and restarted. A second run said "already 0.2.18. Nothing to do". - **On the fleet host, run as an ordinary user** with `bash <(curl …) -u`: - it asked for sudo, the root copy ran and said "Nothing to do", and no temp copy was left behind; - `-h` prints usage, and an unknown flag is refused. - **In a clean container:** `-u` refuses with "not a Nestri host yet", and a run with no token asks for one.
apps/api
The public HTTP API for Nestri — a Hono app. One handler, run either as a Cloudflare Worker or as an ordinary HTTP server.
What it does
Exposes the JSON API consumed by frontends and other clients. Every route is a thin wrapper that
validates input, delegates to a domain function in @nestri/core,
and returns { data: ... }. All business logic lives in the core package.
Routes:
| Prefix | Purpose |
|---|---|
/ |
Health check |
/user |
Current user profile, fingerprints, linked accounts |
/steam |
Link / sync / unlink a Steam account |
/library |
Owned games with playtime |
/games |
Game catalog |
/pairing-code |
Device pairing codes |
/machine |
Host machines |
/access-token |
Short-lived access tokens |
/doc |
Generated OpenAPI spec |
Structure
app/
index.ts # The handler: middleware, routes, error handler, /doc
server.ts # The same handler behind a listening socket
middleware/auth.ts # Bearer JWT, access token or host credentials → Actor
routes/*.ts # Thin route namespaces (UserApi, SteamApi, ...)
utils/ # ErrorResponses, Result(), validator wrapping
wrangler.jsonc # Worker configuration, one environment per stage
Dockerfile # The container, built from the repository root
test/ # Route tests
Key details
- Auth:
Authorization: Bearer …, carrying either a session token verified against@nestri/author a personal access token resolved from the database; or a registered host's ownx-nestri-machine-idandx-nestri-machine-secret. There is no shared secret and no credential that stands for more than one caller, so every route resolves to a specific user or a specific host — which is what lets a route say "the caller's own library" and mean it. - Errors: centralized
VisibleError→ typed JSON responses. - Settings arrive as bindings or as environment variables, and two of them have one spelling of
each: Postgres is
HYPERDRIVEorDATABASE_URL, and the route to the issuer is anAUTHservice binding orAUTH_INTERNAL_URL. Nothing here branches on which it got. AUTH_ISSUER_URLis the issuer's public URL and never the internal one, because it is compared literally against theissclaim on every token.
Running
bun run dev # under the Workers runtime, on :3000
bun run serve # as a plain process, on $PORT (default 3000)
Needs a Postgres database and a reachable issuer. Full list and deployment steps:
docs/deploy.md.