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 <noreply@anthropic.com>
This commit is contained in:
1 parent
827fcb1ea8
commit
b2659a7082
3 files changed
+15
-10
No files matched your search
@@ -46,9 +46,11 @@ Architectures: `x86_64`, `aarch64`.
|
|||||||
|
|
||||||
## Volume and Data Layout
|
## Volume and Data Layout
|
||||||
|
|
||||||
One volume, `main`, mounted at `/data`. The proxy itself is stateless; the
|
One volume, `main`, holding only `config.json` (the StartOS-managed settings
|
||||||
volume holds only `config.json` (the StartOS-managed settings file containing
|
file containing the API key and logging preference), read and written by the
|
||||||
the API key and logging preference), written by the SDK on the host side.
|
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
|
## Installation and First-Run Flow
|
||||||
|
|
||||||
@@ -86,7 +88,9 @@ the user from the interface panel.
|
|||||||
## Backups and Restore
|
## Backups and Restore
|
||||||
|
|
||||||
The `main` volume (i.e. `config.json`) is backed up. Restore brings back the
|
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
|
## Health Checks
|
||||||
|
|
||||||
|
|||||||
@@ -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
|
If you need to change the key or turn on verbose logging later, run
|
||||||
**Configure PPQ API Key** again from the service's Actions.
|
**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.
|
||||||
+4
-6
@@ -11,15 +11,13 @@ export const main = sdk.setupMain(async ({ effects }) => {
|
|||||||
const debug = await configJson.read((c) => c.debug).const(effects)
|
const debug = await configJson.read((c) => c.debug).const(effects)
|
||||||
|
|
||||||
return sdk.Daemons.of(effects).addDaemon('proxy', {
|
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(
|
subcontainer: sdk.SubContainer.of(
|
||||||
effects,
|
effects,
|
||||||
{ imageId: 'proxy' },
|
{ imageId: 'proxy' },
|
||||||
sdk.Mounts.of().mountVolume({
|
sdk.Mounts.of(),
|
||||||
volumeId: 'main',
|
|
||||||
subpath: null,
|
|
||||||
mountpoint: '/data',
|
|
||||||
readonly: false,
|
|
||||||
}),
|
|
||||||
'proxy-sub',
|
'proxy-sub',
|
||||||
),
|
),
|
||||||
exec: {
|
exec: {
|
||||||
|
|||||||
Reference in new issue
Block a user