Proxy

Proxy middleware for Fiber that allows you to proxy requests to multiple hosts.

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/proxy"
  4. )

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

  1. // Minimal config
  2. app.Use(proxy.New(proxy.Config{
  3.     Hosts: "gofiber.io:8080, gofiber.io:8081",
  4. }))
  6. // Or extend your config for customization
  7. app.Use(proxy.New(proxy.Config{
  8.     Hosts: "gofiber.io:8080, gofiber.io:8081",
  9.     Before: func(c *fiber.Ctx) error {
  10.         c.Set("X-Real-IP", c.IP())
  11.         return nil
  12.     },
  13. }))

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.     // Comma-separated list of upstream HTTP server host addresses,
  9.     // which are passed to Dial in a round-robin manner.
  10.     //
  11.     // Each address may contain port if default dialer is used.
  12.     // For example,
  13.     //
  14.     //    - foobar.com:80
  15.     //    - foobar.com:443
  16.     //    - foobar.com:8080
  17.     Hosts string
  19.     // Before allows you to alter the request
  20.     Before fiber.Handler
  22.     // After allows you to alter the response
  23.     After fiber.Handler
  24. }

Default Config

  1. var ConfigDefault = Config{
  2.     Next:   nil,
  3.     Hosts:  "",
  4.     Before: nil,
  5.     After:  nil,
  6. }