Files
ppq-private-mode-startos/instructions.md
T
helix-nine 42b2841945 bump upstream to 0.4.1, add the status page UI, fix CI branch triggers
Community-registry audit ahead of listing.

Upstream 0.4.1 renames the model catalog (private/kimi-k2-6 →
private/kimi-k3, drops qwen3-vl-30b) and serves a status page at GET /,
so the package was documenting a stale model list and hiding a whole
surface. Export that page as a `ui` interface alongside the existing
`api` on one host, and unmask the API interface — its URL carries no
credentials, so masking hid the address for nothing.

PPQ_DATA_DIR stays unset deliberately. With it set, upstream persists a
browser-entered key to its own config.json while the StartOS-supplied
PPQ_API_KEY still wins at every restart, silently reverting the user.
StartOS owns the key via the action; the status page's form renders
disabled.

CI never ran: build.yml's PR target and tagAndRelease.yml's push
trigger both named `master` on a repo whose only branch is `main`.
Point them at `main` and reset all three workflows to the package
template, dropping the guard job retired in start-technologies@ed0dca2.

packageRepo now names the Start9-Community fork, which is where CI
runs, where the org's registry variables live, and where releases are
cut.

Also: drop three .catch handlers on file-model reads, which swallowed a
genuine read failure into "no key configured" — readOnce already
returns null for a missing file; pass null rather than an empty Mounts
for the unmounted subcontainer; inline two single-use interface consts;
and rewrite README/instructions against the writing guides, fixing a
YAML block that claimed a /data mount the package deliberately does not
make.
2026-08-12 09:58:35 -06:00

2.6 KiB

PPQ Private Mode

Documentation

What you get on StartOS

A local endpoint your AI clients talk to instead of talking to a model provider directly. Everything sent through it is encrypted on your server and only decrypted inside an attested hardware enclave, so neither PPQ.AI nor the model host can read your queries.

Two interfaces share one address:

  • Status Page — a web page showing whether enclave attestation succeeded, which private models are available, and how to point a client at the proxy.
  • OpenAI-Compatible API — the same address, ready to copy into a client.

The only thing the service stores is your PPQ.AI API key and the logging setting.

Getting set up

  1. You will be prompted to run Configure PPQ API Key. Paste an API key from ppq.ai — create one under Settings → API Keys and fund the account, since usage is billed per query to this key.
  2. The service starts and performs a cryptographic attestation of the remote enclave. The health check reports ready once attestation is verified — usually within a few seconds.
  3. Open the Status Page to confirm attestation succeeded, or copy the OpenAI-Compatible API address to point a client at it.

Using PPQ Private Mode

Connecting a client

Point any OpenAI-compatible client at the API address:

POST <api-address>/v1/chat/completions
{"model": "private/glm-5-2", "messages": [{"role": "user", "content": "Hello"}]}

Anthropic-SDK clients (including Claude Code) can use the native endpoint at <api-address>/v1/messages. For Claude Code, set:

export ANTHROPIC_BASE_URL="<api-address>"
export ANTHROPIC_MODEL="private/glm-5-2"

GET <api-address>/v1/models lists the available private models, and the Status Page shows the same list.

Requests are billed to your saved API key by default. To bill a different PPQ.AI key per request, pass it as an Authorization: Bearer header.

Actions

Run Configure PPQ API Key again whenever you want to replace the key or turn verbose logging on or off. Leaving the key field blank keeps the key you already saved.

Limitations

The Status Page has its own "save API key" form upstream; it is inactive here, because the key is managed by the Configure PPQ API Key action instead.

Backups of this service include your saved API key, and restoring a backup restores it — keep that in mind when handling backup drives.