Skip to content

Add a getting-started page and rewrite the docs for the installer - #17

Merged
Marketen merged 3 commits into
mainfrom
docs/getting-started
Sep 9, 2026
Merged

Marketen merged 3 commits into
mainfrom
docs/getting-started

Conversation

@Marketen

@Marketen Marketen commented Sep 9, 2026

Copy link
Copy Markdown
Contributor

Why

Two gaps and one wrong altitude.

No getting-started page. The Dappnode UI showed nothing after install, and there was no route to the verification page from anywhere in the product — the one screen that makes this package meaningful.

No links section. So the UI could not surface it either. Added ui → the verification page, plus homepage and docs.

The README explained the mechanism before the point. It opened on AWS Nitro attestation and EHBP — right level for a maintainer, wrong one for someone deciding whether to install. It now opens with what changes for the user, and everything else sits behind a Learn more divider with the depth intact.

Copy

Matches what the other Nexus packages now use: TEE (trusted execution environment) rather than naming vendor and hardware, Dappnode in prose, and the three ideas worth landing — we cannot read your prompts, the proxy verifies it for you automatically, you can check the proof yourself.

Two real limitations, now documented

Both verified against the live TEE Gateway, not assumed:

production TEE Gateway
normal models 200 200
private/* models — 200
streaming — 200
nexus/auto 200, routed 500 internal_error
  • Auto Router does not work through the proxy. It fails on the direct TEE endpoint too, so it is the TEE deployment rather than the proxy — but since the proxy is the only way to reach that Gateway, the user-visible effect is the same.
  • PII masking cannot apply. The enclave may only dial the measured egress routes in its signed manifest (7 provider hosts plus KMS/metering/router vsock); the Presidio analyzer is not among them, so an in-enclave masking call cannot connect. PII_FILTER_FAIL_OPEN defaults to false, so a key with masking on should error rather than silently skip masking — worth confirming with a masking-enabled key, which I did not have.

Also

Drops the NEXUS_SDK_TOKEN build section. dappnode-nexus-sdk is public now, so the credential it describes no longer exists and the Dockerfile's unauthenticated path is the only one left.

Manifest + compose pass dappmanager schema validation.

🤖 Generated with Claude Code

Marketen and others added 3 commits September 9, 2026 14:04
The package had no getting-started page, so the Dappnode UI showed nothing
after install and there was no route to the verification page from anywhere in
the product. It also had no links section, so the UI could not surface the one
screen that makes this package meaningful.

The README explained the mechanism before it explained the point. It opened on
AWS Nitro attestation and EHBP, which is the right level for a maintainer and
the wrong one for someone deciding whether to install it. It now opens with
what changes for the user and puts the rest behind a "Learn more" divider,
where the depth is still there in full.

Copy follows what the rest of the Nexus packages now use: TEE (trusted
execution environment) rather than naming the vendor and hardware, "Dappnode"
in prose, and the three ideas worth landing -- we cannot read your prompts, the
proxy verifies it for you automatically, you can check the proof yourself.

Both documents now state two real limitations, verified against the live TEE
Gateway rather than assumed:

- Auto Router (nexus/auto) returns 500 on the TEE Gateway while working on
  production, so it does not work through the proxy.
- PII masking cannot apply. The enclave may only dial the measured egress
  routes in its signed manifest, and the Presidio analyzer is not one of them,
  so a key with masking enabled does not get masking here.

Also drops the NEXUS_SDK_TOKEN build section: dappnode-nexus-sdk is public now,
so the credential it describes no longer exists and the Dockerfile's
unauthenticated path is the only one left.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
The docs opened by describing the problem — prompts get decrypted on the way to
Nexus — and positioned the package as the fix. That frames the default as a
flaw and reads as a warning about a state the reader did not choose. Lead with
what this gives you instead:

  Encrypts your Nexus prompts so only the TEE — the trusted execution
  environment Nexus runs inside — can read them.

No mention of what happens without it, anywhere.

Also drops "yet" from the Auto Router and PII masking note. Neither has a
committed fix, so "yet" promises something nobody has agreed to ship.

And shorter throughout: README 159 -> 110 lines, getting-started 49 -> 34.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
The proxy protects the prompt as far as the Gateway. A model whose id starts
with private/ is reached over an attested, encrypted transport that fails
closed, so with the proxy in front the prompt is protected end to end. That is
the combination worth telling people about.

Says private/ rather than naming the provider: the provider may change, the id
prefix is the stable thing.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@Marketen
Marketen merged commit ea11696 into main Sep 9, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant