diff --git a/docs/api/fiber.md b/docs/api/fiber.md
index 2c50339d50..a34a5d944c 100644
--- a/docs/api/fiber.md
+++ b/docs/api/fiber.md
@@ -114,8 +114,9 @@ app.Listen(":8080", fiber.ListenConfig{
| ListenerAddrFunc | `func(addr net.Addr)` | Allows accessing and customizing `net.Listener`. | `nil` |
| ListenerNetwork | `string` | Known networks are "tcp", "tcp4" (IPv4-only), "tcp6" (IPv6-only). WARNING: When prefork is set to true, only "tcp4" and "tcp6" can be chosen. | `tcp4` |
| OnShutdownError | `func(err error)` | Allows to customize error behavior when gracefully shutting down the server by given signal. Prints error with `log.Fatalf()` | `nil` |
-| OnShutdownSuccess | `func()` | Allows customizing success behavior when gracefully shutting down the server by given signal. | `nil` |
+| OnShutdownSuccess | `func()` | Allows customizing success behavior when gracefully shutting down the server by given signal. | `nil` |
| TLSConfigFunc | `func(tlsConfig *tls.Config)` | Allows customizing `tls.Config` as you want. | `nil` |
+| AutoCertManager | `func(tlsConfig *tls.Config)` | Manages TLS certificates automatically using the ACME protocol. Enables integration with Let's Encrypt or other ACME-compatible providers. | `nil` |
### Listen
@@ -166,6 +167,25 @@ app.Listen(":443", fiber.ListenConfig{CertClientFile: "./ca-chain-cert.pem"})
app.Listen(":443", fiber.ListenConfig{CertFile: "./cert.pem", CertKeyFile: "./cert.key", CertClientFile: "./ca-chain-cert.pem"})
```
+#### TLS AutoCert support (ACME / Let's Encrypt)
+
+Provides automatic access to certificates management from Let's Encrypt and any other ACME-based providers.
+
+```go title="Examples"
+// Certificate manager
+certManager := &autocert.Manager{
+ Prompt: autocert.AcceptTOS,
+ // Replace with your domain name
+ HostPolicy: autocert.HostWhitelist("example.com"),
+ // Folder to store the certificates
+ Cache: autocert.DirCache("./certs"),
+}
+
+app.Listen(":444", fiber.ListenConfig{
+ AutoCertManager: certManager,
+})
+```
+
### Listener
You can pass your own [`net.Listener`](https://pkg.go.dev/net/#Listener) using the `Listener` method. This method can be used to enable **TLS/HTTPS** with a custom tls.Config.
diff --git a/docs/whats_new.md b/docs/whats_new.md
index 3221f5dd5e..bfc6f25c29 100644
--- a/docs/whats_new.md
+++ b/docs/whats_new.md
@@ -130,6 +130,25 @@ In this example, a custom context `CustomCtx` is created with an additional meth
+#### TLS AutoCert support (ACME / Let's Encrypt)
+
+We have added native support for automatic certificates management from Let's Encrypt and any other ACME-based providers.
+
+```go
+// Certificate manager
+certManager := &autocert.Manager{
+ Prompt: autocert.AcceptTOS,
+ // Replace with your domain name
+ HostPolicy: autocert.HostWhitelist("example.com"),
+ // Folder to store the certificates
+ Cache: autocert.DirCache("./certs"),
+}
+
+app.Listen(":444", fiber.ListenConfig{
+ AutoCertManager: certManager,
+})
+```
+
## 🗺 Router
We have slightly adapted our router interface
@@ -175,22 +194,22 @@ The route method is now like [`Express`](https://expressjs.com/de/api.html#app.r
```go
app.Route("/api").Route("/user/:id?")
- .Get(func(c fiber.Ctx) error {
- // Get user
- return c.JSON(fiber.Map{"message": "Get user", "id": c.Params("id")})
- })
- .Post(func(c fiber.Ctx) error {
- // Create user
- return c.JSON(fiber.Map{"message": "User created"})
- })
- .Put(func(c fiber.Ctx) error {
- // Update user
- return c.JSON(fiber.Map{"message": "User updated", "id": c.Params("id")})
- })
- .Delete(func(c fiber.Ctx) error {
- // Delete user
- return c.JSON(fiber.Map{"message": "User deleted", "id": c.Params("id")})
- })
+ .Get(func(c fiber.Ctx) error {
+ // Get user
+ return c.JSON(fiber.Map{"message": "Get user", "id": c.Params("id")})
+ })
+ .Post(func(c fiber.Ctx) error {
+ // Create user
+ return c.JSON(fiber.Map{"message": "User created"})
+ })
+ .Put(func(c fiber.Ctx) error {
+ // Update user
+ return c.JSON(fiber.Map{"message": "User updated", "id": c.Params("id")})
+ })
+ .Delete(func(c fiber.Ctx) error {
+ // Delete user
+ return c.JSON(fiber.Map{"message": "User deleted", "id": c.Params("id")})
+ })
```
@@ -209,14 +228,14 @@ Registering a subapp is now also possible via the [`Use`](./api/app#use) method
```go
// register mulitple prefixes
app.Use(["/v1", "/v2"], func(c fiber.Ctx) error {
- // Middleware for /v1 and /v2
- return c.Next()
+ // Middleware for /v1 and /v2
+ return c.Next()
})
// define subapp
api := fiber.New()
api.Get("/user", func(c fiber.Ctx) error {
- return c.SendString("User")
+ return c.SendString("User")
})
// register subapp
app.Use("/api", api)
@@ -242,14 +261,14 @@ The `app.Test()` method now allows users to customize their test configurations:
// Create a test app with a handler to test
app := fiber.New()
app.Get("/", func(c fiber.Ctx) {
- return c.SendString("hello world")
+ return c.SendString("hello world")
})
// Define the HTTP request and custom TestConfig to test the handler
req := httptest.NewRequest(MethodGet, "/", nil)
testConfig := fiber.TestConfig{
- Timeout: 0,
- FailOnTimeout: false,
+ Timeout: 0,
+ FailOnTimeout: false,
}
// Test the handler using the request and testConfig
@@ -277,8 +296,8 @@ If a custom `TestConfig` isn't provided, then the following will be used:
```go
testConfig := fiber.TestConfig{
- Timeout: time.Second,
- FailOnTimeout: true,
+ Timeout: time.Second,
+ FailOnTimeout: true,
}
```
@@ -288,8 +307,8 @@ An empty `TestConfig` is the equivalent of:
```go
testConfig := fiber.TestConfig{
- Timeout: 0,
- FailOnTimeout: false,
+ Timeout: 0,
+ FailOnTimeout: false,
}
```
@@ -340,7 +359,7 @@ testConfig := fiber.TestConfig{
### SendStreamWriter
-In v3, we added support for buffered streaming by providing the new method `SendStreamWriter()`.
+In v3, we introduced support for buffered streaming with the addition of the `SendStreamWriter` method:
```go
func (c Ctx) SendStreamWriter(streamWriter func(w *bufio.Writer))
@@ -354,22 +373,22 @@ With this new method, you can implement:
```go
app.Get("/sse", func(c fiber.Ctx) {
- c.Set("Content-Type", "text/event-stream")
- c.Set("Cache-Control", "no-cache")
- c.Set("Connection", "keep-alive")
- c.Set("Transfer-Encoding", "chunked")
-
- return c.SendStreamWriter(func(w *bufio.Writer) {
- for {
- fmt.Fprintf(w, "event: my-event\n")
- fmt.Fprintf(w, "data: Hello SSE\n\n")
-
- if err := w.Flush(); err != nil {
- log.Print("Client disconnected!")
- return
- }
- }
- })
+ c.Set("Content-Type", "text/event-stream")
+ c.Set("Cache-Control", "no-cache")
+ c.Set("Connection", "keep-alive")
+ c.Set("Transfer-Encoding", "chunked")
+
+ return c.SendStreamWriter(func(w *bufio.Writer) {
+ for {
+ fmt.Fprintf(w, "event: my-event\n")
+ fmt.Fprintf(w, "data: Hello SSE\n\n")
+
+ if err := w.Flush(); err != nil {
+ log.Print("Client disconnected!")
+ return
+ }
+ }
+ })
})
```
@@ -397,17 +416,17 @@ Fiber v3 introduces a new binding mechanism that simplifies the process of bindi
```go
type User struct {
- ID int `params:"id"`
- Name string `json:"name"`
- Email string `json:"email"`
+ ID int `params:"id"`
+ Name string `json:"name"`
+ Email string `json:"email"`
}
app.Post("/user/:id", func(c fiber.Ctx) error {
- var user User
- if err := c.Bind().Body(&user); err != nil {
- return c.Status(fiber.StatusBadRequest).JSON(fiber.Map{"error": err.Error()})
- }
- return c.JSON(user)
+ var user User
+ if err := c.Bind().Body(&user); err != nil {
+ return c.Status(fiber.StatusBadRequest).JSON(fiber.Map{"error": err.Error()})
+ }
+ return c.JSON(user)
})
```
@@ -430,11 +449,11 @@ Fiber v3 enhances the redirect functionality by introducing new methods and impr
```go
app.Get("/old", func(c fiber.Ctx) error {
- return c.Redirect().To("/new")
+ return c.Redirect().To("/new")
})
app.Get("/new", func(c fiber.Ctx) error {
- return c.SendString("Welcome to the new route!")
+ return c.SendString("Welcome to the new route!")
})
```
@@ -461,22 +480,22 @@ Fiber v3 introduces new generic functions that provide additional utility and fl
package main
import (
- "strconv"
- "github.com/gofiber/fiber/v3"
+ "strconv"
+ "github.com/gofiber/fiber/v3"
)
func main() {
- app := fiber.New()
+ app := fiber.New()
- app.Get("/convert", func(c fiber.Ctx) error {
- value, err := Convert[string](c.Query("value"), strconv.Atoi, 0)
- if err != nil {
- return c.Status(fiber.StatusBadRequest).SendString(err.Error())
- }
- return c.JSON(value)
- })
+ app.Get("/convert", func(c fiber.Ctx) error {
+ value, err := Convert[string](c.Query("value"), strconv.Atoi, 0)
+ if err != nil {
+ return c.Status(fiber.StatusBadRequest).SendString(err.Error())
+ }
+ return c.JSON(value)
+ })
- app.Listen(":3000")
+ app.Listen(":3000")
}
```
@@ -540,20 +559,19 @@ curl "http://localhost:3000/user/5"
package main
import (
- "github.com/gofiber/fiber/v3"
+ "github.com/gofiber/fiber/v3"
)
func main() {
- app := fiber.New()
+ app := fiber.New()
- app.Get("/params/:id", func(c fiber.Ctx) error {
- id := Params[int](c, "id", 0)
- return c.JSON(id)
- })
+ app.Get("/params/:id", func(c fiber.Ctx) error {
+ id := Params[int](c, "id", 0)
+ return c.JSON(id)
+ })
- app.Listen(":3000")
+ app.Listen(":3000")
}
-
```
```sh
@@ -573,24 +591,23 @@ curl "http://localhost:3000/params/abc"
package main
import (
- "github.com/gofiber/fiber/v3"
+ "github.com/gofiber/fiber/v3"
)
func main() {
- app := fiber.New()
+ app := fiber.New()
- app.Get("/query", func(c fiber.Ctx) error {
- age := Query[int](c, "age", 0)
- return c.JSON(age)
- })
+ app.Get("/query", func(c fiber.Ctx) error {
+ age := Query[int](c, "age", 0)
+ return c.JSON(age)
+ })
- app.Listen(":3000")
+ app.Listen(":3000")
}
```
```sh
-
curl "http://localhost:3000/query?age=25"
# Output: 25
@@ -607,18 +624,18 @@ curl "http://localhost:3000/query?age=abc"
package main
import (
- "github.com/gofiber/fiber/v3"
+ "github.com/gofiber/fiber/v3"
)
func main() {
- app := fiber.New()
+ app := fiber.New()
- app.Get("/header", func(c fiber.Ctx) error {
- userAgent := GetReqHeader[string](c, "User-Agent", "Unknown")
- return c.JSON(userAgent)
- })
+ app.Get("/header", func(c fiber.Ctx) error {
+ userAgent := GetReqHeader[string](c, "User-Agent", "Unknown")
+ return c.JSON(userAgent)
+ })
- app.Listen(":3000")
+ app.Listen(":3000")
}
```
@@ -805,7 +822,7 @@ Since we've removed `app.Static()`, you need to move methods to static middlewar
app.Static("/", "./public")
app.Static("/prefix", "./public")
app.Static("/prefix", "./public", Static{
- Index: "index.htm",
+ Index: "index.htm",
})
app.Static("*", "./public/index.html")
```
@@ -815,7 +832,7 @@ app.Static("*", "./public/index.html")
app.Get("/*", static.New("./public"))
app.Get("/prefix*", static.New("./public"))
app.Get("/prefix*", static.New("./public", static.Config{
- IndexNames: []string{"index.htm", "index.html"},
+ IndexNames: []string{"index.htm", "index.html"},
}))
app.Get("*", static.New("./public/index.html"))
```
@@ -831,25 +848,25 @@ We've renamed `EnableTrustedProxyCheck` to `TrustProxy` and moved `TrustedProxie
```go
// Before
app := fiber.New(fiber.Config{
- // EnableTrustedProxyCheck enables the trusted proxy check.
- EnableTrustedProxyCheck: true,
- // TrustedProxies is a list of trusted proxy IP ranges/addresses.
- TrustedProxies: []string{"0.8.0.0", "127.0.0.0/8", "::1/128"},
+ // EnableTrustedProxyCheck enables the trusted proxy check.
+ EnableTrustedProxyCheck: true,
+ // TrustedProxies is a list of trusted proxy IP ranges/addresses.
+ TrustedProxies: []string{"0.8.0.0", "127.0.0.0/8", "::1/128"},
})
```
```go
// After
app := fiber.New(fiber.Config{
- // TrustProxy enables the trusted proxy check
- TrustProxy: true,
- // TrustProxyConfig allows for configuring trusted proxies.
- TrustProxyConfig: fiber.TrustProxyConfig{
- // Proxies is a list of trusted proxy IP ranges/addresses.
- Proxies: []string{"0.8.0.0"},
- // Trust all loop-back IP addresses (127.0.0.0/8, ::1/128)
- Loopback: true,
- }
+ // TrustProxy enables the trusted proxy check
+ TrustProxy: true,
+ // TrustProxyConfig allows for configuring trusted proxies.
+ TrustProxyConfig: fiber.TrustProxyConfig{
+ // Proxies is a list of trusted proxy IP ranges/addresses.
+ Proxies: []string{"0.8.0.0"},
+ // Trust all loop-back IP addresses (127.0.0.0/8, ::1/128)
+ Loopback: true,
+ }
})
```
@@ -890,21 +907,21 @@ app.Route("/api", func(apiGrp Router) {
```go
// After
app.Route("/api").Route("/user/:id?")
- .Get(func(c fiber.Ctx) error {
- // Get user
- return c.JSON(fiber.Map{"message": "Get user", "id": c.Params("id")})
- })
- .Post(func(c fiber.Ctx) error {
- // Create user
- return c.JSON(fiber.Map{"message": "User created"})
- });
+ .Get(func(c fiber.Ctx) error {
+ // Get user
+ return c.JSON(fiber.Map{"message": "Get user", "id": c.Params("id")})
+ })
+ .Post(func(c fiber.Ctx) error {
+ // Create user
+ return c.JSON(fiber.Map{"message": "User created"})
+ });
```
### 🗺 RebuildTree
-We have added a new method that allows the route tree stack to be rebuilt in runtime, with it, you can add a route while your application is running and rebuild the route tree stack to make it registered and available for calls.
+We introduced a new method that enables rebuilding the route tree stack at runtime. This allows you to add routes dynamically while your application is running and update the route tree to make the new routes available for use.
-You can find more reference on it in the [app](./api/app.md#rebuildtree):
+For more details, refer to the [app documentation](./api/app.md#rebuildtree):
#### Example Usage
@@ -920,10 +937,9 @@ app.Get("/define", func(c Ctx) error { // Define a new route dynamically
})
```
-In this example, a new route is defined and then `RebuildTree()` is called to make sure the new route is registered and available.
+In this example, a new route is defined, and `RebuildTree()` is called to ensure the new route is registered and available.
-**Note:** Use this method with caution. It is **not** thread-safe and calling it can be very performance-intensive, so it should be used sparingly and only in
-development mode. Avoid using it concurrently.
+Note: Use this method with caution. It is **not** thread-safe and can be very performance-intensive. Therefore, it should be used sparingly and primarily in development mode. It should not be invoke concurrently.
### 🧠Context
@@ -946,18 +962,18 @@ In Fiber v3, the `Ctx` parameter in handlers is now an interface, which means th
package main
import (
- "github.com/gofiber/fiber/v2"
+ "github.com/gofiber/fiber/v2"
)
func main() {
- app := fiber.New()
+ app := fiber.New()
- // Route Handler with *fiber.Ctx
- app.Get("/", func(c *fiber.Ctx) error {
- return c.SendString("Hello, World!")
- })
+ // Route Handler with *fiber.Ctx
+ app.Get("/", func(c *fiber.Ctx) error {
+ return c.SendString("Hello, World!")
+ })
- app.Listen(":3000")
+ app.Listen(":3000")
}
```
@@ -967,18 +983,18 @@ func main() {
package main
import (
- "github.com/gofiber/fiber/v3"
+ "github.com/gofiber/fiber/v3"
)
func main() {
- app := fiber.New()
+ app := fiber.New()
- // Route Handler without *fiber.Ctx
- app.Get("/", func(c fiber.Ctx) error {
- return c.SendString("Hello, World!")
- })
+ // Route Handler without *fiber.Ctx
+ app.Get("/", func(c fiber.Ctx) error {
+ return c.SendString("Hello, World!")
+ })
- app.Listen(":3000")
+ app.Listen(":3000")
}
```
@@ -1002,22 +1018,22 @@ The `Parser` section in Fiber v3 has undergone significant changes to improve fu
```go
// Before
app.Post("/user", func(c *fiber.Ctx) error {
- var user User
- if err := c.BodyParser(&user); err != nil {
- return c.Status(fiber.StatusBadRequest).JSON(fiber.Map{"error": err.Error()})
- }
- return c.JSON(user)
+ var user User
+ if err := c.BodyParser(&user); err != nil {
+ return c.Status(fiber.StatusBadRequest).JSON(fiber.Map{"error": err.Error()})
+ }
+ return c.JSON(user)
})
```
```go
// After
app.Post("/user", func(c fiber.Ctx) error {
- var user User
- if err := c.Bind().Body(&user); err != nil {
- return c.Status(fiber.StatusBadRequest).JSON(fiber.Map{"error": err.Error()})
- }
- return c.JSON(user)
+ var user User
+ if err := c.Bind().Body(&user); err != nil {
+ return c.Status(fiber.StatusBadRequest).JSON(fiber.Map{"error": err.Error()})
+ }
+ return c.JSON(user)
})
```
@@ -1031,22 +1047,22 @@ The `Parser` section in Fiber v3 has undergone significant changes to improve fu
```go
// Before
app.Get("/user/:id", func(c *fiber.Ctx) error {
- var params Params
- if err := c.ParamsParser(¶ms); err != nil {
- return c.Status(fiber.StatusBadRequest).JSON(fiber.Map{"error": err.Error()})
- }
- return c.JSON(params)
+ var params Params
+ if err := c.ParamsParser(¶ms); err != nil {
+ return c.Status(fiber.StatusBadRequest).JSON(fiber.Map{"error": err.Error()})
+ }
+ return c.JSON(params)
})
```
```go
// After
app.Get("/user/:id", func(c fiber.Ctx) error {
- var params Params
- if err := c.Bind().URL(¶ms); err != nil {
- return c.Status(fiber.StatusBadRequest).JSON(fiber.Map{"error": err.Error()})
- }
- return c.JSON(params)
+ var params Params
+ if err := c.Bind().URL(¶ms); err != nil {
+ return c.Status(fiber.StatusBadRequest).JSON(fiber.Map{"error": err.Error()})
+ }
+ return c.JSON(params)
})
```
@@ -1060,22 +1076,22 @@ The `Parser` section in Fiber v3 has undergone significant changes to improve fu
```go
// Before
app.Get("/search", func(c *fiber.Ctx) error {
- var query Query
- if err := c.QueryParser(&query); err != nil {
- return c.Status(fiber.StatusBadRequest).JSON(fiber.Map{"error": err.Error()})
- }
- return c.JSON(query)
+ var query Query
+ if err := c.QueryParser(&query); err != nil {
+ return c.Status(fiber.StatusBadRequest).JSON(fiber.Map{"error": err.Error()})
+ }
+ return c.JSON(query)
})
```
```go
// After
app.Get("/search", func(c fiber.Ctx) error {
- var query Query
- if err := c.Bind().Query(&query); err != nil {
- return c.Status(fiber.StatusBadRequest).JSON(fiber.Map{"error": err.Error()})
- }
- return c.JSON(query)
+ var query Query
+ if err := c.Bind().Query(&query); err != nil {
+ return c.Status(fiber.StatusBadRequest).JSON(fiber.Map{"error": err.Error()})
+ }
+ return c.JSON(query)
})
```
@@ -1089,22 +1105,22 @@ The `Parser` section in Fiber v3 has undergone significant changes to improve fu
```go
// Before
app.Get("/cookie", func(c *fiber.Ctx) error {
- var cookie Cookie
- if err := c.CookieParser(&cookie); err != nil {
- return c.Status(fiber.StatusBadRequest).JSON(fiber.Map{"error": err.Error()})
- }
- return c.JSON(cookie)
+ var cookie Cookie
+ if err := c.CookieParser(&cookie); err != nil {
+ return c.Status(fiber.StatusBadRequest).JSON(fiber.Map{"error": err.Error()})
+ }
+ return c.JSON(cookie)
})
```
```go
// After
app.Get("/cookie", func(c fiber.Ctx) error {
- var cookie Cookie
- if err := c.Bind().Cookie(&cookie); err != nil {
- return c.Status(fiber.StatusBadRequest).JSON(fiber.Map{"error": err.Error()})
- }
- return c.JSON(cookie)
+ var cookie Cookie
+ if err := c.Bind().Cookie(&cookie); err != nil {
+ return c.Status(fiber.StatusBadRequest).JSON(fiber.Map{"error": err.Error()})
+ }
+ return c.JSON(cookie)
})
```
@@ -1124,14 +1140,14 @@ Fiber v3 enhances the redirect functionality by introducing new methods and impr
```go
// Before
app.Get("/old", func(c *fiber.Ctx) error {
- return c.RedirectToRoute("newRoute")
+ return c.RedirectToRoute("newRoute")
})
```
```go
// After
app.Get("/old", func(c fiber.Ctx) error {
- return c.Redirect().Route("newRoute")
+ return c.Redirect().Route("newRoute")
})
```
@@ -1145,14 +1161,14 @@ Fiber v3 enhances the redirect functionality by introducing new methods and impr
```go
// Before
app.Get("/back", func(c *fiber.Ctx) error {
- return c.RedirectBack()
+ return c.RedirectBack()
})
```
```go
// After
app.Get("/back", func(c fiber.Ctx) error {
- return c.Redirect().Back()
+ return c.Redirect().Back()
})
```
@@ -1166,14 +1182,14 @@ Fiber v3 enhances the redirect functionality by introducing new methods and impr
```go
// Before
app.Get("/old", func(c *fiber.Ctx) error {
- return c.Redirect("/new")
+ return c.Redirect("/new")
})
```
```go
// After
app.Get("/old", func(c fiber.Ctx) error {
- return c.Redirect().To("/new")
+ return c.Redirect().To("/new")
})
```
@@ -1226,18 +1242,18 @@ The CORS middleware has been updated to use slices instead of strings for the `A
```go
// Before
app.Use(cors.New(cors.Config{
- AllowOrigins: "https://example.com,https://example2.com",
- AllowMethods: strings.Join([]string{fiber.MethodGet, fiber.MethodPost}, ","),
- AllowHeaders: "Content-Type",
- ExposeHeaders: "Content-Length",
+ AllowOrigins: "https://example.com,https://example2.com",
+ AllowMethods: strings.Join([]string{fiber.MethodGet, fiber.MethodPost}, ","),
+ AllowHeaders: "Content-Type",
+ ExposeHeaders: "Content-Length",
}))
// After
app.Use(cors.New(cors.Config{
- AllowOrigins: []string{"https://example.com", "https://example2.com"},
- AllowMethods: []string{fiber.MethodGet, fiber.MethodPost},
- AllowHeaders: []string{"Content-Type"},
- ExposeHeaders: []string{"Content-Length"},
+ AllowOrigins: []string{"https://example.com", "https://example2.com"},
+ AllowMethods: []string{fiber.MethodGet, fiber.MethodPost},
+ AllowHeaders: []string{"Content-Type"},
+ ExposeHeaders: []string{"Content-Length"},
}))
```
@@ -1248,12 +1264,12 @@ app.Use(cors.New(cors.Config{
```go
// Before
app.Use(csrf.New(csrf.Config{
- Expiration: 10 * time.Minute,
+ Expiration: 10 * time.Minute,
}))
// After
app.Use(csrf.New(csrf.Config{
- IdleTimeout: 10 * time.Minute,
+ IdleTimeout: 10 * time.Minute,
}))
```
@@ -1266,28 +1282,28 @@ You need to move filesystem middleware to static middleware due to it has been r
```go
// Before
app.Use(filesystem.New(filesystem.Config{
- Root: http.Dir("./assets"),
+ Root: http.Dir("./assets"),
}))
app.Use(filesystem.New(filesystem.Config{
- Root: http.Dir("./assets"),
- Browse: true,
- Index: "index.html",
- MaxAge: 3600,
+ Root: http.Dir("./assets"),
+ Browse: true,
+ Index: "index.html",
+ MaxAge: 3600,
}))
```
```go
// After
app.Use(static.New("", static.Config{
- FS: os.DirFS("./assets"),
+ FS: os.DirFS("./assets"),
}))
app.Use(static.New("", static.Config{
- FS: os.DirFS("./assets"),
- Browse: true,
- IndexNames: []string{"index.html"},
- MaxAge: 3600,
+ FS: os.DirFS("./assets"),
+ Browse: true,
+ IndexNames: []string{"index.html"},
+ MaxAge: 3600,
}))
```
@@ -1298,14 +1314,14 @@ Previously, the Healthcheck middleware was configured with a combined setup for
```go
//before
app.Use(healthcheck.New(healthcheck.Config{
- LivenessProbe: func(c fiber.Ctx) bool {
- return true
- },
- LivenessEndpoint: "/live",
- ReadinessProbe: func(c fiber.Ctx) bool {
- return serviceA.Ready() && serviceB.Ready() && ...
- },
- ReadinessEndpoint: "/ready",
+ LivenessProbe: func(c fiber.Ctx) bool {
+ return true
+ },
+ LivenessEndpoint: "/live",
+ ReadinessProbe: func(c fiber.Ctx) bool {
+ return serviceA.Ready() && serviceB.Ready() && ...
+ },
+ ReadinessEndpoint: "/ready",
}))
```
@@ -1316,9 +1332,9 @@ With the new version, each health check endpoint is configured separately, allow
// Default liveness endpoint configuration
app.Get(healthcheck.DefaultLivenessEndpoint, healthcheck.NewHealthChecker(healthcheck.Config{
- Probe: func(c fiber.Ctx) bool {
- return true
- },
+ Probe: func(c fiber.Ctx) bool {
+ return true
+ },
}))
// Default readiness endpoint configuration
@@ -1327,9 +1343,9 @@ app.Get(healthcheck.DefaultReadinessEndpoint, healthcheck.NewHealthChecker())
// New default startup endpoint configuration
// Default endpoint is /startupz
app.Get(healthcheck.DefaultStartupEndpoint, healthcheck.NewHealthChecker(healthcheck.Config{
- Probe: func(c fiber.Ctx) bool {
- return serviceA.Ready() && serviceB.Ready() && ...
- },
+ Probe: func(c fiber.Ctx) bool {
+ return serviceA.Ready() && serviceB.Ready() && ...
+ },
}))
// Custom liveness endpoint configuration
diff --git a/go.mod b/go.mod
index a17d0b1aee..a979f1837e 100644
--- a/go.mod
+++ b/go.mod
@@ -12,6 +12,7 @@ require (
github.com/tinylib/msgp v1.2.5
github.com/valyala/bytebufferpool v1.0.0
github.com/valyala/fasthttp v1.57.0
+ golang.org/x/crypto v0.28.0
)
require (
diff --git a/go.sum b/go.sum
index 293e2d6c08..3601863b69 100644
--- a/go.sum
+++ b/go.sum
@@ -35,6 +35,8 @@ github.com/x448/float16 v0.8.4 h1:qLwI1I70+NjRFUR3zs1JPUCgaCXSh3SW62uAKT1mSBM=
github.com/x448/float16 v0.8.4/go.mod h1:14CWIYCyZA/cWjXOioeEpHeN/83MdbZDRQHoFcYsOfg=
github.com/xyproto/randomstring v1.0.5 h1:YtlWPoRdgMu3NZtP45drfy1GKoojuR7hmRcnhZqKjWU=
github.com/xyproto/randomstring v1.0.5/go.mod h1:rgmS5DeNXLivK7YprL0pY+lTuhNQW3iGxZ18UQApw/E=
+golang.org/x/crypto v0.28.0 h1:GBDwsMXVQi34v5CCYUm2jkJvu4cbtru2U4TN2PSyQnw=
+golang.org/x/crypto v0.28.0/go.mod h1:rmgy+3RHxRZMyY0jjAJShp2zgEdOqj2AO7U0pYmeQ7U=
golang.org/x/net v0.30.0 h1:AcW1SDZMkb8IpzCdQUaIq2sP4sZ4zw+55h6ynffypl4=
golang.org/x/net v0.30.0/go.mod h1:2wGyMJ5iFasEhkwi13ChkO/t1ECNC4X4eBKkVFyYFlU=
golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
diff --git a/listen.go b/listen.go
index 624b2539f3..e0c5536968 100644
--- a/listen.go
+++ b/listen.go
@@ -23,6 +23,7 @@ import (
"github.com/gofiber/fiber/v3/log"
"github.com/mattn/go-colorable"
"github.com/mattn/go-isatty"
+ "golang.org/x/crypto/acme/autocert"
)
// Figlet text to show Fiber ASCII art on startup message
@@ -69,6 +70,13 @@ type ListenConfig struct {
//
// Default: nil
OnShutdownSuccess func()
+
+ // AutoCertManager manages TLS certificates automatically using the ACME protocol,
+ // Enables integration with Let's Encrypt or other ACME-compatible providers.
+ //
+ // Default: nil
+ AutoCertManager *autocert.Manager `json:"auto_cert_manager"`
+
// Known networks are "tcp", "tcp4" (IPv4-only), "tcp6" (IPv6-only)
// WARNING: When prefork is set to true, only "tcp4" and "tcp6" can be chosen.
//
@@ -183,9 +191,15 @@ func (app *App) Listen(addr string, config ...ListenConfig) error {
// Attach the tlsHandler to the config
app.SetTLSHandler(tlsHandler)
+ } else if cfg.AutoCertManager != nil {
+ tlsConfig = &tls.Config{
+ MinVersion: tls.VersionTLS12,
+ GetCertificate: cfg.AutoCertManager.GetCertificate,
+ NextProtos: []string{"http/1.1", "acme-tls/1"},
+ }
}
- if cfg.TLSConfigFunc != nil {
+ if tlsConfig != nil && cfg.TLSConfigFunc != nil {
cfg.TLSConfigFunc(tlsConfig)
}