FileSystem

Filesystem middleware for Fiber that enables you to serve files from a directory.

Signatures

  1. func New(config Config) fiber.Handler

Examples

Import the middleware package that is part of the Fiber web framework

  1. import (
  2.     "github.com/gofiber/fiber/v2"
  3.     "github.com/gofiber/fiber/v2/middleware/filesystem"
  4. )

After you initiate your Fiber app, you can use the following possibilities:

  1. // Provide a minimal config
  2. app.Use(filesystem.New(filesystem.Config{
  3.     Root: http.Dir("./assets")
  4. }))
  6. // Or extend your config for customization
  7. app.Use(filesystem.New(filesystem.Config{
  8.     Root:         http.Dir("./assets"),
  9.     Index:        "index.html",
  10.     Browse:       true,
  11.     NotFoundFile: "404.html"
  12. }))

Config

  1. // Config defines the config for middleware.
  2. type Config struct {
  3.     // Next defines a function to skip this middleware when returned true.
  4.     //
  5.     // Optional. Default: nil
  6.     Next func(c *fiber.Ctx) bool
  8.     // Root is a FileSystem that provides access
  9.     // to a collection of files and directories.
  10.     //
  11.     // Required. Default: nil
  12.     Root http.FileSystem
  14.     // Index file for serving a directory.
  15.     //
  16.     // Optional. Default: "index.html"
  17.     Index string
  19.     // Enable directory browsing.
  20.     //
  21.     // Optional. Default: false
  22.     Browse bool
  24.     // File to return if path is not found. Useful for SPA's.
  25.     //
  26.     // Optional. Default: ""
  27.     NotFoundFile string
  28. }

Default Config

  1. var ConfigDefault = Config{
  2.     Next:   nil,
  3.     Root:   nil,
  4.     Index:  "/index.html",
  5.     Browse: false,
  6. }

packr

https://github.com/gobuffalo/packr

  1. package main
  3. import (
  4.     "github.com/gofiber/fiber/v2"
  5.     "github.com/gofiber/fiber/v2/middleware/filesystem"
  7.     "github.com/gobuffalo/packr/v2"
  8. )
  10. func main() {
  11.     app := fiber.New()
  13.     app.Use("/assets", filesystem.New(filesystem.Config{
  14.         Root: packr.New("Assets Box", "/assets"),
  15.     })
  17.     app.Listen(":3000")
  18. }

go.rice

https://github.com/GeertJohan/go.rice

  1. package main
  3. import (
  4.     "github.com/gofiber/fiber/v2"
  5.     "github.com/gofiber/fiber/v2/middleware/filesystem"
  7.     "github.com/GeertJohan/go.rice"
  8. )
  10. func main() {
  11.     app := fiber.New()
  13.     app.Use("/assets", filesystem.New(filesystem.Config{
  14.         Root: rice.MustFindBox("assets").HTTPBox(),
  15.     })
  17.     app.Listen(":3000")
  18. }

fileb0x

https://github.com/UnnoTed/fileb0x

  1. package main
  3. import (
  4.     "github.com/gofiber/fiber/v2"
  5.     "github.com/gofiber/fiber/v2/middleware/filesystem"
  7.     "<Your go module>/myEmbeddedFiles"
  8. )
  10. func main() {
  11.     app := fiber.New()
  13.     app.Use("/assets", filesystem.New(filesystem.Config{
  14.         Root: myEmbeddedFiles.HTTP,
  15.     })
  17.     app.Listen(":3000")
  18. }

statik

https://github.com/rakyll/statik

  1. package main
  3. import (
  4.     "github.com/gofiber/fiber/v2"
  5.     "github.com/gofiber/fiber/v2/middleware/filesystem"
  7.     "<Your go module>/statik"
  8.     fs "github.com/rakyll/statik/fs"
  9. )
  11. func main() {
  12.     statik, err := fs.New()
  13.     if err != nil {
  14.         panic(err)
  15.     }
  17.     app := fiber.New()
  19.     app.Use("/", filesystem.New(filesystem.Config{
  20.         Root: statikFS,
  21.     })
  23.     app.Listen(":3000")
  24. }