Skip to content

Rolling main documentation

Built from commit a4e01eb55fe940bd02b2426dccd46050704c54c5. Content may describe unreleased behavior.

Axum development server ​

The Axum adapter runs Trusted Server as a native local process. It is the shortest path for inspecting requests without an edge runtime; it is not a production deployment target.

Support status ​

AdapterRelease statusHealthStartup statusStartup healthProvider fan-outTrusted-client-IP handlingRequest normalization
axumdevelopmentreal500nomultipleoutermost sanitizenone

This row is the canonical status summary. Axum supports multiple auction providers and exposes a real /health handler. A startup failure replaces every route with a 500 response, including /health.

Verify the complete local handoff ​

From the repository root, run:

bash
./scripts/smoke-axum.sh

The script creates and strictly validates an isolated config, then runs ts config push --adapter axum --local. That push writes the config envelope to the temporary .edgezero/ directory; the Axum process does not read that file directly. The script reads the envelope and exports it as TRUSTED_SERVER_CONFIG_TRUSTED_SERVER_CONFIG_TRUSTED_SERVER_CONFIG.

Secrets use TRUSTED_SERVER_SECRET_{STORE}_{KEY}. The exact required variables are:

  • TRUSTED_SERVER_SECRET_TRUSTED_SERVER_SECRETS_HANDLER_PASSWORD
  • TRUSTED_SERVER_SECRET_TRUSTED_SERVER_SECRETS_PUBLISHER_PROXY_SECRET
  • TRUSTED_SERVER_SECRET_TRUSTED_SERVER_SECRETS_EC_PASSPHRASE

Before the positive request, the smoke omits the config and each secret in separate process starts. Each request must return 500 and its log must identify the missing environment variable or exact setting path. This prevents a port, launcher, or origin error from satisfying a negative case.

The final publisher request must return 200, include the stub-origin sentinel, rewrite its origin URL to the Axum listener, and remove the original URL. The exit trap stops the Axum process and stub origin, then removes the temporary config, local-push output, bodies, headers, and logs.

Runtime boundaries ​

Axum implements the read-only /_ts/admin/eids diagnostic. EC record lookup and key rotation are registered but return not-supported responses because the adapter has no request-time KV implementation. It sanitizes forwarded client-IP headers but does not resolve [trusted_client_ip]; see the adapter matrix.

For an edge deployment, use the Fastly, Cloudflare, or Spin guide.

Released under the Apache License 2.0.