Guides
Each guide is an end-to-end walkthrough for a single task, with copy-pasteable configuration grounded in the real schema and links to the reference pages. If you are brand new, start with Quick start and Your first gateway, then come back here for specific tasks.
Note
Every guide below only relies on features that are wired into the runtime today. Where a related feature is parsed but not yet enforced (for example rate limiting), the guide says so explicitly rather than pretending it works.
Security01
Secure an API with JWT→
Validate bearer tokens, enforce auth globally, and gate routes by role and scope.
Protect the admin dashboard→
Require authentication on /admin with an auth provider.
Enable mutual TLS→
Terminate TLS with client-certificate verification and map CNs to roles.
Protocols & discovery02
Expose a gRPC service→
Proxy gRPC transparently over HTTP/2 with a normal route.
Auto-discover services with FARP→
Let services publish OpenAPI and have Octopus generate routes.
Generate a TypeScript client→
Use octopus gen to produce a typed client with TanStack Query hooks.