vmod_redirect

Varnish Redirect Module

Author

Syohei Tanaka(@xcir)

Date

2012-08-02

Version

0.5

Manual section

3

SYNOPSIS

import redirect;

DESCRIPTION

Varnish redirect operation to easy.

before(via: https://www.varnish-cache.org/trac/wiki/VCLExampleRedirectInVCL)

sub vcl_recv {
  if (req.http.user-agent ~ "iP(hone|od)") {
    error 750 "Moved Temporarily";
  }
}

sub vcl_error {
  if (obj.status == 750) {
    set obj.http.Location = "http://www.example.com/iphoneversion/";
    set obj.status = 302;
    return(deliver);
  }
}

after

import redirect;
sub vcl_recv {
   if (req.http.user-agent ~ "iP(hone|od)") {
      error(redirect.location(302,"http://www.example.com/iphoneversion/") , "Moved Temporarily");
   }
}

ATTENTION

don’t use varnishadm’s command "vcl.use" and "vcl.discard" . because to the segfault or call to other vcl function.

FUNCTIONS

location

Prototype

location(INT status , STRING location)

Return value

INT status

Description

Performing redirects be used in conjunction with error function.

Example

//no reason
error(redirect.location(302,"http://xcir.net/"));

//use reason
error(redirect.location(302,"http://xcir.net/") , "Moved Temporarily");

INSTALLATION

Installation requires Varnish source tree.

Usage:

./autogen.sh
./configure VARNISHSRC=DIR [VMODDIR=DIR]

VARNISHSRC is the directory of the Varnish source tree for which to compile your vmod. Both the VARNISHSRC and VARNISHSRC/include will be added to the include search paths for your module.

Optionally you can also set the vmod install directory by adding VMODDIR=DIR (defaults to the pkg-config discovered directory from your Varnish installation).

Make targets:

• make - builds the vmod
• make install - installs your vmod in VMODDIR
• make check - runs the unit tests in src/tests/*.vtc

In your VCL you could then use this vmod along the following lines:

import redirect;

sub vcl_recv {
        //redirect to my hp
        error(redirect.location(302,"http://xcir.net/"));
}

Tested Version

• 3.0.1
• 3.0.2
• 3.0.2-streaming
• 3.0.3-rc1

HISTORY

Version 0.5: Bug fix: when you vcl reloaded, hook method be off.

Version 0.4: Bug fix:Can not be redirected in a second function call to extremely rare.

Version 0.3: Change name vmod_rewrite -> vmod_redirect

Version 0.2: Bug fix.

Version 0.1: Initial version.

COPYRIGHT

This document is licensed under the same license as the libvmod-redirect project. See LICENSE for details.

• Copyright (c) 2012 Syohei Tanaka(@xcir)

File layout and configuration based on libvmod-example

• Copyright (c) 2011 Varnish Software AS