httpcache

README

Caddy Cache-Handler

• Config
• Handlers
• Stores

Build

export GOOS=linux
export GOARCH=amd64
xcaddy build --with github.com/golevi/cache-handler
tar -czf caddy.tar.gz caddy

Contributing

Good reads:

• Caching Tutorial by Mark Nottingham
• HTTP caching by Mozilla Developer Network
• Prevent unnecessary network requests with the HTTP Cache by web.dev

Documentation

Index

• type Cache
  • func (Cache) CaddyModule() caddy.ModuleInfo
  • func (c *Cache) Provision(ctx caddy.Context) error
  • func (c *Cache) ServeHTTP(w http.ResponseWriter, r *http.Request, next caddyhttp.Handler) error
  • func (c *Cache) UnmarshalCaddyfile(d *caddyfile.Dispenser) error

Types

type Cache

type Cache struct {
	Config config.Config
	Store  stores.CacheStore

	// Validators check to see whether the request should be cached.
	Validators []func(c config.Config, w http.ResponseWriter, r *http.Request) bool
	// contains filtered or unexported fields
}

Cache is the primary struct for Caddy to use. It contains the config, cache store, validators, and the logger.

func (Cache) CaddyModule

func (Cache) CaddyModule() caddy.ModuleInfo

CaddyModule returns the Caddy module information.

func (*Cache) Provision

func (c *Cache) Provision(ctx caddy.Context) error

Provision _

func (*Cache) ServeHTTP

func (c *Cache) ServeHTTP(w http.ResponseWriter, r *http.Request, next caddyhttp.Handler) error

func (*Cache) UnmarshalCaddyfile

func (c *Cache) UnmarshalCaddyfile(d *caddyfile.Dispenser) error

UnmarshalCaddyfile parses plugin settings from Caddyfile.

{
	order cache first
	cache {
		type <redis>|<file>
		host localhost:6379
	}
}

cache {
	expire 120                              # Cache expiration in seconds
	bypass {
		paths wp-admin wp-login.php system  # WordPress and ExpressionEngine
		methods post                        # Don't typically cache POST
		cookies wordpress_logged_in_.*      # WordPress
		# cookie exp_sessionid              # ExpressionEngine
	}
}

This may change.