<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>docs/content/features/directory-listing.md - fork/static-web-server @ allow-symlink</title>
<meta name="description" content="docs/content/features/directory-listing.md in fork/static-web-server at allow-symlink.">
<meta property="og:title" content="docs/content/features/directory-listing.md - fork/static-web-server @ allow-symlink">
<meta property="og:description" content="docs/content/features/directory-listing.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">directory-listing.md</span></nav>
<span class="view-stats"><span>5.0 KiB</span><span>141 lines</span></span><span class="actions"><a class="raw" href="/fork/static-web-server/raw/5ca241b103f44118e17ebff202d2b7bf63a3f2a2/docs/content/features/directory-listing.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>Directory Listing</h1>
<p><strong><code>SWS</code></strong> provides a directory listing feature to display the content of directories.</p>
<p>This feature is disabled by default and can be controlled by the boolean <code>-z, --directory-listing</code> option or the equivalent <a href="/fork/static-web-server/ref/allow-symlink/blob/docs/content/configuration/environment-variables.md#server_directory_listing">SERVER_DIRECTORY_LISTING</a> env.</p>
<pre class="language-bash"><a-f>static-web-server</a-f> \
    <a-co>--port</a-co> 8787 \
    <a-co>--root</a-co> ./my-public-dir \
    <a-co>--directory-listing</a-co> true</pre>
<p>And here is an example of how the directory listing looks like.</p>
&lt;img title="SWS - Directory Listing" src="https://user-images.githubusercontent.com/1700322/145420578-5a508d2a-773b-4239-acc0-197ea2062ff4.png" width="400"&gt;
<h2>Relative paths for entries</h2>
<p>SWS uses relative paths for the directory listing entries (file or directory) and is used regardless of the <a href="/fork/static-web-server/ref/allow-symlink/blob/docs/content/features/trailing-slash-redirect.md">redirect trailing slash</a> feature.</p>
<p>However, when the <em>"redirect trailing slash"</em> feature is disabled and a directory request URI doesn't contain a trailing slash then the entries will contain the path <code>parent-dir/entry-name</code> as the link value. Otherwise, just an <code>entry-name</code> link value is used (default behavior).</p>
<p>Note also that in both cases, SWS will append a trailing slash to the entry if is a directory.</p>
<h2>Sorting</h2>
<p>Sorting by <code>Name</code>, <code>Last modified</code> and <code>Size</code> is enabled as clickable columns when the directory listing is activated via the <code>--directory-listing=true</code> option.</p>
<p>You can also use the <code>sort</code> query parameter to sort manually by certain attributes from URI. E.g <code>https://localhost/?sort=5</code>.</p>
<h3>Sorting by default</h3>
<p>Sometimes one wants to sort by a certain attribute but by <strong>default</strong>. In that case, the default ascending or descending ordering of files/dirs by their attributes is provided by the numeric <code>--directory-listing-order</code> option or the equivalent <a href="/fork/static-web-server/ref/allow-symlink/blob/docs/content/configuration/environment-variables.md#server_directory_listing_order">SERVER_DIRECTORY_LISTING_ORDER</a> env.</p>
<p>To do so you have to pass a <a href="#code-numbers-for-sorting">code sorting number</a>. E.g <code>--directory-listing-order=2</code>.</p>
<h3>Code numbers for sorting</h3>
<p>Below are the possible number code values for sorting or ordering which are grouped by attribute.</p>
<h4>Name</h4>
<ul>
<li><code>0</code>: Ascending</li>
<li><code>1</code>: Descending</li>
</ul>
<h4>Last modified</h4>
<ul>
<li><code>2</code>: Ascending</li>
<li><code>3</code>: Descending</li>
</ul>
<h4>Size</h4>
<ul>
<li><code>4</code>: Ascending</li>
<li><code>5</code>: Descending</li>
</ul>
<h4>Default</h4>
<ul>
<li><code>6</code>: Unordered</li>
</ul>
<p>!!! tip "Tips"</p>
<pre><code>- The `--directory-listing-order` option depends on `--directory-listing` to be enabled.
- Use the query `?sort=NUMBER` to customize the sorting via the URI. E.g `https://localhost/?sort=5` (sort by size in descending order)
</code></pre>
<p>Example:</p>
<pre class="language-bash"><a-f>static-web-server</a-f> \
    <a-co>--port</a-co> 8787 \
    <a-co>--root</a-co> ./my-public-dir \
    <a-co>--directory-listing</a-co> true \
    <a-c># E.g Sorting file/dir names in descending order</a-c>
    <a-co>--directory-listing-order</a-co> 1</pre>
<h2>Output format</h2>
<p><strong><code>SWS</code></strong> provides support for specifying an output format either HTML (default) or JSON for the directory listing entries via the string <code>--directory-listing-format</code> option or the equivalent <a href="/fork/static-web-server/ref/allow-symlink/blob/docs/content/configuration/environment-variables.md#server_directory_listing_format">SERVER_DIRECTORY_LISTING_FORMAT</a> env.</p>
<p>!!! tip "Tips"</p>
<pre><code>- The `--directory-listing-format` option depends on `--directory-listing` to be enabled.
</code></pre>
<h3>HTML format</h3>
<p>This is the default format when <code>--directory-listing</code> is enabled.</p>
<h3>JSON format</h3>
<p>The JSON format used is shown below for directories and files. Note that the <code>size</code> attribute is only available for files and the <code>mtime</code> value is UTC-based.</p>
<pre class="language-json">[
  {
    <a-s>&quot;name&quot;</a-s>: <a-s>&quot;my-directory&quot;</a-s>,
    <a-s>&quot;type&quot;</a-s>: <a-s>&quot;directory&quot;</a-s>,
    <a-s>&quot;mtime&quot;</a-s>: <a-s>&quot;2022-10-07T00:53:50Z&quot;</a-s>
  },
  {
    <a-s>&quot;name&quot;</a-s>: <a-s>&quot;my_file.tar.gz&quot;</a-s>,
    <a-s>&quot;type&quot;</a-s>: <a-s>&quot;file&quot;</a-s>,
    <a-s>&quot;mtime&quot;</a-s>: <a-s>&quot;2022-09-27T22:44:34Z&quot;</a-s>,
    <a-s>&quot;size&quot;</a-s>: <a-n>332</a-n>
  }
]</pre>
<p>Here is an example of serving the directory listing in JSON format.</p>
<pre class="language-bash"><a-f>static-web-server</a-f> \
    <a-co>-p=8787</a-co> <a-co>-d=tests/fixtures/public</a-co> <a-co>-g=trace</a-co> \
    <a-co>--directory-listing=true</a-co> \
    <a-co>--directory-listing-format=</a-co><a-s>&quot;json&quot;</a-s></pre>
<p>And below is a client request example to illustrate how the feature works.</p>
<pre class="language-bash"><a-f>curl</a-f> <a-co>-iH</a-co> <a-s>&quot;content-type: application/json&quot;</a-s> http://localhost:8787
<a-c># HTTP/1.1 200 OK</a-c>
<a-c># content-type: application/json</a-c>
<a-c># content-length: 163</a-c>
<a-c># cache-control: max-age=86400</a-c>
<a-c># date: Tue, 11 Oct 2022 23:24:55 GMT</a-c>

<a-c># [{&quot;name&quot;:&quot;spécial directöry&quot;,&quot;type&quot;:&quot;directory&quot;,&quot;mtime&quot;:&quot;2022-10-07T00:53:50Z&quot;},{&quot;name&quot;:&quot;index.html.gz&quot;,&quot;type&quot;:&quot;file&quot;,&quot;mtime&quot;:&quot;2022-09-27T22:44:34Z&quot;,&quot;size&quot;:332}]⏎</a-c></pre>
<h2>Directory Download</h2>
<p><strong><code>SWS</code></strong> supports downloading the content of a directory as a single file when <strong>Directory Listing</strong> feature is enabled. To activate, specify the list of download format to enable using the <code>--directory-listing-download</code> flag or the equivalent <a href="/fork/static-web-server/ref/allow-symlink/blob/docs/content/configuration/environment-variables.md#server_directory_listing_download">SERVER_DIRECTORY_LISTING_DOWNLOAD</a> env. Currently, <code>targz</code> format is supported.</p>
<pre class="language-bash"><a-f>static-web-server</a-f> \
    <a-co>--directory-listing=true</a-co> \
    <a-co>--directory-listing-download=targz</a-co></pre>
<p>When <strong>Directory Download</strong> is enabled, append <code>?download</code> to a directory URL to download it. A link will also be added to the top part of <strong>HTML</strong> output format.</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>Directory Listing</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 a directory listing feature to display the content of directories.</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">This feature is disabled by default and can be controlled by the boolean `-z, --directory-listing` option or the equivalent [SERVER_DIRECTORY_LISTING](./../configuration/environment-variables.md#server_directory_listing) env.</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-p>```</a-p><a-tl>sh</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>static-web-server \</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"><a-p>    --port 8787 \</a-p></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>    --root ./my-public-dir \</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>    --directory-listing true</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>```</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>And here is an example of how the directory listing looks like.</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"></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>img</a-tg><a-p> </a-p><a-at>title</a-at><a-p>=&quot;</a-p><a-s>SWS - Directory Listing</a-s><a-p>&quot; </a-p><a-at>src</a-at><a-p>=&quot;</a-p><a-s>https://user-images.githubusercontent.com/1700322/145420578-5a508d2a-773b-4239-acc0-197ea2062ff4.png</a-s><a-p>&quot; </a-p><a-at>width</a-at><a-p>=&quot;</a-p><a-s>400</a-s><a-p>&quot;&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"></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>Relative paths for entries</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"><a-p>SWS uses relative paths for the directory listing entries (file or directory) and is used regardless of the [redirect trailing slash](../features/trailing-slash-redirect.md) feature.</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"></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>However, when the *&quot;redirect trailing slash&quot;* feature is disabled and a directory request URI doesn&#39;t contain a trailing slash then the entries will contain the path `parent-dir/entry-name` as the link value. Otherwise, just an `entry-name` link value is used (default behavior).</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"></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>Note also that in both cases, SWS will append a trailing slash to the entry if is a directory.</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"></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>Sorting</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"><a-p>Sorting by `Name`, `Last modified` and `Size` is enabled as clickable columns when the directory listing is activated via the `--directory-listing=true` option.</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"></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>You can also use the `sort` query parameter to sort manually by certain attributes from URI. E.g `https://localhost/?sort=5`.</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>### </a-p><a-tt>Sorting by default</a-tt></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>Sometimes one wants to sort by a certain attribute but by **default**. In that case, the default ascending or descending ordering of files/dirs by their attributes is provided by the numeric `--directory-listing-order` option or the equivalent [SERVER_DIRECTORY_LISTING_ORDER](./../configuration/environment-variables.md#server_directory_listing_order) env.</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>To do so you have to pass a [code sorting number](#code-numbers-for-sorting). E.g `--directory-listing-order=2`.</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>### </a-p><a-tt>Code numbers for sorting</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"><a-p>Below are the possible number code values for sorting or ordering which are grouped by attribute.</a-p></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>Name</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"><a-p>- `0`: Ascending</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>- `1`: Descending</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"></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>#### </a-p><a-tt>Last modified</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L48" href="#L48">48</a><span class="code-text"></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>- `2`: Ascending</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>- `3`: Descending</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"></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>#### </a-p><a-tt>Size</a-tt></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>- `4`: Ascending</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>- `5`: Descending</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"></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>#### </a-p><a-tt>Default</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L58" href="#L58">58</a><span class="code-text"></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>- `6`: Unordered</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"></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>!!! tip &quot;Tips&quot;</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"></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-tl>    - The `--directory-listing-order` option depends on `--directory-listing` to be enabled.</a-tl></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>    </a-p><a-tl>- Use the query `?sort=NUMBER` to customize the sorting via the URI. E.g `https://localhost/?sort=5` (sort by size in descending order)</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L65" href="#L65">65</a><span class="code-text"></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>Example:</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"></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-tl>sh</a-tl></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>static-web-server \</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>    --port 8787 \</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>    --root ./my-public-dir \</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>    --directory-listing true \</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>    # E.g Sorting file/dir names in descending order</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>    --directory-listing-order 1</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>```</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"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L77" href="#L77">77</a><span class="code-text"><a-p>## </a-p><a-tt>Output format</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L78" href="#L78">78</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L79" href="#L79">79</a><span class="code-text"><a-p>**`SWS`** provides support for specifying an output format either HTML (default) or JSON for the directory listing entries via the string `--directory-listing-format` option or the equivalent [SERVER_DIRECTORY_LISTING_FORMAT](./../configuration/environment-variables.md#server_directory_listing_format) env.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L80" href="#L80">80</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L81" href="#L81">81</a><span class="code-text"><a-p>!!! tip &quot;Tips&quot;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L82" href="#L82">82</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L83" href="#L83">83</a><span class="code-text"><a-tl>    - The `--directory-listing-format` option depends on `--directory-listing` to be enabled.</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L84" href="#L84">84</a><span class="code-text"></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>### </a-p><a-tt>HTML format</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L86" href="#L86">86</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L87" href="#L87">87</a><span class="code-text"><a-p>This is the default format when `--directory-listing` is enabled.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L88" href="#L88">88</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L89" href="#L89">89</a><span class="code-text"><a-p>### </a-p><a-tt>JSON format</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L90" href="#L90">90</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L91" href="#L91">91</a><span class="code-text"><a-p>The JSON format used is shown below for directories and files. Note that the `size` attribute is only available for files and the `mtime` value is UTC-based.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L92" href="#L92">92</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L93" href="#L93">93</a><span class="code-text"><a-p>```</a-p><a-tl>json</a-tl></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></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L95" href="#L95">95</a><span class="code-text"><a-p>  {</a-p></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-s>&quot;name&quot;</a-s><a-p>: </a-p><a-s>&quot;my-directory&quot;</a-s><a-p>,</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"><a-p>    </a-p><a-s>&quot;type&quot;</a-s><a-p>: </a-p><a-s>&quot;directory&quot;</a-s><a-p>,</a-p></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>    </a-p><a-s>&quot;mtime&quot;</a-s><a-p>: </a-p><a-s>&quot;2022-10-07T00:53:50Z&quot;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L99" href="#L99">99</a><span class="code-text"><a-p>  },</a-p></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></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L101" href="#L101">101</a><span class="code-text"><a-p>    </a-p><a-s>&quot;name&quot;</a-s><a-p>: </a-p><a-s>&quot;my_file.tar.gz&quot;</a-s><a-p>,</a-p></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>    </a-p><a-s>&quot;type&quot;</a-s><a-p>: </a-p><a-s>&quot;file&quot;</a-s><a-p>,</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"><a-p>    </a-p><a-s>&quot;mtime&quot;</a-s><a-p>: </a-p><a-s>&quot;2022-09-27T22:44:34Z&quot;</a-s><a-p>,</a-p></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-s>&quot;size&quot;</a-s><a-p>: </a-p><a-n>332</a-n></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L105" href="#L105">105</a><span class="code-text"><a-p>  }</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L106" href="#L106">106</a><span class="code-text"><a-p>]</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L107" href="#L107">107</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L108" href="#L108">108</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L109" href="#L109">109</a><span class="code-text"><a-p>Here is an example of serving the directory listing in JSON format.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L110" href="#L110">110</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L111" href="#L111">111</a><span class="code-text"><a-p>```</a-p><a-tl>sh</a-tl></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>static-web-server \</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L113" href="#L113">113</a><span class="code-text"><a-p>    -p=8787 -d=tests/fixtures/public -g=trace \</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L114" href="#L114">114</a><span class="code-text"><a-p>    --directory-listing=true \</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L115" href="#L115">115</a><span class="code-text"><a-p>    --directory-listing-format=&quot;json&quot;</a-p></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></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"><a-p>And below is a client request example to illustrate how the feature works.</a-p></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-tl>sh</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L121" href="#L121">121</a><span class="code-text"><a-p>curl -iH &quot;content-type: application/json&quot; http://localhost:8787</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L122" href="#L122">122</a><span class="code-text"><a-p># HTTP/1.1 200 OK</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L123" href="#L123">123</a><span class="code-text"><a-p># content-type: application/json</a-p></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># content-length: 163</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L125" href="#L125">125</a><span class="code-text"><a-p># cache-control: max-age=86400</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L126" href="#L126">126</a><span class="code-text"><a-p># date: Tue, 11 Oct 2022 23:24:55 GMT</a-p></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># [{&quot;name&quot;:&quot;spécial directöry&quot;,&quot;type&quot;:&quot;directory&quot;,&quot;mtime&quot;:&quot;2022-10-07T00:53:50Z&quot;},{&quot;name&quot;:&quot;index.html.gz&quot;,&quot;type&quot;:&quot;file&quot;,&quot;mtime&quot;:&quot;2022-09-27T22:44:34Z&quot;,&quot;size&quot;:332}]⏎</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L129" href="#L129">129</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L130" href="#L130">130</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L131" href="#L131">131</a><span class="code-text"><a-p>## </a-p><a-tt>Directory Download</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L132" href="#L132">132</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L133" href="#L133">133</a><span class="code-text"><a-p>**`SWS`** supports downloading the content of a directory as a single file when **Directory Listing** feature is enabled. To activate, specify the list of download format to enable using the `--directory-listing-download` flag or the equivalent [SERVER_DIRECTORY_LISTING_DOWNLOAD](./../configuration/environment-variables.md#server_directory_listing_download) env. Currently, `targz` format is supported.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L134" href="#L134">134</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L135" href="#L135">135</a><span class="code-text"><a-p>```</a-p><a-tl>sh</a-tl></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>static-web-server \</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L137" href="#L137">137</a><span class="code-text"><a-p>    --directory-listing=true \</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L138" href="#L138">138</a><span class="code-text"><a-p>    --directory-listing-download=targz</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L139" href="#L139">139</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L140" href="#L140">140</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L141" href="#L141">141</a><span class="code-text">When **Directory Download** is enabled, append `?download` to a directory URL to download it. A link will also be added to the top part of **HTML** output format.</span></span></pre></div></div>
</main>
</body>
</html>
