Skip to content

Commit 51fde02

Browse files
committed
docs: fix misleading claims in landing page config
- Fix 'HTTP/2 with automatic HTTPS' claim (no ACME support) - Fix immutable_pattern example from *.js to *.chunk.js - Add missing enable_etags config attribute to docs - Add missing redirect_host config attribute to docs - Add missing --no-etag CLI flag to CLI.md
1 parent 16809fe commit 51fde02

File tree

2 files changed

+19
-3
lines changed

2 files changed

+19
-3
lines changed

CLI.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -215,6 +215,12 @@ Grouped by concern for readability. All flags are optional; unset flags do not o
215215
|------|------|---------|--------------|
216216
| `--no-compress` | bool | `false` | `compression.enabled = false` |
217217

218+
#### Headers
219+
220+
| Flag | Type | Default | Config field |
221+
|------|------|---------|--------------|
222+
| `--no-etag` | bool | `false` | `headers.enable_etags = false` |
223+
218224
#### Security
219225

220226
| Flag | Type | Default | Config field |

docs/index.html

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@
9292
"Startup preloading with path-safety cache pre-warming",
9393
"TTL-aware cache expiry with optional automatic stale-entry eviction",
9494
"Direct ctx.SetBody() fast path with pre-formatted headers for cache hits",
95-
"HTTP/2 with automatic HTTPS",
95+
"HTTP/2 with TLS 1.2+ and HTTP→HTTPS redirect",
9696
"TLS 1.2+ with AEAD cipher suites",
9797
"gzip and brotli compression",
9898
"6-step path traversal prevention",
@@ -235,7 +235,7 @@ <h1 class="hero-title">static-web</h1>
235235
<div class="stat-divider" aria-hidden="true"></div>
236236
<div class="stat">
237237
<span class="stat-value">HTTP/2</span>
238-
<span class="stat-label">+ auto HTTPS</span>
238+
<span class="stat-label">+ TLS + redirect</span>
239239
</div>
240240
<div class="stat-divider" aria-hidden="true"></div>
241241
<div class="stat">
@@ -479,7 +479,7 @@ <h2 class="section-title" id="getting-started-heading">Getting Started</h2>
479479
<span class="toml-key">static_max_age</span> = <span class="number">3600</span> <span class="comment"># 1 hour for static assets</span>
480480
<span class="toml-key">html_max_age</span> = <span class="number">0</span> <span class="comment"># no-cache for HTML</span>
481481
<span class="toml-key">enable_etags</span> = <span class="boolean">false</span> <span class="comment"># disable for max throughput</span>
482-
<span class="toml-key">immutable_pattern</span> = <span class="string">"*.js"</span> <span class="comment"># mark .js as immutable</span>
482+
<span class="toml-key">immutable_pattern</span> = <span class="string">"*.chunk.js"</span> <span class="comment"># fingerprinted assets only</span>
483483

484484
<span class="toml-section">[security]</span>
485485
<span class="toml-key">block_dotfiles</span> = <span class="boolean">true</span>
@@ -779,6 +779,11 @@ <h2 class="section-title" id="configuration-heading">Configuration Reference</h2
779779
<td></td>
780780
<td>Path to TLS private key (PEM)</td>
781781
</tr>
782+
<tr>
783+
<td><code>redirect_host</code></td>
784+
<td></td>
785+
<td>Canonical host for HTTP→HTTPS redirect</td>
786+
</tr>
782787
<tr>
783788
<td><code>read_timeout</code></td>
784789
<td><code>10s</code></td>
@@ -946,6 +951,11 @@ <h2 class="section-title" id="configuration-heading">Configuration Reference</h2
946951
</tr>
947952
</thead>
948953
<tbody>
954+
<tr>
955+
<td><code>enable_etags</code></td>
956+
<td><code>true</code></td>
957+
<td>Enable ETag generation and If-None-Match validation</td>
958+
</tr>
949959
<tr>
950960
<td><code>immutable_pattern</code></td>
951961
<td></td>

0 commit comments

Comments
 (0)