From b2659a70824ee1bd7ce851bf236e2b9de29c84c5 Mon Sep 17 00:00:00 2001 From: mattius459 Date: Tue, 28 Jul 2026 11:12:36 +0200 Subject: [PATCH] Address review: drop unused /data mount, document key in backups - The proxy is stateless and env-configured; the 'main' volume is no longer mounted into the container (config.json is read host-side) - README/instructions note that backups contain the saved API key - Upstream tagged v0.3.2 (matches package.json); submodule checked out at the tag Verified on the StartOS 0.4.0 VM: update installs over the previous version, keeps the saved key, and reports attestation-verified health. Co-Authored-By: Claude Fable 5 --- README.md | 12 ++++++++---- instructions.md | 3 +++ startos/main.ts | 10 ++++------ 3 files changed, 15 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 1cc6c67..08a57e6 100644 --- a/README.md +++ b/README.md @@ -46,9 +46,11 @@ Architectures: `x86_64`, `aarch64`. ## Volume and Data Layout -One volume, `main`, mounted at `/data`. The proxy itself is stateless; the -volume holds only `config.json` (the StartOS-managed settings file containing -the API key and logging preference), written by the SDK on the host side. +One volume, `main`, holding only `config.json` (the StartOS-managed settings +file containing the API key and logging preference), read and written by the +SDK on the host side. The proxy itself is stateless and the volume is **not** +mounted into the container — configuration reaches the daemon via environment +variables only. ## Installation and First-Run Flow @@ -86,7 +88,9 @@ the user from the interface panel. ## Backups and Restore The `main` volume (i.e. `config.json`) is backed up. Restore brings back the -saved API key and settings; no other state exists. +saved API key and settings; no other state exists. Note that backups therefore +contain the saved PPQ.AI API key (StartOS backups are encrypted with the +user's backup password). ## Health Checks diff --git a/instructions.md b/instructions.md index b8276b1..36881a7 100644 --- a/instructions.md +++ b/instructions.md @@ -44,3 +44,6 @@ PPQ.AI key per request, pass it as an `Authorization: Bearer` header. If you need to change the key or turn on verbose logging later, run **Configure PPQ API Key** again from the service's Actions. + +Backups of this service include your saved API key, and restoring a backup +restores it — keep that in mind when handling backup drives. diff --git a/startos/main.ts b/startos/main.ts index e6e1383..5ed427a 100644 --- a/startos/main.ts +++ b/startos/main.ts @@ -11,15 +11,13 @@ export const main = sdk.setupMain(async ({ effects }) => { const debug = await configJson.read((c) => c.debug).const(effects) return sdk.Daemons.of(effects).addDaemon('proxy', { + // The proxy is stateless and fully configured via env — the 'main' volume + // (config.json, read host-side by the SDK) is never mounted into the + // container. subcontainer: sdk.SubContainer.of( effects, { imageId: 'proxy' }, - sdk.Mounts.of().mountVolume({ - volumeId: 'main', - subpath: null, - mountpoint: '/data', - readonly: false, - }), + sdk.Mounts.of(), 'proxy-sub', ), exec: {