<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>docs/content/features/health-endpoint.md - fork/static-web-server @ allow-symlink</title>
<meta name="description" content="docs/content/features/health-endpoint.md in fork/static-web-server at allow-symlink.">
<meta property="og:title" content="docs/content/features/health-endpoint.md - fork/static-web-server @ allow-symlink">
<meta property="og:description" content="docs/content/features/health-endpoint.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">Matthias Schoettle</span><span class="commit-message" data-commit="dd43d06551fcf853e0012381c76af5b832d23b57">refactor: format check support Markdown files via mdformat (#597)</span><span class="snapshot-sha sha" data-commit="dd43d06551fcf853e0012381c76af5b832d23b57">dd43d06</span><time datetime="2025-12-07T04:40:21-05:00" title="2025-12-07 04:40:21 -0500">2025-12-07</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/features/">features</a> / <span class="cur">health-endpoint.md</span></nav>
<span class="view-stats"><span>987 B</span><span>35 lines</span></span><span class="actions"><a class="raw" href="/fork/static-web-server/raw/46ffa00e4df49bb1b16d93b3f7c1f30eebd1b9e0/docs/content/features/health-endpoint.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>Health endpoint</h1>
<p>SWS provides an optional <code>/health</code> endpoint that can be used to check if it is running properly.
When the <code>/health</code> is requested, SWS will generate a log only at the <code>debug</code> level instead of the usual <code>info</code> level for a regular file.</p>
<p>The HTTP methods supported are <code>GET</code> and <code>HEAD</code>.</p>
<p>This feature is disabled by default and can be controlled by the boolean <code>--health</code> option or the equivalent <a href="/fork/static-web-server/ref/allow-symlink/blob/docs/content/configuration/environment-variables.md#server_health">SERVER_HEALTH</a> env.</p>
<h2>Usage with Kubernetes liveness probe</h2>
<p>The health endpoint is well suited for the Kubernetes liveness probe:</p>
<pre class="language-yaml"><a-pr>apiVersion</a-pr><a-p>:</a-p> <a-s>v1</a-s>
<a-pr>kind</a-pr><a-p>:</a-p> <a-s>Pod</a-s>
<a-pr>metadata</a-pr><a-p>:</a-p>
  <a-pr>name</a-pr><a-p>:</a-p> <a-s>frontend</a-s>
<a-pr>spec</a-pr><a-p>:</a-p>
  <a-pr>containers</a-pr><a-p>:</a-p>
    <a-p>-</a-p> <a-pr>name</a-pr><a-p>:</a-p> <a-s>sws</a-s>
      <a-pr>image</a-pr><a-p>:</a-p> <a-s>frontend:1.0.0</a-s>
      <a-pr>command</a-pr><a-p>:</a-p>
        <a-p>-</a-p> <a-s>static-web-server</a-s>
        <a-p>-</a-p> <a-s>--root=/public</a-s>
        <a-p>-</a-p> <a-s>--log-level=info</a-s>
        <a-p>-</a-p> <a-s>--health</a-s>
      <a-pr>ports</a-pr><a-p>:</a-p>
      <a-p>-</a-p> <a-pr>containerPort</a-pr><a-p>:</a-p> <a-n>80</a-n>
        <a-pr>name</a-pr><a-p>:</a-p> <a-s>http</a-s>
      <a-pr>livenessProbe</a-pr><a-p>:</a-p>
        <a-pr>httpGet</a-pr><a-p>:</a-p>
          <a-pr>path</a-pr><a-p>:</a-p> <a-s>/health</a-s>
          <a-pr>port</a-pr><a-p>:</a-p> <a-s>http</a-s></pre>
</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>Health endpoint</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">SWS provides an optional `/health` endpoint that can be used to check if it is running properly.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text">When the `/health` is requested, SWS will generate a log only at the `debug` level instead of the usual `info` level for a regular file.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text">The HTTP methods supported are `GET` and `HEAD`.</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">This feature is disabled by default and can be controlled by the boolean `--health` option or the equivalent [SERVER_HEALTH](../configuration/environment-variables.md#server_health) env.</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>Usage with Kubernetes liveness probe</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 health endpoint is well suited for the Kubernetes liveness probe:</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-tl>yaml</a-tl></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>apiVersion: </a-p><a-s>v1</a-s></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>kind: </a-p><a-s>Pod</a-s></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>metadata:</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>  </a-p><a-pr>name</a-pr><a-p>: </a-p><a-s>frontend</a-s></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>spec:</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>  </a-p><a-pr>containers</a-pr><a-p>:</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>    - </a-p><a-pr>name</a-pr><a-p>: </a-p><a-s>sws</a-s></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-pr>image</a-pr><a-p>: </a-p><a-s>frontend:1.0.0</a-s></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>      </a-p><a-pr>command</a-pr><a-p>:</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>        - </a-p><a-s>static-web-server</a-s></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>        - </a-p><a-s>--root=/public</a-s></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-s>--log-level=info</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L27" href="#L27">27</a><span class="code-text"><a-p>        - </a-p><a-s>--health</a-s></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-pr>ports</a-pr><a-p>:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text"><a-p>      - </a-p><a-pr>containerPort</a-pr><a-p>: </a-p><a-n>80</a-n></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-pr>name</a-pr><a-p>: </a-p><a-s>http</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L31" href="#L31">31</a><span class="code-text"><a-p>      </a-p><a-pr>livenessProbe</a-pr><a-p>:</a-p></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>        </a-p><a-pr>httpGet</a-pr><a-p>:</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"><a-p>          </a-p><a-pr>path</a-pr><a-p>: </a-p><a-s>/health</a-s></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-pr>port</a-pr><a-p>: </a-p><a-s>http</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L35" href="#L35">35</a><span class="code-text"><a-p>```</a-p></span></span></pre></div></div>
</main>
</body>
</html>
