caddy_decompress

README

caddy-deflate

A caddy plugin that adds support for HTTP's Accept-Encoding: deflate for caddy.

Note: This follows the official definition for http deflate, that being a deflate stream wrapped with zlib, not a raw deflate stream! (many implementations have made this mistake)

Building with xcaddy

xcaddy build \
  --with github.com/rushiiMachine/caddy-deflate

Samples

The encode directive will have a new format named deflate.
Valid compression levels are listed here otherwise any value in the range [0-9].

:80 {
    encode deflate
    file_server
}

or

:80 {
    # Use multiple compressors
    encode deflate gzip zstd

    file_server
}

or

:80 {
    encode {
        # Configure the compression level
        deflate 4
        
        # Configure another backup compressor
        gzip
    }

    file_server
}

Documentation

Index

• type Deflate
  • func (h Deflate) AcceptEncoding() string
  • func (Deflate) CaddyModule() caddy.ModuleInfo
  • func (h Deflate) NewEncoder() encode.Encoder
  • func (h *Deflate) UnmarshalCaddyfile(d *caddyfile.Dispenser) error
  • func (h Deflate) Validate() error

Types

type Deflate

type Deflate struct {
	Level int `json:"level,omitempty"`
}

func (Deflate) AcceptEncoding

func (h Deflate) AcceptEncoding() string

AcceptEncoding implements encode.Encoding

func (Deflate) CaddyModule

func (Deflate) CaddyModule() caddy.ModuleInfo

CaddyModule implements caddy.Module

func (Deflate) NewEncoder

func (h Deflate) NewEncoder() encode.Encoder

NewEncoder implements encode.Encoding

func (*Deflate) UnmarshalCaddyfile

func (h *Deflate) UnmarshalCaddyfile(d *caddyfile.Dispenser) error

UnmarshalCaddyfile implements caddyfile.Unmarshaler

func (Deflate) Validate

func (h Deflate) Validate() error

Validate implements caddy.Validator