proxy

README

Proxy

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

Table of Contents

• Signatures
• Examples
• Config
• Default Config

Signatures

func New(config Config) fiber.Handler

Examples

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

import (
  "github.com/gofiber/fiber/v2"
  "github.com/gofiber/fiber/v2/middleware/proxy"
)

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

// Minimal config
app.Use(proxy.New(proxy.Config{
	Hosts: "gofiber.io:8080, gofiber.io:8081",
}))

// Or extend your config for customization
app.Use(proxy.New(proxy.Config{
	Hosts: "gofiber.io:8080, gofiber.io:8081",
	Before: func(c *fiber.Ctx) error {
		c.Set("X-Real-IP", c.IP())
		return nil
	},
}))

Config

// Config defines the config for middleware.
type Config struct {
	// Next defines a function to skip this middleware when returned true.
	//
	// Optional. Default: nil
	Next func(c *fiber.Ctx) bool

	// Comma-separated list of upstream HTTP server host addresses,
	// which are passed to Dial in a round-robin manner.
	//
	// Each address may contain port if default dialer is used.
	// For example,
	//
	//    - foobar.com:80
	//    - foobar.com:443
	//    - foobar.com:8080
	Hosts string

	// Before allows you to alter the request
	Before fiber.Handler

	// After allows you to alter the response
	After fiber.Handler
}

Default Config

var ConfigDefault = Config{
	Next:   nil,
	Hosts:  "",
	Before: nil,
	After:  nil,
}

Documentation

Index

• Variables
• func New(config Config) fiber.Handler
• type Config

Variables

var ConfigDefault = Config{
	Next: nil,
}

ConfigDefault is the default config

Functions

func New

func New(config Config) fiber.Handler

New creates a new middleware handler

Types

type Config

type Config struct {
	// Next defines a function to skip this middleware when returned true.
	//
	// Optional. Default: nil
	Next func(c *fiber.Ctx) bool

	// Comma-separated list of upstream HTTP server host addresses,
	// which are passed to Dial in a round-robin manner.
	//
	// Each address may contain port if default dialer is used.
	// For example,
	//
	//    - foobar.com:80
	//    - foobar.com:443
	//    - foobar.com:8080
	Hosts string

	// Before allows you to alter the request
	Before fiber.Handler

	// After allows you to alter the response
	After fiber.Handler
}

Config defines the config for middleware.