plugin_blockpath

README

Block Path

Block Path is a middleware plugin for Traefik which sends an HTTP 403 Forbidden response when the requested HTTP path matches one the configured regular expressions.

Configuration

Static

[pilot]
    token="xxx"

[experimental.plugins.blockpath]
    modulename = "github.com/traefik/plugin-blockpath"
    version = "v0.2.1"

Dynamic

To configure the Block Path plugin you should create a middleware in your dynamic configuration as explained here. The following example creates and uses the blockpath middleware plugin to block all HTTP requests with a path starting with /foo.

[http.routers]
  [http.routers.my-router]
    rule = "Host(`localhost`)"
    middlewares = ["block-foo"]
    service = "my-service"

# Block all paths starting with /foo
[http.middlewares]
  [http.middlewares.block-foo.plugin.blockpath]
    regex = ["^/foo(.*)"]

[http.services]
  [http.services.my-service]
    [http.services.my-service.loadBalancer]
      [[http.services.my-service.loadBalancer.servers]]
        url = "http://127.0.0.1"

Documentation

Overview

Package plugin_blockpath a plugin to block a path.

Index

• func New(_ context.Context, next http.Handler, config *Config, name string) (http.Handler, error)
• type Config
  • func CreateConfig() *Config

Functions

func New

func New(_ context.Context, next http.Handler, config *Config, name string) (http.Handler, error)

New creates and returns a plugin instance.

Types

type Config

type Config struct {
	Regex []string `json:"regex,omitempty"`
}

Config holds the plugin configuration.

func CreateConfig

func CreateConfig() *Config

CreateConfig creates and initializes the plugin configuration.