Back to Rerun

re_web_viewer_server

crates/viewer/re_web_viewer_server/README.md

0.36.01.5 KB
Original Source

re_web_viewer_server

Part of the rerun family of crates.

Serves the Rerun web viewer (re_viewer as Wasm and HTML) over HTTP.

When developing, you must run pixi run rerun-build-web (or pixi run rerun-build-web-release), before building this package. This is done automatically with pixi run rerun-web.

Embedding modes

By default, web viewer assets are embedded at compile time using include_bytes!.

When built with RERUN_TRAILING_WEB_VIEWER=1, the assets are expected to be appended to the binary via a post-processing step using scripts/append_web_viewer.py. This allows parallel building of CLI and web viewer in CI. Binaries built this way will fail to create a WebViewerServer before the post-processing step completes.

When built with RERUN_EXTERNAL_WEB_VIEWER=1, there are no built-in assets at all: they must be loaded at runtime from a zip archive on disk. This is used by Python wheels that ship the assets as rerun_sdk/web_viewer.zip instead of embedding them in the extension module.

Independently of how the binary was built, the assets can also be loaded at runtime from a zip archive on disk, via WebViewerServer::with_archive.