ddev-varnish

This repository allows you to quickly install the Varnish reverse proxy into a DDEV project using the instructions below.

Installation

For DDEV v1.23.5 or above run

ddev add-on get ddev/ddev-varnish

For earlier versions of DDEV run

ddev get ddev/ddev-varnish

Then restart your project

ddev restart

Explanation

The Varnish service inserts itself between ddev-router and the web container, so that calls to the web container are routed through Varnish first. The docker-compose.varnish.yaml installs Varnish and uses the default domain as its own host name. A docker-compose.varnish_extras.yaml file is generated on install which replaces the VIRTUAL_HOST variable of the web container with a sub-domain of the website URL. For example, mysite.ddev.site, would be accessible via Varnish on mysite.ddev.site and directly on novarnish.mysite.ddev.site.

If you use a project_tld other than ddev.site or additional_fqdns DDEV will help add hosts entries for the hostnames automagically; however, you'll need to add entries for the novarnish.* sub-domains yourself, e.g. ddev hostname novarnish.testaddfqdn.random.tld 127.0.0.1.

Run ddev add-on get ddev/ddev-varnish after changes to name, additional_hostnames, additional_fqdns, or project_tld in .ddev/config.yaml so that .ddev/docker-compose.varnish_extras.yaml is regenerated.

Helper commands

This addon also providers several helper commands. These helpers allow developers to run Varnish commands from the host, however, the commands are actually run inside the Varnish container.

Command	Description
ddev varnishd	Varnish-cli
ddev varnishadm	Control a running Varnish instance
ddev varnishhist	Display Varnish request histogram
ddev varnishlog	Display Varnish logs
ddev varnishncsa	Display Varnish logs in Apache / NCSA combined log format
ddev varnishstat	Display Varnish Cache statistics
ddev varnishtest	Test program for Varnish
ddev varnishtop	Display Varnish log entry ranking

See The Varnish Reference Manual for more information about the commands, their flags, and their arguments.

Additional Configuration

• You may want to edit the .ddev/varnish/default.vcl to meet your needs. Remember to remove #ddev-generated from the file if you want your changes to the file preserved.

Maintained by @jedubois and @rfay

Based on the original ddev-contrib recipe pioneered by rikwillems