Skip to content

Fix misleading claims in landing page config #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jkyberneees merged 1 commit into from
Mar 15, 2026
Merged

Fix misleading claims in landing page config #9

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions CLI.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -215,6 +215,12 @@ Grouped by concern for readability. All flags are optional; unset flags do not o
|------|------|---------|--------------|
| `--no-compress` | bool | `false` | `compression.enabled = false` |

#### Headers

| Flag | Type | Default | Config field |
|------|------|---------|--------------|
| `--no-etag` | bool | `false` | `headers.enable_etags = false` |

#### Security

| Flag | Type | Default | Config field |
Expand Down
16 changes: 13 additions & 3 deletions docs/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@
"Startup preloading with path-safety cache pre-warming",
"TTL-aware cache expiry with optional automatic stale-entry eviction",
"Direct ctx.SetBody() fast path with pre-formatted headers for cache hits",
"HTTP/2 with automatic HTTPS",
"HTTP/2 with TLS 1.2+ and HTTP→HTTPS redirect",
"TLS 1.2+ with AEAD cipher suites",
"gzip and brotli compression",
"6-step path traversal prevention",
Expand Down Expand Up @@ -235,7 +235,7 @@ <h1 class="hero-title">static-web</h1>
<div class="stat-divider" aria-hidden="true"></div>
<div class="stat">
<span class="stat-value">HTTP/2</span>
<span class="stat-label">+ auto HTTPS</span>
<span class="stat-label">+ TLS + redirect</span>
</div>
<div class="stat-divider" aria-hidden="true"></div>
<div class="stat">
Expand Down Expand Up @@ -479,7 +479,7 @@ <h2 class="section-title" id="getting-started-heading">Getting Started</h2>
<span class="toml-key">static_max_age</span> = <span class="number">3600</span> <span class="comment"># 1 hour for static assets</span>
<span class="toml-key">html_max_age</span> = <span class="number">0</span> <span class="comment"># no-cache for HTML</span>
<span class="toml-key">enable_etags</span> = <span class="boolean">false</span> <span class="comment"># disable for max throughput</span>
<span class="toml-key">immutable_pattern</span> = <span class="string">"*.js"</span> <span class="comment"># mark .js as immutable</span>
<span class="toml-key">immutable_pattern</span> = <span class="string">"*.chunk.js"</span> <span class="comment"># fingerprinted assets only</span>

<span class="toml-section">[security]</span>
<span class="toml-key">block_dotfiles</span> = <span class="boolean">true</span>
Expand Down Expand Up @@ -779,6 +779,11 @@ <h2 class="section-title" id="configuration-heading">Configuration Reference</h2
<td>—</td>
<td>Path to TLS private key (PEM)</td>
</tr>
<tr>
<td><code>redirect_host</code></td>
<td>—</td>
<td>Canonical host for HTTP→HTTPS redirect</td>
</tr>
<tr>
<td><code>read_timeout</code></td>
<td><code>10s</code></td>
Expand Down Expand Up @@ -946,6 +951,11 @@ <h2 class="section-title" id="configuration-heading">Configuration Reference</h2
</tr>
</thead>
<tbody>
<tr>
<td><code>enable_etags</code></td>
<td><code>true</code></td>
<td>Enable ETag generation and If-None-Match validation</td>
</tr>
<tr>
<td><code>immutable_pattern</code></td>
<td>—</td>
Expand Down
Loading