mirror of
https://github.com/gofiber/fiber.git
synced 2025-08-14 12:40:04 +00:00
6bf3df4cd1
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
66 lines
2.6 KiB
Markdown
66 lines
2.6 KiB
Markdown
---
|
|
id: favicon
|
|
---
|
|
|
|
# Favicon
|
|
|
|
Favicon middleware for [Fiber](https://github.com/gofiber/fiber) that ignores favicon requests or caches a provided icon in memory to improve performance by skipping disk access. User agents request favicon.ico frequently and indiscriminately, so you may wish to exclude these requests from your logs by using this middleware before your logger middleware.
|
|
|
|
It only handles `GET`, `HEAD`, and `OPTIONS` requests to the configured URL. Other methods receive a `405 Method Not Allowed` response.
|
|
|
|
:::note
|
|
This middleware is exclusively for serving the default, implicit favicon, which is GET /favicon.ico or [custom favicon URL](#config).
|
|
:::
|
|
|
|
## Signatures
|
|
|
|
```go
|
|
func New(config ...Config) fiber.Handler
|
|
```
|
|
|
|
## Examples
|
|
|
|
Import the middleware package that is part of the Fiber web framework
|
|
|
|
```go
|
|
import (
|
|
"github.com/gofiber/fiber/v3"
|
|
"github.com/gofiber/fiber/v3/middleware/favicon"
|
|
)
|
|
```
|
|
|
|
After you initiate your Fiber app, you can use the following possibilities:
|
|
|
|
```go
|
|
// Initialize default config
|
|
app.Use(favicon.New())
|
|
|
|
// Or extend your config for customization
|
|
app.Use(favicon.New(favicon.Config{
|
|
File: "./favicon.ico",
|
|
URL: "/favicon.ico",
|
|
}))
|
|
```
|
|
|
|
## Config
|
|
|
|
| Property | Type | Description | Default |
|
|
|:-------------|:------------------------|:---------------------------------------------------------------------------------|:---------------------------|
|
|
| Next | `func(fiber.Ctx) bool` | Next defines a function to skip this middleware when returned true. | `nil` |
|
|
| Data | `[]byte` | Raw data of the favicon file. This can be used instead of `File`. | `nil` |
|
|
| File | `string` | File holds the path to an actual favicon that will be cached. | "" |
|
|
| URL | `string` | URL for favicon handler. | "/favicon.ico" |
|
|
| FileSystem | `fs.FS` | FileSystem is an optional alternate filesystem from which to load the favicon file (e.g. using `os.DirFS` or an `embed.FS`). | `nil` |
|
|
| CacheControl | `string` | CacheControl defines how the Cache-Control header in the response should be set. | "public, max-age=31536000" |
|
|
|
|
## Default Config
|
|
|
|
```go
|
|
var ConfigDefault = Config{
|
|
Next: nil,
|
|
File: "",
|
|
URL: fPath,
|
|
CacheControl: "public, max-age=31536000",
|
|
}
|
|
```
|