Skip to content

docs: correct the engine tuning facts, add the recovery catalog row, show in-process HTTPS on std - #71

Merged
FumingPower3925 merged 1 commit into
mainfrom
docs/celeris-415-418
Sep 19, 2026
Merged

FumingPower3925 merged 1 commit into
mainfrom
docs/celeris-415-418

Conversation

@FumingPower3925

Copy link
Copy Markdown
Contributor

The docs-site half of goceleris/celeris#415 and #418. The celeris README half is goceleris/celeris#677.

Refs goceleris/celeris#415, goceleris/celeris#418

  • engines.md
    • CELERIS_ADAPTIVE_START only chooses the start engine. The page said it "disables runtime switching", but chooseStartEngine is the variable's only reader (celeris 5b2e83b), so the controller can still switch. The page now points to Config.Engine for a single engine with no switching.
    • The High tier row and the feature matrix claimed multishot recv, provided buffer rings and fixed files. Multishot recv with a provided buffer ring is opt-in: the ring is created only under CELERIS_IOURING_MULTISHOT_RECV=1. Fixed files are development-only (celeris#541).
    • New table of the tuning environment variables, each as the code reads it: values, default, and what an unrecognised value does. CELERIS_MAX_IOURING_TIER treats a typo as none, which disables the io_uring engine. The PBUF_COUNT default is effectively 1024.
  • middleware.md: recovery was named only in prose. It now has a catalog row under a new Error handling category, linking the Error handling page.
  • deployment.md: shows the in-process HTTPS route that works today, the std engine with StartWithListener(tls.NewListener(...)), next to the loopback terminator. I checked it at celeris 5b2e83b with the std engine: status 200, HTTP/1.1, c.Scheme() == "https", c.IsTLS() == true.

Left for after the celeris#657 fix lands: the Adaptive section says a busy connection "is never stranded on the slower engine". celeris#657 shows async and idle connections can be, and its fix is in progress.

…and show in-process HTTPS on std (goceleris/celeris#415, #418)

engines.md:
- CELERIS_ADAPTIVE_START chooses only the start engine; it does not turn
  off runtime switching (chooseStartEngine is its only reader). Point to
  Config.Engine for a single engine with no switching.
- The High tier does not turn on multishot recv, provided buffer rings or
  fixed files: multishot recv with a provided buffer ring is opt-in
  (CELERIS_IOURING_MULTISHOT_RECV=1) and fixed files are development-only
  (celeris#541). The feature matrix says the same.
- A table of the tuning environment variables, each as the code at
  celeris 5b2e83b reads it.

middleware.md: recovery was named only in prose; it now has a catalog row
under a new Error handling category.

deployment.md: in-process HTTPS works today on the std engine with
StartWithListener(tls.NewListener(...)) (HTTP/1.1; checked at celeris
5b2e83b: 200, scheme https, IsTLS true). Show it alongside the loopback
terminator, and link celeris#446.
@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Sep 19, 2026 •

Copy link
Copy Markdown

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Preview URL Updated (UTC)
✅ Deployment successful!
View logs
goceleris-docs 1ed8185 Commit Preview URL

Branch Preview URL
Sep 19 2026, 06:39 AM

@FumingPower3925
FumingPower3925 merged commit f7b6095 into main Sep 19, 2026
5 checks passed
@FumingPower3925
FumingPower3925 deleted the docs/celeris-415-418 branch September 19, 2026 06:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant