📦 Fiber

Fiber represents the fiber package where you start to create an instance.

New
This method creates a new App named instance. You can pass optional settings when creating a new instance.
Signature
func New(config ...Config) *App
Example
// Default config
app := fiber.New()
​
// ...
Config
You can pass an optional Config when creating a new Fiber instance.
Example
// Custom config
app := fiber.New(fiber.Config{
    Prefork:       true,
    CaseSensitive: true,
    StrictRouting: true,
    ServerHeader:  "Fiber",
    AppName: "Test App v1.0.1"
})
​
// ...
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
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
ErrorHandler
ErrorHandler
ErrorHandler is executed when an error is returned from fiber.Handler.
DefaultErrorHandler
DisableKeepalive
bool
Disable keep-alive connections, the server will close incoming connections after sending the first response to the client
false
DisableDefaultDate
bool
When set to true causes the default date header to be excluded from the response.
false
DisableDefaultContentType
bool
When set to true, causes the default Content-Type header to be excluded from the Response.
false
DisableHeaderNormalizing
bool
By default all header names are normalized: conteNT-tYPE -> Content-Type
false
DisableStartupMessage
bool
When set to true, it will not print out debug information
false
AppName
string
This allows to setup app name for the app
""
EnableTrustedProxyCheck
bool
When set to true, fiber will check whether proxy is trusted, using TrustedProxies list. 

By default  c.Protocol() will get value from X-Forwarded-Proto, X-Forwarded-Protocol, X-Forwarded-Ssl or X-Url-Scheme header, c.IP() will get value from ProxyHeader header, c.Hostname() will get value from X-Forwarded-Host header. 
 If EnableTrustedProxyCheck is true, and RemoteIP is in the list of TrustedProxies c.Protocol(), c.IP(), and c.Hostname() will have the same behaviour when EnableTrustedProxyCheck disabled, if RemoteIP isn't in the list, c.Protocol() will return https in case when tls connection is handled by the app, or http otherwise, c.IP() will return RemoteIP() from fasthttp context, c.Hostname() will return fasthttp.Request.URI().Host()
false
TrustedProxies
[]string
Contains the list op trusted proxy IP's. Look at EnableTrustedProxyCheck doc.
[]string*__*
DisablePreParseMultipartForm
bool
Will not pre parse Multipart Form data if set to true. This option is useful for servers that desire to treat multipart form data as a binary blob, or choose when to parse the data.
false
StreamRequestBody
bool
StreamRequestBody enables request body streaming, and calls the handler sooner when given body is larger then the current limit.
false
NewError
NewError creates a new HTTPError instance with an optional message.
Signature
func NewError(code int, message ...string) *Error
Example
app.Get("/", func(c *fiber.Ctx) error {
    return fiber.NewError(782, "Custom error message")
})
IsChild
IsChild determines if the current process is a result of Prefork.
Signature
func IsChild() bool
Example
// Prefork will spawn child processes
app := fiber.New(fiber.Config{
    Prefork: true,
})
​
if !fiber.IsChild() {
    fmt.Println("I'm the parent process")
} else {
    fmt.Println("I'm a child process")
}
​
// ...

👋 Welcome

Next - API

🚀 App

Last updated 2 months ago

Property	Type	Description	Default
Prefork	`bool`	Enables use of the`SO_REUSEPORT`socket 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, `/Foo`and `/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`
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`
ErrorHandler	`ErrorHandler`	ErrorHandler is executed when an error is returned from fiber.Handler.	`DefaultErrorHandler`
DisableKeepalive	`bool`	Disable keep-alive connections, the server will close incoming connections after sending the first response to the client	`false`
DisableDefaultDate	`bool`	When set to true causes the default date header to be excluded from the response.	`false`
DisableDefaultContentType	`bool`	When set to true, causes the default Content-Type header to be excluded from the Response.	`false`
DisableHeaderNormalizing	`bool`	By default all header names are normalized: conteNT-tYPE -> Content-Type	`false`
DisableStartupMessage	`bool`	When set to true, it will not print out debug information	`false`
AppName	`string`	This allows to setup app name for the app	`""`
EnableTrustedProxyCheck	`bool`	When set to true, fiber will check whether proxy is trusted, using TrustedProxies list. By default `c.Protocol()` will get value from X-Forwarded-Proto, X-Forwarded-Protocol, X-Forwarded-Ssl or X-Url-Scheme header, `c.IP()` will get value from `ProxyHeader` header, `c.Hostname()` will get value from X-Forwarded-Host header. If `EnableTrustedProxyCheck` is true, and `RemoteIP` is in the list of `TrustedProxies` `c.Protocol()`, `c.IP()`, and `c.Hostname()` will have the same behaviour when `EnableTrustedProxyCheck` disabled, if `RemoteIP` isn't in the list, `c.Protocol()` will return https in case when tls connection is handled by the app, or http otherwise, `c.IP()` will return RemoteIP() from fasthttp context, `c.Hostname()` will return `fasthttp.Request.URI().Host()`	`false`
TrustedProxies	`[]string`	Contains the list op trusted proxy IP's. Look at `EnableTrustedProxyCheck` doc.	`[]string__`
DisablePreParseMultipartForm	`bool`	Will not pre parse Multipart Form data if set to true. This option is useful for servers that desire to treat multipart form data as a binary blob, or choose when to parse the data.	`false`
StreamRequestBody	`bool`	StreamRequestBody enables request body streaming, and calls the handler sooner when given body is larger then the current limit.	`false`