https://github.com/traefik/plugin-blockpath

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
https://github.com/traefik/plugin-blockpath

traefik traefik-plugin

Last synced: about 1 year ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/traefik/plugin-blockpath
• Owner: traefik
• License: apache-2.0
• Created: 2020-07-07T07:45:44.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2022-03-31T00:38:54.000Z (about 4 years ago)
• Last Synced: 2025-04-19T19:05:19.673Z (about 1 year ago)
• Topics: traefik, traefik-plugin
• Language: Go
• Homepage: https://plugins.traefik.io/plugins/62947354108ecc83915d778e/block-path
• Size: 22.5 KB
• Stars: 20
• Watchers: 13
• Forks: 14
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Block Path

[![Build Status](https://github.com/traefik/plugin-blockpath/workflows/Main/badge.svg?branch=master)](https://github.com/traefik/plugin-blockpath/actions)

Block Path is a middleware plugin for [Traefik](https://github.com/traefik/traefik) which sends an HTTP `403 Forbidden` 

response when the requested HTTP path matches one the configured [regular expressions](https://github.com/google/re2/wiki/Syntax).

## Configuration

## Static

```toml

[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](https://docs.traefik.io/middlewares/overview/) in 

your dynamic configuration as explained [here](https://docs.traefik.io/middlewares/overview/). The following example creates

and uses the `blockpath` middleware plugin to block all HTTP requests with a path starting with `/foo`. 

```toml

[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"

```