Skip to content

docs: the minimum Go version is 1.27.3 (Refs celeris#1102) #110

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
FumingPower3925 merged 1 commit into from
Oct 21, 2026
Merged

docs: the minimum Go version is 1.27.3 (Refs celeris#1102) #110

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
2 changes: 1 addition & 1 deletion src/content/docs/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Celeris source.

| Requirement | Notes |
| --- | --- |
| **Go 1.27.2 or newer** | Celeris targets the current Go toolchain. |
| **Go 1.27.3 or newer** | Celeris targets the current Go toolchain. |
| **Linux** for the high-performance engines | The `io_uring` engine needs kernel **5.10+**; the `epoll` engine needs kernel **3.10+**. |
| Any other OS (macOS, Windows, BSD) | Supported via automatic fallback to the portable `std` (`net/http`) engine — no code changes needed. |

Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/introduction.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ around Celeris.
| **Native engines are Linux-only** | io_uring, epoll, and adaptive exist only on Linux. On macOS/Windows/BSD, Celeris automatically uses the **std** (`net/http`) engine — your code is unchanged, but you won't see native-engine performance off Linux. This fallback is automatic; you do not configure it. |
| **No built-in TLS** | Celeris has **no HTTPS listener and no TLS configuration** — `Config` exposes no certificate fields, and every engine (io_uring, epoll, adaptive, and std) binds a plain TCP listener. Terminate TLS at an upstream proxy (Caddy, Nginx, Envoy) and forward cleartext to Celeris. See [Deployment](/docs/deployment). |
| **Cleartext H1 / h2c only** | Protocols are HTTP/1.1 and HTTP/2 *cleartext* (h2c). There is no h2 over TLS (ALPN) because there is no TLS. `Protocol: celeris.Auto` (the default) detects H1 vs h2c per connection. |
| **Go 1.27.2+** | Celeris requires a modern toolchain (the module declares `go 1.27.2`). Build with Go 1.27.2 or newer. |
| **Go 1.27.3+** | Celeris requires a modern toolchain (the module declares `go 1.27.3`). Build with Go 1.27.3 or newer. |

> **Common pitfall — expecting `https://`.** A fresh Celeris server listens on
> plain TCP. `curl https://localhost:8080` will fail; `curl http://localhost:8080`
Expand All @@ -145,7 +145,7 @@ Operations. If you just want to ship, jump straight to
- **Module:** `github.com/goceleris/celeris` · **package:** `celeris`.
- **Version:** the running version is the exported `celeris.Version` constant
(currently `1.5.8`). Pin a version in your `go.mod` and upgrade deliberately.
- **Go toolchain:** Go 1.27.2+ (the module targets `go 1.27.2`).
- **Go toolchain:** Go 1.27.3+ (the module targets `go 1.27.3`).
- **Platforms:** Linux for io_uring/epoll/adaptive; any OS Go supports for the
std engine. The engine choice is automatic unless you set
[`Config.Engine`](/docs/configuration).
Expand Down
Loading