<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>docs/content/configuration/environment-variables.md - fork/static-web-server @ allow-symlink</title>
<meta name="description" content="docs/content/configuration/environment-variables.md in fork/static-web-server at allow-symlink.">
<meta property="og:title" content="docs/content/configuration/environment-variables.md - fork/static-web-server @ allow-symlink">
<meta property="og:description" content="docs/content/configuration/environment-variables.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">David Legrand</span><span class="commit-message" data-commit="7ff6cf6af45a37269ba1a20b07614f1b9953a274">feat: optional default charset for `text/*` file responses (#656)</span><span class="snapshot-sha sha" data-commit="7ff6cf6af45a37269ba1a20b07614f1b9953a274">7ff6cf6</span><time datetime="2026-05-11T22:52:37+02:00" title="2026-05-11 22:52:37 +0200">2026-05-11</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> / <a href="/fork/static-web-server/ref/allow-symlink/tree/docs/">docs</a> / <a href="/fork/static-web-server/ref/allow-symlink/tree/docs/content/">content</a> / <a href="/fork/static-web-server/ref/allow-symlink/tree/docs/content/configuration/">configuration</a> / <span class="cur">environment-variables.md</span></nav>
<span class="view-stats"><span>9.3 KiB</span><span>210 lines</span></span><span class="actions"><a class="raw" href="/fork/static-web-server/raw/a0be6816559ae6e4b2bd4aea8065fcf8ab886d03/docs/content/configuration/environment-variables.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"><h1>Environment Variables</h1>
<p>The server can be configured via the following environment variables.</p>
<p>!!! tip "Remember"</p>
<pre><code>- Environment variables are equivalent to their command-line arguments.
- [Command-line arguments](./command-line-arguments.md) take precedence over their equivalent environment variables.
</code></pre>
<h3>SERVER_HOST</h3>
<p>The address of the host (e.g. 127.0.0.1). Default <code>[::]</code>.</p>
<h3>SERVER_PORT</h3>
<p>The port of the host. Default <code>80</code>.</p>
<h3>SERVER_LISTEN_FD</h3>
<p>Optional file descriptor number (e.g. <code>0</code>) to inherit an already-opened TCP listener (instead of using <code>SERVER_HOST</code> and/or <code>SERVER_PORT</code>). Default empty (disabled).</p>
<h3>SERVER_ROOT</h3>
<p>Relative or absolute root directory path of static files. Default <code>./public</code>.</p>
<h3>SERVER_CONFIG_FILE</h3>
<p>The Server configuration file path is in TOML format. See <a href="/fork/static-web-server/ref/allow-symlink/blob/docs/content/configuration/config-file.md">The TOML Configuration File</a>.</p>
<h3>SERVER_GRACE_PERIOD</h3>
<p>Defines a grace period in seconds after a <code>SIGTERM</code> signal is caught which will delay the server before shutting it down gracefully. The maximum value is <code>255</code> seconds. The default value is <code>0</code> (no delay).</p>
<h3>SERVER_LOG_LEVEL</h3>
<p>Specify a logging level in lowercase. Possible values are <code>error</code>, <code>warn</code>, <code>info</code>, <code>debug</code> or <code>trace</code>. Default <code>error</code>.</p>
<h3>SERVER_LOG_WITH_ANSI</h3>
<p>Enable or disable ANSI escape codes for colors and other text formatting of the log output.</p>
<h3>SERVER_LOG_REMOTE_ADDRESS</h3>
<p>Log incoming request information along with its Remote Address (IP) if available using the <code>info</code> log level. Default <code>false</code>.</p>
<h3>SERVER_LOG_X_REAL_IP</h3>
<p>Log the X-Real-IP header if available using the <code>info</code> log level. Default <code>false</code>.</p>
<h3>SERVER_LOG_FORWARDED_FOR</h3>
<p>Log the X-Forwarded-For header if available using the <code>info</code> log level. Default <code>false</code>.</p>
<h3>SERVER_TRUSTED_PROXIES</h3>
<p>A comma separated list of IP addresses to accept the X-Forwarded-For header from. An empty string means trust all IPs. Default <code>""</code></p>
<h3>SERVER_ERROR_PAGE_404</h3>
<p>HTML file path for 404 errors. If the path is not specified or simply doesn't exist then the server will use a generic HTML error message.
If a relative path is used then it will be resolved under the root directory. Default <code>./404.html</code>.</p>
<h3>SERVER_ERROR_PAGE_50X</h3>
<p>HTML file path for 50x errors. If the path is not specified or simply doesn't exist then the server will use a generic HTML error message.
If a relative path is used then it will be resolved under the root directory. Default <code>./50x.html</code></p>
<h3>SERVER_FALLBACK_PAGE</h3>
<p>A HTML file path (not relative to the root) used for <code>GET</code> requests when the requested path doesn't exist. The fallback page is served with a <code>200</code> status code, useful when using client routers. If the path doesn't exist then the feature is not activated.</p>
<h3>SERVER_THREADS_MULTIPLIER</h3>
<p>The number of worker threads multiplier will be multiplied by the number of system CPUs using the formula: <code>worker threads = number of CPUs * n</code> where <code>n</code> is the value that changes here. When the multiplier value is 0 or 1 then the <code>number of CPUs</code> is used. The number of worker threads result should be a number between 1 and 32,768 though it is advised to keep this value on the smaller side. Default one thread per core.</p>
<h3>SERVER_MAX_BLOCKING_THREADS</h3>
<p>Maximum number of blocking threads.</p>
<h3>SERVER_HTTP2_TLS</h3>
<p>Enable HTTP/2 with TLS support. Make sure also to adjust the current server port. Default <code>false</code> (disabled).</p>
<h3>SERVER_HTTP2_TLS_CERT</h3>
<p>Specify the file path to read the certificate. Default empty (disabled).</p>
<h3>SERVER_HTTP2_TLS_KEY</h3>
<p>Specify the file path to read the private key. Default empty (disabled).</p>
<h3>SERVER_HTTPS_REDIRECT</h3>
<p>Redirect all requests with scheme "http" to "https" for the current server instance. It depends on "http2" to be enabled.</p>
<h3>SERVER_HTTPS_REDIRECT_HOST</h3>
<p>Canonical hostname or IP of the HTTPS (HTTPS/2) server. It depends on "https-redirect" to be enabled. Default <code>localhost</code>.</p>
<h3>SERVER_HTTPS_REDIRECT_FROM_PORT</h3>
<p>HTTP host port where the redirect server will listen for requests to redirect them to HTTPS. It depends on "https-redirect" to be enabled. Default <code>80</code>.</p>
<h3>SERVER_HTTPS_REDIRECT_FROM_HOSTS</h3>
<p>List of host names or IPs allowed to redirect from. HTTP requests must contain the HTTP 'Host' header and match against this list. It depends on "https-redirect" to be enabled. Default <code>localhost</code>.</p>
<h3>SERVER_CORS_ALLOW_ORIGINS</h3>
<p>Specify an optional CORS list of allowed origin hosts separated by commas. Host ports or protocols aren't being checked. Use an asterisk (*) to allow any host. Default empty (disabled).</p>
<h3>SERVER_CORS_ALLOW_HEADERS</h3>
<p>Specify an optional CORS list of allowed HTTP headers separated by commas. It requires <code>SERVER_CORS_ALLOW_ORIGINS</code> to be used along with. Default <code>origin, content-type</code>.</p>
<h3>SERVER_CORS_EXPOSE_HEADERS</h3>
<p>Specify an optional CORS list of exposed HTTP headers separated by commas. It requires <code>SERVER_CORS_ALLOW_ORIGINS</code> to be used along with. Default <code>origin, content-type</code>.</p>
<h3>SERVER_COMPRESSION</h3>
<p><code>Gzip</code>, <code>Deflate</code>, <code>Brotli</code> or <code>zlib</code> compression on demand determined by the <code>Accept-Encoding</code> header and applied to text-based web file types only. See <a href="https://github.com/static-web-server/static-web-server/blob/master/src/compression.rs#L20">ad-hoc mime-type list</a>. Default <code>true</code> (enabled).</p>
<h3>SERVER_COMPRESSION_LEVEL</h3>
<p>Supported values are <code>fastest</code> (fast compression but larger resulting files), <code>best</code> (smallest file size but potentially slow) and <code>default</code> (algorithm-specific balanced compression level). Default is <code>default</code>.</p>
<h3>SERVER_COMPRESSION_STATIC</h3>
<p>Look up the pre-compressed file variant (<code>.gz</code>, <code>.br</code> or <code>.zst</code>) on the disk of a requested file and serve it directly if available. Default <code>false</code> (disabled). The compression type is determined by the <code>Accept-Encoding</code> header.</p>
<h3>SERVER_DIRECTORY_LISTING</h3>
<p>Enable directory listing for all requests ending with the slash character (‘/’). Default <code>false</code> (disabled).</p>
<h3>SERVER_DIRECTORY_LISTING_ORDER</h3>
<p>Specify a default code number to order directory listing entries per <code>Name</code>, <code>Last modified</code> or <code>Size</code> attributes (columns). Code numbers supported: <code>0</code> (Name asc), <code>1</code> (Name desc), <code>2</code> (Last modified asc), <code>3</code> (Last modified desc), <code>4</code> (Size asc), <code>5</code> (Size desc). Default <code>6</code> (unordered).</p>
<h3>SERVER_DIRECTORY_LISTING_FORMAT</h3>
<p>Specify a content format for the directory listing entries. Formats supported: <code>html</code> or <code>json</code>. Default <code>html</code>.</p>
<h3>SERVER_DIRECTORY_LISTING_DOWNLOAD</h3>
<p>Specify list of enabled format(s) for directory download. Format supported: <code>targz</code>. Default to empty list (disabled).</p>
<h3>SERVER_SECURITY_HEADERS</h3>
<p>Enable security headers by default when the HTTP/2 feature is activated. Headers included: <code>Strict-Transport-Security: max-age=63072000; includeSubDomains; preload</code> (2 years max-age), <code>X-Frame-Options: DENY</code> and <code>Content-Security-Policy: frame-ancestors 'self'</code>. Default <code>false</code> (disabled).</p>
<h3>SERVER_CACHE_CONTROL_HEADERS</h3>
<p>Enable cache control headers for incoming requests based on a set of file types. The file type list can be found in <a href="https://github.com/static-web-server/static-web-server/blob/master//src/control_headers.rs"><code>src/control_headers.rs</code></a> file. Default <code>true</code> (enabled).</p>
<h3>SERVER_BASIC_AUTH</h3>
<p>It provides <a href="https://datatracker.ietf.org/doc/html/rfc7617">The "Basic" HTTP Authentication Scheme</a> using credentials as <code>user-id:password</code> pairs, encoded using <code>Base64</code>. Password must be encoded using the <a href="https://en.wikipedia.org/wiki/Bcrypt">BCrypt</a> password-hashing function. Default empty (disabled).</p>
<h3>SERVER_REDIRECT_TRAILING_SLASH</h3>
<p>Check for a trailing slash in the requested directory URI and redirect permanent (308) to the same path with a trailing slash suffix if it is missing. Default <code>true</code> (enabled).</p>
<h3>SERVER_IGNORE_HIDDEN_FILES</h3>
<p>Ignore hidden files/directories (dotfiles), preventing them from being served and being included in auto HTML index pages (directory listing).</p>
<h3>SERVER_DISABLE_SYMLINKS</h3>
<p>Prevent following files or directories if any path name component is a symbolic link.</p>
<h3>SERVER_HEALTH</h3>
<p>Activate the health endpoint.</p>
<h3>SERVER_ACCEPT_MARKDOWN</h3>
<p>Enable markdown content negotiation. When a client sends <code>Accept: text/markdown</code> header, the server will serve markdown files (<code>.md</code> or <code>.html.md</code>) if available. See <a href="/fork/static-web-server/ref/allow-symlink/blob/docs/content/features/markdown-content-negotiation.md">Markdown Content Negotiation</a> for details. Default <code>false</code>.</p>
<h3>SERVER_TEXT_CHARSET</h3>
<p>Declare a default <code>charset</code> parameter on <code>text/*</code> responses that don't already carry one. See <a href="/fork/static-web-server/ref/allow-symlink/blob/docs/content/features/text-charset.md">Default Charset for Text Responses</a> for details. Default <code>utf-8</code>; set to an empty value to disable.</p>
<h3>SERVER_INDEX_FILES</h3>
<p>List of files that will be used as an index for requests ending with the slash character (‘/’). Files are checked in the specified order. Default <code>index.html</code>.</p>
<h3>SERVER_MAINTENANCE_MODE</h3>
<p>Enable the server's maintenance mode functionality.</p>
<h3>SERVER_MAINTENANCE_MODE_STATUS</h3>
<p>Provide a custom HTTP status code when entering into maintenance mode. Default <code>503</code>.</p>
<h3>SERVER_MAINTENANCE_MODE_FILE</h3>
<p>Provide a custom maintenance mode HTML file. If not provided then a generic message will be displayed.</p>
<h3>SERVER_METRICS</h3>
<p>Activate the Prometheus metrics endpoint. See <a href="/fork/static-web-server/ref/allow-symlink/blob/docs/content/features/metrics.md">Metrics</a> for details.</p>
<h2>Windows</h2>
<p>The following options and commands are Windows platform-specific.</p>
<h3>SERVER_WINDOWS_SERVICE</h3>
<p>Run the web server in a Windows Service context. See <a href="/fork/static-web-server/ref/allow-symlink/blob/docs/content/features/windows-service.md">more details</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>#</a-p> <a-tt>Environment Variables</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text">The server can be configured via the following environment variables.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text">!!! tip &quot;Remember&quot;</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text"><a-tl>    - Environment variables are equivalent to their command-line arguments.</a-tl></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>    </a-p><a-tl>- [Command-line arguments](./command-line-arguments.md) take precedence over their equivalent environment variables.</a-tl></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>###</a-p> <a-tt>SERVER_HOST</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text">The address of the host (e.g. 127.0.0.1). Default `[::]`.</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>###</a-p> <a-tt>SERVER_PORT</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text">The port of the host. Default `80`.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text"></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>###</a-p> <a-tt>SERVER_LISTEN_FD</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text">Optional file descriptor number (e.g. `0`) to inherit an already-opened TCP listener (instead of using `SERVER_HOST` and/or `SERVER_PORT`). Default empty (disabled).</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text"></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>###</a-p> <a-tt>SERVER_ROOT</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text">Relative or absolute root directory path of static files. Default `./public`.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text"></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>###</a-p> <a-tt>SERVER_CONFIG_FILE</a-tt></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">The Server configuration file path is in TOML format. See [The TOML Configuration File](../configuration/config-file.md).</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>###</a-p> <a-tt>SERVER_GRACE_PERIOD</a-tt></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">Defines a grace period in seconds after a `SIGTERM` signal is caught which will delay the server before shutting it down gracefully. The maximum value is `255` seconds. The default value is `0` (no delay).</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>###</a-p> <a-tt>SERVER_LOG_LEVEL</a-tt></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">Specify a logging level in lowercase. Possible values are `error`, `warn`, `info`, `debug` or `trace`. Default `error`.</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>###</a-p> <a-tt>SERVER_LOG_WITH_ANSI</a-tt></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">Enable or disable ANSI escape codes for colors and other text formatting of the log output.</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>###</a-p> <a-tt>SERVER_LOG_REMOTE_ADDRESS</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L43" href="#L43">43</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L44" href="#L44">44</a><span class="code-text">Log incoming request information along with its Remote Address (IP) if available using the `info` log level. Default `false`.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L45" href="#L45">45</a><span class="code-text"></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>###</a-p> <a-tt>SERVER_LOG_X_REAL_IP</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L47" href="#L47">47</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L48" href="#L48">48</a><span class="code-text">Log the X-Real-IP header if available using the `info` log level. Default `false`.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L49" href="#L49">49</a><span class="code-text"></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>###</a-p> <a-tt>SERVER_LOG_FORWARDED_FOR</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L51" href="#L51">51</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L52" href="#L52">52</a><span class="code-text">Log the X-Forwarded-For header if available using the `info` log level. Default `false`.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L53" href="#L53">53</a><span class="code-text"></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>###</a-p> <a-tt>SERVER_TRUSTED_PROXIES</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L55" href="#L55">55</a><span class="code-text"></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 comma separated list of IP addresses to accept the X-Forwarded-For header from. An empty string means trust all IPs. Default `&quot;&quot;`</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L57" href="#L57">57</a><span class="code-text"></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>###</a-p> <a-tt>SERVER_ERROR_PAGE_404</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L59" href="#L59">59</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L60" href="#L60">60</a><span class="code-text">HTML file path for 404 errors. If the path is not specified or simply doesn&#39;t exist then the server will use a generic HTML error message.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L61" href="#L61">61</a><span class="code-text">If a relative path is used then it will be resolved under the root directory. Default `./404.html`.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L62" href="#L62">62</a><span class="code-text"></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>###</a-p> <a-tt>SERVER_ERROR_PAGE_50X</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L64" href="#L64">64</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L65" href="#L65">65</a><span class="code-text">HTML file path for 50x errors. If the path is not specified or simply doesn&#39;t exist then the server will use a generic HTML error message.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L66" href="#L66">66</a><span class="code-text">If a relative path is used then it will be resolved under the root directory. Default `./50x.html`</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L67" href="#L67">67</a><span class="code-text"></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>###</a-p> <a-tt>SERVER_FALLBACK_PAGE</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L69" href="#L69">69</a><span class="code-text"></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 HTML file path (not relative to the root) used for `GET` requests when the requested path doesn&#39;t exist. The fallback page is served with a `200` status code, useful when using client routers. If the path doesn&#39;t exist then the feature is not activated.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L71" href="#L71">71</a><span class="code-text"></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>###</a-p> <a-tt>SERVER_THREADS_MULTIPLIER</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L73" href="#L73">73</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L74" href="#L74">74</a><span class="code-text">The number of worker threads multiplier will be multiplied by the number of system CPUs using the formula: `worker threads = number of CPUs * n` where `n` is the value that changes here. When the multiplier value is 0 or 1 then the `number of CPUs` is used. The number of worker threads result should be a number between 1 and 32,768 though it is advised to keep this value on the smaller side. Default one thread per core.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L75" href="#L75">75</a><span class="code-text"></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>###</a-p> <a-tt>SERVER_MAX_BLOCKING_THREADS</a-tt></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">Maximum number of blocking threads.</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>###</a-p> <a-tt>SERVER_HTTP2_TLS</a-tt></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">Enable HTTP/2 with TLS support. Make sure also to adjust the current server port. Default `false` (disabled).</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>###</a-p> <a-tt>SERVER_HTTP2_TLS_CERT</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L85" href="#L85">85</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L86" href="#L86">86</a><span class="code-text">Specify the file path to read the certificate. Default empty (disabled).</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>SERVER_HTTP2_TLS_KEY</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">Specify the file path to read the private key. Default empty (disabled).</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>###</a-p> <a-tt>SERVER_HTTPS_REDIRECT</a-tt></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">Redirect all requests with scheme &quot;http&quot; to &quot;https&quot; for the current server instance. It depends on &quot;http2&quot; to be enabled.</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>###</a-p> <a-tt>SERVER_HTTPS_REDIRECT_HOST</a-tt></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">Canonical hostname or IP of the HTTPS (HTTPS/2) server. It depends on &quot;https-redirect&quot; to be enabled. Default `localhost`.</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>SERVER_HTTPS_REDIRECT_FROM_PORT</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">HTTP host port where the redirect server will listen for requests to redirect them to HTTPS. It depends on &quot;https-redirect&quot; to be enabled. Default `80`.</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>SERVER_HTTPS_REDIRECT_FROM_HOSTS</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">List of host names or IPs allowed to redirect from. HTTP requests must contain the HTTP &#39;Host&#39; header and match against this list. It depends on &quot;https-redirect&quot; to be enabled. Default `localhost`.</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"><a-p>###</a-p> <a-tt>SERVER_CORS_ALLOW_ORIGINS</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L109" href="#L109">109</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L110" href="#L110">110</a><span class="code-text">Specify an optional CORS list of allowed origin hosts separated by commas. Host ports or protocols aren&#39;t being checked. Use an asterisk (\*) to allow any host. Default empty (disabled).</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L111" href="#L111">111</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L112" href="#L112">112</a><span class="code-text"><a-p>###</a-p> <a-tt>SERVER_CORS_ALLOW_HEADERS</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L113" href="#L113">113</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L114" href="#L114">114</a><span class="code-text">Specify an optional CORS list of allowed HTTP headers separated by commas. It requires `SERVER_CORS_ALLOW_ORIGINS` to be used along with. Default `origin, content-type`.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L115" href="#L115">115</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L116" href="#L116">116</a><span class="code-text"><a-p>###</a-p> <a-tt>SERVER_CORS_EXPOSE_HEADERS</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L117" href="#L117">117</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L118" href="#L118">118</a><span class="code-text">Specify an optional CORS list of exposed HTTP headers separated by commas. It requires `SERVER_CORS_ALLOW_ORIGINS` to be used along with. Default `origin, content-type`.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L119" href="#L119">119</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L120" href="#L120">120</a><span class="code-text"><a-p>###</a-p> <a-tt>SERVER_COMPRESSION</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L121" href="#L121">121</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L122" href="#L122">122</a><span class="code-text">`Gzip`, `Deflate`, `Brotli` or `zlib` compression on demand determined by the `Accept-Encoding` header and applied to text-based web file types only. See [ad-hoc mime-type list](https://github.com/static-web-server/static-web-server/blob/master/src/compression.rs#L20). Default `true` (enabled).</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L123" href="#L123">123</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L124" href="#L124">124</a><span class="code-text"><a-p>###</a-p> <a-tt>SERVER_COMPRESSION_LEVEL</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L125" href="#L125">125</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L126" href="#L126">126</a><span class="code-text">Supported values are `fastest` (fast compression but larger resulting files), `best` (smallest file size but potentially slow) and `default` (algorithm-specific balanced compression level). Default is `default`.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L127" href="#L127">127</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L128" href="#L128">128</a><span class="code-text"><a-p>###</a-p> <a-tt>SERVER_COMPRESSION_STATIC</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L129" href="#L129">129</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L130" href="#L130">130</a><span class="code-text">Look up the pre-compressed file variant (`.gz`, `.br` or `.zst`) on the disk of a requested file and serve it directly if available. Default `false` (disabled). The compression type is determined by the `Accept-Encoding` header.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L131" href="#L131">131</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L132" href="#L132">132</a><span class="code-text"><a-p>###</a-p> <a-tt>SERVER_DIRECTORY_LISTING</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L133" href="#L133">133</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L134" href="#L134">134</a><span class="code-text">Enable directory listing for all requests ending with the slash character (‘/’). Default `false` (disabled).</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L135" href="#L135">135</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L136" href="#L136">136</a><span class="code-text"><a-p>###</a-p> <a-tt>SERVER_DIRECTORY_LISTING_ORDER</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L137" href="#L137">137</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L138" href="#L138">138</a><span class="code-text">Specify a default code number to order directory listing entries per `Name`, `Last modified` or `Size` attributes (columns). Code numbers supported: `0` (Name asc), `1` (Name desc), `2` (Last modified asc), `3` (Last modified desc), `4` (Size asc), `5` (Size desc). Default `6` (unordered).</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L139" href="#L139">139</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L140" href="#L140">140</a><span class="code-text"><a-p>###</a-p> <a-tt>SERVER_DIRECTORY_LISTING_FORMAT</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L141" href="#L141">141</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L142" href="#L142">142</a><span class="code-text">Specify a content format for the directory listing entries. Formats supported: `html` or `json`. Default `html`.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L143" href="#L143">143</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L144" href="#L144">144</a><span class="code-text"><a-p>###</a-p> <a-tt>SERVER_DIRECTORY_LISTING_DOWNLOAD</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L145" href="#L145">145</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L146" href="#L146">146</a><span class="code-text">Specify list of enabled format(s) for directory download. Format supported: `targz`. Default to empty list (disabled).</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L147" href="#L147">147</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L148" href="#L148">148</a><span class="code-text"><a-p>###</a-p> <a-tt>SERVER_SECURITY_HEADERS</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L149" href="#L149">149</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L150" href="#L150">150</a><span class="code-text">Enable security headers by default when the HTTP/2 feature is activated. Headers included: `Strict-Transport-Security: max-age=63072000; includeSubDomains; preload` (2 years max-age), `X-Frame-Options: DENY` and `Content-Security-Policy: frame-ancestors &#39;self&#39;`. Default `false` (disabled).</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L151" href="#L151">151</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L152" href="#L152">152</a><span class="code-text"><a-p>###</a-p> <a-tt>SERVER_CACHE_CONTROL_HEADERS</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L153" href="#L153">153</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L154" href="#L154">154</a><span class="code-text">Enable cache control headers for incoming requests based on a set of file types. The file type list can be found in [`src/control_headers.rs`](https://github.com/static-web-server/static-web-server/blob/master//src/control_headers.rs) file. Default `true` (enabled).</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L155" href="#L155">155</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L156" href="#L156">156</a><span class="code-text"><a-p>###</a-p> <a-tt>SERVER_BASIC_AUTH</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L157" href="#L157">157</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L158" href="#L158">158</a><span class="code-text">It provides [The &quot;Basic&quot; HTTP Authentication Scheme](https://datatracker.ietf.org/doc/html/rfc7617) using credentials as `user-id:password` pairs, encoded using `Base64`. Password must be encoded using the [BCrypt](https://en.wikipedia.org/wiki/Bcrypt) password-hashing function. Default empty (disabled).</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L159" href="#L159">159</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L160" href="#L160">160</a><span class="code-text"><a-p>###</a-p> <a-tt>SERVER_REDIRECT_TRAILING_SLASH</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L161" href="#L161">161</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L162" href="#L162">162</a><span class="code-text">Check for a trailing slash in the requested directory URI and redirect permanent (308) to the same path with a trailing slash suffix if it is missing. Default `true` (enabled).</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L163" href="#L163">163</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L164" href="#L164">164</a><span class="code-text"><a-p>###</a-p> <a-tt>SERVER_IGNORE_HIDDEN_FILES</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L165" href="#L165">165</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L166" href="#L166">166</a><span class="code-text">Ignore hidden files/directories (dotfiles), preventing them from being served and being included in auto HTML index pages (directory listing).</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L167" href="#L167">167</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L168" href="#L168">168</a><span class="code-text"><a-p>###</a-p> <a-tt>SERVER_DISABLE_SYMLINKS</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L169" href="#L169">169</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L170" href="#L170">170</a><span class="code-text">Prevent following files or directories if any path name component is a symbolic link.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L171" href="#L171">171</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L172" href="#L172">172</a><span class="code-text"><a-p>###</a-p> <a-tt>SERVER_HEALTH</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L173" href="#L173">173</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L174" href="#L174">174</a><span class="code-text">Activate the health endpoint.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L175" href="#L175">175</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L176" href="#L176">176</a><span class="code-text"><a-p>###</a-p> <a-tt>SERVER_ACCEPT_MARKDOWN</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L177" href="#L177">177</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L178" href="#L178">178</a><span class="code-text">Enable markdown content negotiation. When a client sends `Accept: text/markdown` header, the server will serve markdown files (`.md` or `.html.md`) if available. See [Markdown Content Negotiation](../features/markdown-content-negotiation.md) for details. Default `false`.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L179" href="#L179">179</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L180" href="#L180">180</a><span class="code-text"><a-p>###</a-p> <a-tt>SERVER_TEXT_CHARSET</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L181" href="#L181">181</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L182" href="#L182">182</a><span class="code-text">Declare a default `charset` parameter on `text/*` responses that don&#39;t already carry one. See [Default Charset for Text Responses](../features/text-charset.md) for details. Default `utf-8`; set to an empty value to disable.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L183" href="#L183">183</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L184" href="#L184">184</a><span class="code-text"><a-p>###</a-p> <a-tt>SERVER_INDEX_FILES</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L185" href="#L185">185</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L186" href="#L186">186</a><span class="code-text">List of files that will be used as an index for requests ending with the slash character (‘/’). Files are checked in the specified order. Default `index.html`.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L187" href="#L187">187</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L188" href="#L188">188</a><span class="code-text"><a-p>###</a-p> <a-tt>SERVER_MAINTENANCE_MODE</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L189" href="#L189">189</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L190" href="#L190">190</a><span class="code-text">Enable the server&#39;s maintenance mode functionality.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L191" href="#L191">191</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L192" href="#L192">192</a><span class="code-text"><a-p>###</a-p> <a-tt>SERVER_MAINTENANCE_MODE_STATUS</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L193" href="#L193">193</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L194" href="#L194">194</a><span class="code-text">Provide a custom HTTP status code when entering into maintenance mode. Default `503`.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L195" href="#L195">195</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L196" href="#L196">196</a><span class="code-text"><a-p>###</a-p> <a-tt>SERVER_MAINTENANCE_MODE_FILE</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L197" href="#L197">197</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L198" href="#L198">198</a><span class="code-text">Provide a custom maintenance mode HTML file. If not provided then a generic message will be displayed.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L199" href="#L199">199</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L200" href="#L200">200</a><span class="code-text"><a-p>###</a-p> <a-tt>SERVER_METRICS</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L201" href="#L201">201</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L202" href="#L202">202</a><span class="code-text">Activate the Prometheus metrics endpoint. See [Metrics](../features/metrics.md) for details.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L203" href="#L203">203</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L204" href="#L204">204</a><span class="code-text"><a-p>##</a-p> <a-tt>Windows</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L205" href="#L205">205</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L206" href="#L206">206</a><span class="code-text">The following options and commands are Windows platform-specific.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L207" href="#L207">207</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L208" href="#L208">208</a><span class="code-text"><a-p>###</a-p> <a-tt>SERVER_WINDOWS_SERVICE</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L209" href="#L209">209</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L210" href="#L210">210</a><span class="code-text">Run the web server in a Windows Service context. See [more details](../features/windows-service.md).</span></span></pre></div></div>
</main>
</body>
</html>
