<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>README.md - fork/static-web-server @ allow-symlink</title>
<meta name="description" content="README.md in fork/static-web-server at allow-symlink.">
<meta property="og:title" content="README.md - fork/static-web-server @ allow-symlink">
<meta property="og:description" content="README.md in fork/static-web-server at allow-symlink.">
<meta property="og:type" content="website">
<meta property="og:site_name" content="git.julia.blue">
<link rel="stylesheet" href="/css/style.css?v=62">
<script type="module" src="/js/main.js?v=62"></script>
</head>
<body>
<main data-ref="allow-symlink" data-tip="4414610fe1b0370ff0ac415e9367548840584710">
<noscript>
  <div class="callout">
    <p>
      hey! this is a static git repo viewer. commit diffs, file history,
      older commits and other revisions won't load without javascript.
    </p>
    <p>
      you are still able to view source files on branch/tag tips,
      but the experience is degraded.
    </p>
  </div>
</noscript>
<header class="repo"><div>
<h1>fork/static-web-server</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/fork/static-web-server</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">Chris Snell</span><span class="commit-message" data-commit="2d50f886dd405b1a1f57de5de6301524a95e8132">feat: stabilize Prometheus metrics feature (#635)</span><span class="snapshot-sha sha" data-commit="2d50f886dd405b1a1f57de5de6301524a95e8132">2d50f88</span><time datetime="2026-02-27T13:45:27-07:00" title="2026-02-27 13:45:27 -0700">2026-02-27</time></p>
<header class="topbar"><details class="switcher"><summary>allow-symlink</summary><div class="menu"><strong>branches</strong><a class="current" href="/fork/static-web-server/ref/allow-symlink/">allow-symlink</a><a class="all" href="/fork/static-web-server/refs">all refs →</a></div></details><nav class="crumbs"><a href="/fork/static-web-server/">static-web-server</a> / <span class="cur">README.md</span></nav>
<span class="view-stats"><span>8.1 KiB</span><span>108 lines</span></span><span class="actions"><a class="raw" href="/fork/static-web-server/raw/fe754e83c8a3ee0502d48180a88128f5ba5a79c8/README.md">raw</a></span></header>
<div class="markdown-view"><input type="radio" name="markdown-view" id="markdown-rendered" checked><label for="markdown-rendered">rendered</label><input type="radio" name="markdown-view" id="markdown-code"><label for="markdown-code">code</label><section class="readme rendered">&lt;div&gt;
  &lt;div align="center"&gt;
    &lt;a href="https://static-web-server.net" title="static-web-server website"&gt;
      &lt;img src="https://static-web-server.net/assets/sws.svg" height="100" width="100"
    /&gt;&lt;/a&gt;
  &lt;/div&gt;
&lt;h1 align="center"&gt;Static Web Server&lt;/h1&gt;
&lt;h4 align="center"&gt;
    A cross-platform, high-performance and asynchronous web server for static files-serving ⚡
  &lt;/h4&gt;
&lt;div align="center"&gt;
    &lt;a href="https://github.com/static-web-server/static-web-server/actions/workflows/devel.yml" title="devel ci"&gt;&lt;img src="https://github.com/static-web-server/static-web-server/actions/workflows/devel.yml/badge.svg?branch=master"&gt;&lt;/a&gt; 
    &lt;a href="https://hub.docker.com/r/joseluisq/static-web-server/" title="Docker Image Version (tag latest semver)"&gt;&lt;img src="https://img.shields.io/docker/v/joseluisq/static-web-server/2"&gt;&lt;/a&gt; 
    &lt;a href="https://hub.docker.com/r/joseluisq/static-web-server/tags" title="Docker Image Size (tag)"&gt;&lt;img src="https://img.shields.io/docker/image-size/joseluisq/static-web-server/2"&gt;&lt;/a&gt; 
    &lt;a href="https://hub.docker.com/r/joseluisq/static-web-server/" title="Docker Image"&gt;&lt;img src="https://img.shields.io/docker/pulls/joseluisq/static-web-server.svg"&gt;&lt;/a&gt; 
    &lt;a href="https://crates.io/crates/static-web-server" title="static-web-server crate"&gt;&lt;img src="https://img.shields.io/crates/v/static-web-server.svg"&gt;&lt;/a&gt; 
    &lt;a href="https://docs.rs/static-web-server" title="static-web-server crate docs"&gt;&lt;img src="https://img.shields.io/docsrs/static-web-server/latest?label=docs.rs"&gt;&lt;/a&gt; 
    &lt;a href="https://github.com/static-web-server/static-web-server/blob/master/LICENSE-APACHE" title="static-web-server license"&gt;&lt;img src="https://img.shields.io/crates/l/static-web-server"&gt;&lt;/a&gt; 
    &lt;a href="https://discord.gg/VWvtZeWAA7" title="Static Web Server Community on Discord"&gt;
      &lt;img src="https://img.shields.io/discord/1086203405225164842?logo=discord&amp;label=discord"&gt;
    &lt;/a&gt;
  &lt;/div&gt;
&lt;/div&gt;
<h2>Overview</h2>
<p><strong>Static Web Server</strong> (or <strong><code>SWS</code></strong> abbreviated) is a tiny and fast production-ready web server suitable to serve static web files or assets.</p>
<p>It is focused on <strong>lightness and easy-to-use</strong> principles while keeping <a href="https://blog.rust-lang.org/2015/04/10/Fearless-Concurrency.html">high performance and safety</a> powered by <a href="https://rust-lang.org">The Rust Programming Language</a>.</p>
<p>Written on top of <a href="https://github.com/hyperium/hyper">Hyper</a> and <a href="https://github.com/tokio-rs/tokio">Tokio</a> runtime, it provides <a href="https://rust-lang.github.io/async-book/01_getting_started/02_why_async.html">concurrent and asynchronous networking abilities</a> and the latest HTTP/1 - HTTP/2 implementations.</p>
<p>Cross-platform and available for <code>Linux</code>, <code>macOS</code>, <code>Windows</code>, <code>FreeBSD</code>, <code>NetBSD</code>, <code>Android</code>, <code>Docker</code> and <code>Wasm</code> (via <a href="https://wasmer.io/wasmer/static-web-server">Wasmer</a>).</p>
<p><img src="https://github.com/static-web-server/static-web-server/assets/1700322/102bef12-1f30-4054-a1bc-30c650d4ffa7" alt="static-web-server running" /></p>
<h2>Features</h2>
<ul>
<li>Built with <a href="https://rust-lang.org">Rust</a>, which focuses on <a href="https://kornel.ski/rust-c-speed">safety, speed and concurrency</a>.</li>
<li>Memory-safe and significantly reduced CPU and RAM overhead.</li>
<li>Blazing fast static files-serving and asynchronous powered by the latest <a href="https://github.com/hyperium/hyper/">Hyper</a>, <a href="https://github.com/tokio-rs/tokio">Tokio</a> and a set of <a href="https://github.com/static-web-server/static-web-server/blob/master/Cargo.toml">awesome crates</a>.</li>
<li>Single <strong>4MB</strong> (uncompressed) and fully static binary with no dependencies (<a href="https://doc.rust-lang.org/edition-guide/rust-2018/platform-and-target-support/musl-support-for-fully-static-binaries.html">Musl libc</a>). Suitable for running on <a href="https://en.wikipedia.org/wiki/Linux_distribution">any Linux distro</a> or <a href="https://hub.docker.com/r/joseluisq/static-web-server/tags">Docker container</a>.</li>
<li>Optional GZip, Deflate, Brotli or Zstandard (zstd) compression for text-based web files only.</li>
<li>Compression on-demand via <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding">Accept-Encoding</a> header.</li>
<li>Markdown content negotiation via <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept">Accept</a> header for serving <code>.md</code> files.</li>
<li><a href="https://en.wikipedia.org/wiki/Byte_serving">Partial Content Delivery</a> support for byte-serving of large files.</li>
<li>Optional <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cache-Control">Cache-Control</a> headers for assets.</li>
<li><a href="https://www.gnu.org/software/libc/manual/html_node/Termination-Signals.html">Termination signal</a> handling with <a href="https://cloud.google.com/blog/products/containers-kubernetes/kubernetes-best-practices-terminating-with-grace">graceful shutdown</a> ability and grace period.</li>
<li><a href="https://tools.ietf.org/html/rfc7540">HTTP/2</a> and TLS support.</li>
<li><a href="https://web.dev/security-headers/">Security headers</a> for HTTP/2 by default.</li>
<li><a href="https://tools.ietf.org/html/rfc7231#section-4.3.2">HEAD</a> and <a href="https://datatracker.ietf.org/doc/html/rfc7231#section-4.3.7">OPTIONS</a> responses.</li>
<li>Lightweight and configurable logging via <a href="https://github.com/tokio-rs/tracing">tracing</a> crate.</li>
<li>Customizable number of blocking and worker threads.</li>
<li>Optional directory listing with sorting and JSON output format support.</li>
<li><a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS">CORS</a> with preflight requests support.</li>
<li>Basic HTTP Authentication.</li>
<li>Customizable HTTP response headers for specific file requests via glob patterns.</li>
<li>Fallback pages for 404 errors, useful for Single-page applications.</li>
<li>Run the server as a <a href="https://docs.microsoft.com/en-us/previous-versions/windows/it-pro/windows-server-2003/cc783643(v=ws.10)">Windows Service</a>.</li>
<li>Configurable using CLI arguments, environment variables or a TOML file.</li>
<li>Default and custom error pages.</li>
<li>Built-in HTTP to HTTPS redirect.</li>
<li>GET/HEAD Health check endpoint.</li>
<li><a href="https://static-web-server.net/features/metrics/">Prometheus metrics endpoint</a> for HTTP request counts, latency histograms, and connection tracking.</li>
<li>Support for serving pre-compressed (Gzip/Brotli/Zstd) files directly from disk.</li>
<li>Custom URL rewrites and redirects via glob patterns with replacements.</li>
<li>Virtual hosting support.</li>
<li>Multiple index files.</li>
<li>Maintenance Mode functionality.</li>
<li>Available as a library crate with opt-in features.</li>
<li>First-class <a href="https://docs.docker.com/get-started/overview/">Docker</a> support. <a href="https://hub.docker.com/_/scratch">Scratch</a>, latest <a href="https://hub.docker.com/_/alpine">Alpine Linux</a> and <a href="https://hub.docker.com/_/alpine">Debian</a> Docker images.</li>
<li>Ability to accept a socket listener as a file descriptor for sandboxing and on-demand applications (e.g. <a href="http://0pointer.de/blog/projects/socket-activation.html">systemd</a>).</li>
<li>Cross-platform. Pre-compiled binaries for Linux, macOS, Windows, FreeBSD, NetBSD, Android (<code>x86/x86_64</code>, <code>ARM/ARM64</code>) and WebAssembly (via <a href="https://wasmer.io/wasmer/static-web-server">Wasmer</a>).</li>
</ul>
<h2>Documentation</h2>
<p>Please refer to <a href="https://static-web-server.net/">The Documentation Website</a> for more details about the API, usage and examples.</p>
<h2>Releases</h2>
<ul>
<li><a href="https://hub.docker.com/r/joseluisq/static-web-server/">Docker Images</a></li>
<li><a href="https://github.com/static-web-server/static-web-server/releases">Release Binaries</a></li>
<li><a href="https://static-web-server.net/platforms-architectures/">Platforms/Architectures Supported</a></li>
</ul>
<h2>Benchmarks</h2>
&lt;img title="SWS - Benchmarks April 2023" src="https://raw.githubusercontent.com/static-web-server/benchmarks/master/data/2023-04/benchmark-2023-04.png" width="860"&gt;
<p>For more details see <a href="https://github.com/static-web-server/benchmarks">benchmarks repository</a></p>
<h2>Contributions</h2>
<p>Unless you explicitly state otherwise, any contribution you intentionally submitted for inclusion in current work, as defined in the Apache-2.0 license, shall be dual licensed as described below, without any additional terms or conditions.</p>
<p>Feel free to submit a <a href="https://github.com/static-web-server/static-web-server/pulls">pull request</a> or file an <a href="https://github.com/static-web-server/static-web-server/issues">issue</a>.</p>
<h2>Community</h2>
<p><a href="https://discord.gg/VWvtZeWAA7">SWS Community on Discord</a></p>
<h2>License</h2>
<p>This work is primarily distributed under the terms of both the <a href="/fork/static-web-server/ref/allow-symlink/blob/LICENSE-MIT">MIT license</a> and the <a href="/fork/static-web-server/ref/allow-symlink/blob/LICENSE-APACHE">Apache License (Version 2.0)</a>.</p>
<p>© 2019-present <a href="https://joseluisq.net">Jose Quintana</a></p>
</section><div class="code-panel"><pre class="code src language-markdown"><span class="code-line"><a class="ln" id="L1" href="#L1">1</a><span class="code-text"><a-p>&lt;</a-p><a-tg>div</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text"><a-p>  &lt;</a-p><a-tg>div</a-tg><a-p> </a-p><a-at>align</a-at><a-p>=&quot;</a-p><a-s>center</a-s><a-p>&quot;&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text"><a-p>    &lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>https://static-web-server.net</a-s><a-p>&quot; </a-p><a-at>title</a-at><a-p>=&quot;</a-p><a-s>static-web-server website</a-s><a-p>&quot;&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text"><a-p>      &lt;</a-p><a-tg>img</a-tg><a-p> </a-p><a-at>src</a-at><a-p>=&quot;</a-p><a-s>https://static-web-server.net/assets/sws.svg</a-s><a-p>&quot; </a-p><a-at>height</a-at><a-p>=&quot;</a-p><a-s>100</a-s><a-p>&quot; </a-p><a-at>width</a-at><a-p>=&quot;</a-p><a-s>100</a-s><a-p>&quot;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text"><a-p>    /&gt;&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text"><a-p>  &lt;/</a-p><a-tg>div</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text"><a-p>&lt;h1 align=&quot;center&quot;&gt;Static Web Server&lt;/h1&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text"><a-p>&lt;</a-p><a-tg>h4</a-tg><a-p> </a-p><a-at>align</a-at><a-p>=&quot;</a-p><a-s>center</a-s><a-p>&quot;&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text"><a-p>    A cross-platform, high-performance and asynchronous web server for static files-serving ⚡</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text"><a-p>  &lt;/</a-p><a-tg>h4</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text"><a-p>&lt;</a-p><a-tg>div</a-tg><a-p> </a-p><a-at>align</a-at><a-p>=&quot;</a-p><a-s>center</a-s><a-p>&quot;&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text"><a-p>    &lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>https://github.com/static-web-server/static-web-server/actions/workflows/devel.yml</a-s><a-p>&quot; </a-p><a-at>title</a-at><a-p>=&quot;</a-p><a-s>devel ci</a-s><a-p>&quot;&gt;&lt;</a-p><a-tg>img</a-tg><a-p> </a-p><a-at>src</a-at><a-p>=&quot;</a-p><a-s>https://github.com/static-web-server/static-web-server/actions/workflows/devel.yml/badge.svg?branch=master</a-s><a-p>&quot;&gt;&lt;/</a-p><a-tg>a</a-tg><a-p>&gt; </a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text"><a-p>    &lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>https://hub.docker.com/r/joseluisq/static-web-server/</a-s><a-p>&quot; </a-p><a-at>title</a-at><a-p>=&quot;</a-p><a-s>Docker Image Version (tag latest semver)</a-s><a-p>&quot;&gt;&lt;</a-p><a-tg>img</a-tg><a-p> </a-p><a-at>src</a-at><a-p>=&quot;</a-p><a-s>https://img.shields.io/docker/v/joseluisq/static-web-server/2</a-s><a-p>&quot;&gt;&lt;/</a-p><a-tg>a</a-tg><a-p>&gt; </a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text"><a-p>    &lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>https://hub.docker.com/r/joseluisq/static-web-server/tags</a-s><a-p>&quot; </a-p><a-at>title</a-at><a-p>=&quot;</a-p><a-s>Docker Image Size (tag)</a-s><a-p>&quot;&gt;&lt;</a-p><a-tg>img</a-tg><a-p> </a-p><a-at>src</a-at><a-p>=&quot;</a-p><a-s>https://img.shields.io/docker/image-size/joseluisq/static-web-server/2</a-s><a-p>&quot;&gt;&lt;/</a-p><a-tg>a</a-tg><a-p>&gt; </a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text"><a-p>    &lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>https://hub.docker.com/r/joseluisq/static-web-server/</a-s><a-p>&quot; </a-p><a-at>title</a-at><a-p>=&quot;</a-p><a-s>Docker Image</a-s><a-p>&quot;&gt;&lt;</a-p><a-tg>img</a-tg><a-p> </a-p><a-at>src</a-at><a-p>=&quot;</a-p><a-s>https://img.shields.io/docker/pulls/joseluisq/static-web-server.svg</a-s><a-p>&quot;&gt;&lt;/</a-p><a-tg>a</a-tg><a-p>&gt; </a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text"><a-p>    &lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>https://crates.io/crates/static-web-server</a-s><a-p>&quot; </a-p><a-at>title</a-at><a-p>=&quot;</a-p><a-s>static-web-server crate</a-s><a-p>&quot;&gt;&lt;</a-p><a-tg>img</a-tg><a-p> </a-p><a-at>src</a-at><a-p>=&quot;</a-p><a-s>https://img.shields.io/crates/v/static-web-server.svg</a-s><a-p>&quot;&gt;&lt;/</a-p><a-tg>a</a-tg><a-p>&gt; </a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text"><a-p>    &lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>https://docs.rs/static-web-server</a-s><a-p>&quot; </a-p><a-at>title</a-at><a-p>=&quot;</a-p><a-s>static-web-server crate docs</a-s><a-p>&quot;&gt;&lt;</a-p><a-tg>img</a-tg><a-p> </a-p><a-at>src</a-at><a-p>=&quot;</a-p><a-s>https://img.shields.io/docsrs/static-web-server/latest?label=docs.rs</a-s><a-p>&quot;&gt;&lt;/</a-p><a-tg>a</a-tg><a-p>&gt; </a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text"><a-p>    &lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>https://github.com/static-web-server/static-web-server/blob/master/LICENSE-APACHE</a-s><a-p>&quot; </a-p><a-at>title</a-at><a-p>=&quot;</a-p><a-s>static-web-server license</a-s><a-p>&quot;&gt;&lt;</a-p><a-tg>img</a-tg><a-p> </a-p><a-at>src</a-at><a-p>=&quot;</a-p><a-s>https://img.shields.io/crates/l/static-web-server</a-s><a-p>&quot;&gt;&lt;/</a-p><a-tg>a</a-tg><a-p>&gt; </a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text"><a-p>    &lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>https://discord.gg/VWvtZeWAA7</a-s><a-p>&quot; </a-p><a-at>title</a-at><a-p>=&quot;</a-p><a-s>Static Web Server Community on Discord</a-s><a-p>&quot;&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text"><a-p>      &lt;</a-p><a-tg>img</a-tg><a-p> </a-p><a-at>src</a-at><a-p>=&quot;</a-p><a-s>https://img.shields.io/discord/1086203405225164842?logo=discord&amp;label=discord</a-s><a-p>&quot;&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text"><a-p>    &lt;/</a-p><a-tg>a</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text"><a-p>  &lt;/</a-p><a-tg>div</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L26" href="#L26">26</a><span class="code-text"><a-p>&lt;/div&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L27" href="#L27">27</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L28" href="#L28">28</a><span class="code-text"><a-p>## </a-p><a-tt>Overview</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L30" href="#L30">30</a><span class="code-text"><a-p>**Static Web Server** (or **`SWS`** abbreviated) is a tiny and fast production-ready web server suitable to serve static web files or assets.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L31" href="#L31">31</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L32" href="#L32">32</a><span class="code-text"><a-p>It is focused on **lightness and easy-to-use** principles while keeping [high performance and safety](https://blog.rust-lang.org/2015/04/10/Fearless-Concurrency.html) powered by [The Rust Programming Language](https://rust-lang.org).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L33" href="#L33">33</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L34" href="#L34">34</a><span class="code-text"><a-p>Written on top of [Hyper](https://github.com/hyperium/hyper) and [Tokio](https://github.com/tokio-rs/tokio) runtime, it provides [concurrent and asynchronous networking abilities](https://rust-lang.github.io/async-book/01_getting_started/02_why_async.html) and the latest HTTP/1 - HTTP/2 implementations.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L35" href="#L35">35</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L36" href="#L36">36</a><span class="code-text"><a-p>Cross-platform and available for `Linux`, `macOS`, `Windows`, `FreeBSD`, `NetBSD`, `Android`, `Docker` and `Wasm` (via [Wasmer](https://wasmer.io/wasmer/static-web-server)).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L37" href="#L37">37</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L38" href="#L38">38</a><span class="code-text"><a-p>![static-web-server running](https://github.com/static-web-server/static-web-server/assets/1700322/102bef12-1f30-4054-a1bc-30c650d4ffa7)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L39" href="#L39">39</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L40" href="#L40">40</a><span class="code-text"><a-p>## </a-p><a-tt>Features</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L41" href="#L41">41</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L42" href="#L42">42</a><span class="code-text"><a-p>- Built with [Rust](https://rust-lang.org), which focuses on [safety, speed and concurrency](https://kornel.ski/rust-c-speed).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L43" href="#L43">43</a><span class="code-text"><a-p>- Memory-safe and significantly reduced CPU and RAM overhead.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L44" href="#L44">44</a><span class="code-text"><a-p>- Blazing fast static files-serving and asynchronous powered by the latest [Hyper](https://github.com/hyperium/hyper/), [Tokio](https://github.com/tokio-rs/tokio) and a set of [awesome crates](https://github.com/static-web-server/static-web-server/blob/master/Cargo.toml).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L45" href="#L45">45</a><span class="code-text"><a-p>- Single __4MB__ (uncompressed) and fully static binary with no dependencies ([Musl libc](https://doc.rust-lang.org/edition-guide/rust-2018/platform-and-target-support/musl-support-for-fully-static-binaries.html)). Suitable for running on [any Linux distro](https://en.wikipedia.org/wiki/Linux_distribution) or [Docker container](https://hub.docker.com/r/joseluisq/static-web-server/tags).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L46" href="#L46">46</a><span class="code-text"><a-p>- Optional GZip, Deflate, Brotli or Zstandard (zstd) compression for text-based web files only.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L47" href="#L47">47</a><span class="code-text"><a-p>- Compression on-demand via [Accept-Encoding](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding) header.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L48" href="#L48">48</a><span class="code-text"><a-p>- Markdown content negotiation via [Accept](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept) header for serving `.md` files.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L49" href="#L49">49</a><span class="code-text"><a-p>- [Partial Content Delivery](https://en.wikipedia.org/wiki/Byte_serving) support for byte-serving of large files.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L50" href="#L50">50</a><span class="code-text"><a-p>- Optional [Cache-Control](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cache-Control) headers for assets.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L51" href="#L51">51</a><span class="code-text"><a-p>- [Termination signal](https://www.gnu.org/software/libc/manual/html_node/Termination-Signals.html) handling with [graceful shutdown](https://cloud.google.com/blog/products/containers-kubernetes/kubernetes-best-practices-terminating-with-grace) ability and grace period.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L52" href="#L52">52</a><span class="code-text"><a-p>- [HTTP/2](https://tools.ietf.org/html/rfc7540) and TLS support.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L53" href="#L53">53</a><span class="code-text"><a-p>- [Security headers](https://web.dev/security-headers/) for HTTP/2 by default.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L54" href="#L54">54</a><span class="code-text"><a-p>- [HEAD](https://tools.ietf.org/html/rfc7231#section-4.3.2) and [OPTIONS](https://datatracker.ietf.org/doc/html/rfc7231#section-4.3.7) responses.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L55" href="#L55">55</a><span class="code-text"><a-p>- Lightweight and configurable logging via [tracing](https://github.com/tokio-rs/tracing) crate.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L56" href="#L56">56</a><span class="code-text"><a-p>- Customizable number of blocking and worker threads.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L57" href="#L57">57</a><span class="code-text"><a-p>- Optional directory listing with sorting and JSON output format support.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L58" href="#L58">58</a><span class="code-text"><a-p>- [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) with preflight requests support.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L59" href="#L59">59</a><span class="code-text"><a-p>- Basic HTTP Authentication.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L60" href="#L60">60</a><span class="code-text"><a-p>- Customizable HTTP response headers for specific file requests via glob patterns.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L61" href="#L61">61</a><span class="code-text"><a-p>- Fallback pages for 404 errors, useful for Single-page applications.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L62" href="#L62">62</a><span class="code-text"><a-p>- Run the server as a [Windows Service](&lt;https://docs.microsoft.com/en-us/previous-versions/windows/it-pro/windows-server-2003/cc783643(v=ws.10)&gt;).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L63" href="#L63">63</a><span class="code-text"><a-p>- Configurable using CLI arguments, environment variables or a TOML file.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L64" href="#L64">64</a><span class="code-text"><a-p>- Default and custom error pages.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L65" href="#L65">65</a><span class="code-text"><a-p>- Built-in HTTP to HTTPS redirect.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L66" href="#L66">66</a><span class="code-text"><a-p>- GET/HEAD Health check endpoint.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L67" href="#L67">67</a><span class="code-text"><a-p>- [Prometheus metrics endpoint](https://static-web-server.net/features/metrics/) for HTTP request counts, latency histograms, and connection tracking.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L68" href="#L68">68</a><span class="code-text"><a-p>- Support for serving pre-compressed (Gzip/Brotli/Zstd) files directly from disk.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L69" href="#L69">69</a><span class="code-text"><a-p>- Custom URL rewrites and redirects via glob patterns with replacements.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L70" href="#L70">70</a><span class="code-text"><a-p>- Virtual hosting support.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L71" href="#L71">71</a><span class="code-text"><a-p>- Multiple index files.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L72" href="#L72">72</a><span class="code-text"><a-p>- Maintenance Mode functionality.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L73" href="#L73">73</a><span class="code-text"><a-p>- Available as a library crate with opt-in features.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L74" href="#L74">74</a><span class="code-text"><a-p>- First-class [Docker](https://docs.docker.com/get-started/overview/) support. [Scratch](https://hub.docker.com/_/scratch), latest [Alpine Linux](https://hub.docker.com/_/alpine) and [Debian](https://hub.docker.com/_/alpine) Docker images.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L75" href="#L75">75</a><span class="code-text"><a-p>- Ability to accept a socket listener as a file descriptor for sandboxing and on-demand applications (e.g. [systemd](http://0pointer.de/blog/projects/socket-activation.html)).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L76" href="#L76">76</a><span class="code-text"><a-p>- Cross-platform. Pre-compiled binaries for Linux, macOS, Windows, FreeBSD, NetBSD, Android (`x86/x86_64`, `ARM/ARM64`) and WebAssembly (via [Wasmer](https://wasmer.io/wasmer/static-web-server)).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L77" href="#L77">77</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L78" href="#L78">78</a><span class="code-text"><a-p>## </a-p><a-tt>Documentation</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L79" href="#L79">79</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L80" href="#L80">80</a><span class="code-text"><a-p>Please refer to [The Documentation Website](https://static-web-server.net/) for more details about the API, usage and examples.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L81" href="#L81">81</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L82" href="#L82">82</a><span class="code-text"><a-p>## </a-p><a-tt>Releases</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L83" href="#L83">83</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L84" href="#L84">84</a><span class="code-text"><a-p>- [Docker Images](https://hub.docker.com/r/joseluisq/static-web-server/)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L85" href="#L85">85</a><span class="code-text"><a-p>- [Release Binaries](https://github.com/static-web-server/static-web-server/releases)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L86" href="#L86">86</a><span class="code-text"><a-p>- [Platforms/Architectures Supported](https://static-web-server.net/platforms-architectures/)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L87" href="#L87">87</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L88" href="#L88">88</a><span class="code-text"><a-p>## </a-p><a-tt>Benchmarks</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L89" href="#L89">89</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L90" href="#L90">90</a><span class="code-text"><a-p>&lt;</a-p><a-tg>img</a-tg><a-p> </a-p><a-at>title</a-at><a-p>=&quot;</a-p><a-s>SWS - Benchmarks April 2023</a-s><a-p>&quot; </a-p><a-at>src</a-at><a-p>=&quot;</a-p><a-s>https://raw.githubusercontent.com/static-web-server/benchmarks/master/data/2023-04/benchmark-2023-04.png</a-s><a-p>&quot; </a-p><a-at>width</a-at><a-p>=&quot;</a-p><a-s>860</a-s><a-p>&quot;&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L91" href="#L91">91</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L92" href="#L92">92</a><span class="code-text"><a-p>For more details see [benchmarks repository](https://github.com/static-web-server/benchmarks)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L93" href="#L93">93</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L94" href="#L94">94</a><span class="code-text"><a-p>## </a-p><a-tt>Contributions</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L95" href="#L95">95</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L96" href="#L96">96</a><span class="code-text"><a-p>Unless you explicitly state otherwise, any contribution you intentionally submitted for inclusion in current work, as defined in the Apache-2.0 license, shall be dual licensed as described below, without any additional terms or conditions.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L97" href="#L97">97</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L98" href="#L98">98</a><span class="code-text"><a-p>Feel free to submit a [pull request](https://github.com/static-web-server/static-web-server/pulls) or file an [issue](https://github.com/static-web-server/static-web-server/issues).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L99" href="#L99">99</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L100" href="#L100">100</a><span class="code-text"><a-p>## </a-p><a-tt>Community</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L101" href="#L101">101</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L102" href="#L102">102</a><span class="code-text"><a-p>[SWS Community on Discord](https://discord.gg/VWvtZeWAA7)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L103" href="#L103">103</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L104" href="#L104">104</a><span class="code-text"><a-p>## </a-p><a-tt>License</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L105" href="#L105">105</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L106" href="#L106">106</a><span class="code-text">This work is primarily distributed under the terms of both the [MIT license](LICENSE-MIT) and the [Apache License (Version 2.0)](LICENSE-APACHE).</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L107" href="#L107">107</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L108" href="#L108">108</a><span class="code-text">© 2019-present [Jose Quintana](https://joseluisq.net)</span></span></pre></div></div>
</main>
</body>
</html>
