Fiber

New
This method creates a new App named instance. You can pass optional settings when creating a new instance.
Signature
1
func New(config ...Config) *App
Copied!
Example
1
// Default config
2
app := fiber.New()
3
​
4
// ...
Copied!
Config
You can pass an optional Config when creating a new Fiber instance.
Example
1
// Custom config
2
app := fiber.New(fiber.Config{
3
    Prefork:       true,
4
    CaseSensitive: true,
5
    StrictRouting: true,
6
    ServerHeader:  "Fiber",
7
    AppName: "Test App v1.0.1"
8
})
9
​
10
// ...
Copied!
Config fields
Property
Type
Description
Default
Prefork
bool
Enables use of theSO_REUSEPORTsocket option. This will spawn multiple Go processes listening on the same port. learn more about socket sharding. NOTE: if enabled, the application will need to be ran through a shell because prefork mode sets environment variables. If you're using Docker, make sure the app is ran with CMD ./app or CMD ["sh", "-c", "/app"]. For more info, see this issue comment.
false
ServerHeader
string
Enables the Server HTTP header with the given value.
""
StrictRouting
bool
When enabled, the router treats /foo and /foo/ as different. Otherwise, the router treats /foo and /foo/ as the same.
false
CaseSensitive
bool
When enabled, /Foo and /foo are different routes. When disabled, /Fooand /foo are treated the same.
false
Immutable
bool
When enabled, all values returned by context methods are immutable. By default, they are valid until you return from the handler; see issue #185.
false
UnescapePath
bool
Converts all encoded characters in the route back before setting the path for the context, so that the routing can also work with URL encoded special characters
false
ETag
bool
Enable or disable ETag header generation, since both weak and strong etags are generated using the same hashing method (CRC-32). Weak ETags are the default when enabled.
false
BodyLimit
int
Sets the maximum allowed size for a request body, if the size exceeds the configured limit, it sends 413 - Request Entity Too Large response.
4 * 1024 * 1024
Concurrency
int
Maximum number of concurrent connections.
256 * 1024
Views
Views
Views is the interface that wraps the Render function. See our Template Middleware for supported engines.
nil
ViewsLayout
string
Views Layout is the global layout for all template render until override on Render function. See our Template Middleware for supported engines.
""
PassLocalsToViews
bool
PassLocalsToViews Enables passing of the locals set on a fiber.Ctx to the template engine. See our Template Middleware for supported engines.
false
ReadTimeout
time.Duration
The amount of time allowed to read the full request, including the body. The default timeout is unlimited.
nil
WriteTimeout
time.Duration
The maximum duration before timing out writes of the response. The default timeout is unlimited.
nil
IdleTimeout
time.Duration
The maximum amount of time to wait for the next request when keep-alive is enabled. If IdleTimeout is zero, the value of ReadTimeout is used.
nil
ReadBufferSize
int
per-connection buffer size for requests' reading. This also limits the maximum header size. Increase this buffer if your clients send multi-KB RequestURIs and/or multi-KB headers (for example, BIG cookies).
4096
WriteBufferSize
int
Per-connection buffer size for responses' writing.
4096
CompressedFileSuffix
string
Adds a suffix to the original file name and tries saving the resulting compressed file under the new file name.
".fiber.gz"
ProxyHeader
string
This will enable c.IP() to return the value of the given header key. By default c.IP()will return the Remote IP from the TCP connection, this property can be useful if you are behind a load balancer e.g. X-Forwarded-*.
""
GETOnly
bool
Rejects all non-GET requests if set to true. This option is useful as anti-DoS protection for servers accepting only GET requests. The request size is limited by ReadBufferSize if GETOnly is set.
false
NewError
NewError creates a new HTTPError instance with an optional message.
Signature
1
func NewError(code int, message ...string) *Error
Copied!
Example
1
app.Get("/", func(c *fiber.Ctx) error {
2
    return fiber.NewError(782, "Custom error message")
3
})
Copied!
IsChild
IsChild determines if the current process is a result of Prefork.
Signature
1
func IsChild() bool
Copied!
Example
1
// Prefork will spawn child processes
2
app := fiber.New(fiber.Config{
3
    Prefork: true,
4
})
5
​
6
if !fiber.IsChild() {
7
    fmt.Println("I'm the parent process")
8
} else {
9
    fmt.Println("I'm a child process")
10
}
11
​
12
// ...
Copied!
Welcome
Next - API
App
Last modified 1mo ago
Copy link
Contents