https://github.com/sjtug/caddy2-filter

Replace response body in caddy2
https://github.com/sjtug/caddy2-filter

Last synced: about 2 months ago
JSON representation

Replace response body in caddy2

• Host: GitHub
• URL: https://github.com/sjtug/caddy2-filter
• Owner: sjtug
• License: apache-2.0
• Created: 2020-05-31T20:22:26.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-03-06T21:41:37.000Z (almost 2 years ago)
• Last Synced: 2024-06-19T01:53:18.417Z (7 months ago)
• Language: Go
• Size: 128 KB
• Stars: 45
• Watchers: 8
• Forks: 9
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# caddy2-filter

[![Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)

[![GoDoc](http://img.shields.io/badge/godoc-reference-blue.svg)](https://godoc.org/gopkg.in/sjtug/caddy2-filter)

[![Go Report Card](https://goreportcard.com/badge/github.com/sjtug/caddy2-filter)](https://goreportcard.com/report/github.com/sjtug/caddy2-filter)

Replace text in HTTP response based on regex. Similar to [http.filter](https://caddyserver.com/v1/docs/http.filter) in Caddy 1.

## Usage

Only the listed fields are supported.

The replacement supports capturing groups of search_pattern (e.g. `{1}`) and caddy placeholders (e.g. `{http.request.hostport}`)

Caddyfile:

```caddyfile

# Add this block in top-level settings:

{

    order filter after encode

}

filter {

    # Only process URL matching this regex

    path 

    # Don't process response body larger than this size

    max_size 

    search_pattern 

    replacement 

    # Only process content_type matching this regex

    content_type 

}

# If you are using reverse_proxy, add this to its config to ensure

# reverse_proxy returns uncompressed body:

header_up -Accept-Encoding

```

JSON config (under `apps › http › servers › routes › handle`)

```json

{

    "handler": "filter",

    "max_size": ,

    "path": "",

    "search_pattern": "",

    "replacement: "",

    "content_type": ""

}

```

## Alternatives

As of Jun 2021,  can achieve similar functionalities. This plugin's design differs from that one in the following aspects:

1. This plugin supports placeholders like {http.host}

2. This plugin allows capping the max size of buffered response

3. This plugin supports only replacing responses with certain content_types

1. replace-response supports `stream` mode, which features in better performance at the cost of possibilities of omitted replacements

2. replace-response is a semi-official plugin maintained by the same author of caddy