diff --git a/README.md b/README.md index 453ff84..ab94803 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,22 @@ If you use a project_tld other than ddev.site or additional_fqdns DDEV will help Run `ddev get drud/ddev-varnish` after changes to name, additional_hostnames, additional_fqdns, or project_tld in .ddev/config.yml 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 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](https://varnish-cache.org/docs/6.5/reference/index.html) 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. diff --git a/commands/varnish/varnishd b/commands/varnish/varnishd new file mode 100755 index 0000000..a934247 --- /dev/null +++ b/commands/varnish/varnishd @@ -0,0 +1,14 @@ +#!/bin/bash + +## #ddev-generated +## Description: Varnish-cli +## Usage: varnishd [flags] [args] +## Example: "ddev varnishd -d" for CLI in foreground. +## Example: "ddev varnishd -T" to connect with varnishadm or telnet. +## Example: "ddev varnishd -M" to connect back to a listening service pushing the CLI to that service. + +# This example runs inside the varnish container. +# Note that this requires that /mnt/ddev_config be mounted +# into the varnish container. + +varnishd "$@" diff --git a/commands/varnish/varnishhist b/commands/varnish/varnishhist new file mode 100755 index 0000000..77216c7 --- /dev/null +++ b/commands/varnish/varnishhist @@ -0,0 +1,12 @@ +#!/bin/bash + +## #ddev-generated +## Description: Display Varnish request histogram +## Usage: varnishhist [flags] [args] +## Example: "ddev varnishhist" + +# This example runs inside the varnish container. +# Note that this requires that /mnt/ddev_config be mounted +# into the varnish container. + +varnishhist "$@" diff --git a/commands/varnish/varnishlog b/commands/varnish/varnishlog new file mode 100755 index 0000000..c107f50 --- /dev/null +++ b/commands/varnish/varnishlog @@ -0,0 +1,12 @@ +#!/bin/bash + +## #ddev-generated +## Description: Display Varnish logs +## Usage: varnishlog [flags] [args] +## Example: "ddev varnishlog" + +# This example runs inside the varnish container. +# Note that this requires that /mnt/ddev_config be mounted +# into the varnish container. + +varnishlog "$@" diff --git a/commands/varnish/varnishncsa b/commands/varnish/varnishncsa new file mode 100755 index 0000000..499da9d --- /dev/null +++ b/commands/varnish/varnishncsa @@ -0,0 +1,12 @@ +#!/bin/bash + +## #ddev-generated +## Description: Display Varnish logs in Apache / NCSA combined log format +## Usage: varnishncsa [flags] [args] +## Example: "ddev varnishncsa" + +# This example runs inside the varnish container. +# Note that this requires that /mnt/ddev_config be mounted +# into the varnish container. + +varnishncsa "$@" diff --git a/commands/varnish/varnishstat b/commands/varnish/varnishstat new file mode 100755 index 0000000..f28733e --- /dev/null +++ b/commands/varnish/varnishstat @@ -0,0 +1,12 @@ +#!/bin/bash + +## #ddev-generated +## Description: Display Varnish Cache statistics +## Usage: varnishstat [flags] [args] +## Example: "ddev varnishstat" + +# This example runs inside the varnish container. +# Note that this requires that /mnt/ddev_config be mounted +# into the varnish container. + +varnishstat "$@" diff --git a/commands/varnish/varnishtest b/commands/varnish/varnishtest new file mode 100755 index 0000000..2600b0d --- /dev/null +++ b/commands/varnish/varnishtest @@ -0,0 +1,12 @@ +#!/bin/bash + +## #ddev-generated +## Description: Test program for Varnish +## Usage: varnishtest [flags] [args] +## Example: "ddev varnishtest" + +# This example runs inside the varnish container. +# Note that this requires that /mnt/ddev_config be mounted +# into the varnish container. + +varnishtest "$@" diff --git a/commands/varnish/varnishtop b/commands/varnish/varnishtop new file mode 100755 index 0000000..e83d5e7 --- /dev/null +++ b/commands/varnish/varnishtop @@ -0,0 +1,12 @@ +#!/bin/bash + +## #ddev-generated +## Description: Display Varnish log entry ranking +## Usage: varnishtop [flags] [args] +## Example: "ddev varnishtop" + +# This example runs inside the varnish container. +# Note that this requires that /mnt/ddev_config be mounted +# into the varnish container. + +varnishtop "$@" diff --git a/install.yaml b/install.yaml index e4370f8..fc6d125 100644 --- a/install.yaml +++ b/install.yaml @@ -4,6 +4,7 @@ name: varnish project_files: - docker-compose.varnish.yaml - varnish +- commands/varnish post_install_actions: - |