roadrunner_static (roadrunner v0.1.0)

View Source

Built-in static file handler.

Configure via a 3-tuple route with #{dir => Path} opts and a *path wildcard segment carrying the relative file path:

{~"/static/*path", roadrunner_static, #{dir => ~"/var/www"}}

Reads the file from disk, sets Content-Type from the extension, returns 404 on a missing file or any path that contains ...

Gzip-sibling serving

When a request carries Accept-Encoding: gzip and the requested file has a <file>.gz sibling on disk, the sibling is served verbatim with Content-Encoding: gzip plus Vary: Accept-Encoding. This matches nginx's gzip_static on behaviour and lets operators pre-compress build assets once instead of paying the deflate cost per request.

Accept-Encoding is matched via plain substring (gzip) rather than full RFC 9110 §12.5.3 qvalue ranking. The static path is typically hit by browsers and benchmark clients that always include gzip plainly. Brotli (.br) siblings are not served — gzip is the universally supported encoding.

The original file's ETag is reused for the gzip variant, so a follow-up If-None-Match returns 304 regardless of which variant was first served. A Range request disables the gzip path on that request — byte offsets over a compressed representation have subtle semantics and the simple "Range wins" rule matches what nginx does.

#{symlink_policy => Policy} (default refuse_escapes) controls how symlinks inside the docroot are handled. The policy applies to the leaf of the requested path — symlinks in intermediate directories are still followed by the kernel.

  • refuse_escapes (default) — symlinks whose target resolves inside dir are followed; symlinks pointing outside (e.g. an absolute target like /etc/passwd, or a relative target with .. segments) return 404. Stricter than nginx/Apache defaults but matches what an operator typically wants for a public docroot.
  • follow — every symlink is followed regardless of where it points (nginx disable_symlinks off equivalent). Use only when the docroot's filesystem permissions prevent untrusted writes.
  • refuse — every symlink returns 404, even safe in-docroot ones.

Summary

Functions

handle(Req)