Skip to main content

Module server

rtb_docs

Module server 

Source
Expand description

DocsServer — loopback HTTP server that renders the embedded markdown tree as HTML for airgapped end-users.

§Routes

Method + pathResponse
GET /Rendered index page linking every entry
GET /<path>.htmlRendered markdown page
GET /assets/<path>Raw asset bytes (images etc.)
GET /search?q=<text>JSON [{ path, title, snippet, score }]

§Security policy

  • Loopback bind by default (127.0.0.1:0); non-loopback binds require an explicit --bind flag at the CLI layer.
  • No authentication, no TLS — it’s a per-user local tool, not a production surface.
  • Every path in the .html / /assets/ routes is safe_join-equivalent checked before reaching rtb-assets (traversal patterns rejected).
  • Graceful shutdown via a CancellationToken child of App::shutdown.

Structs§

DocsServer
Loopback HTTP server that renders the embedded docs tree as HTML.