Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
Vinyl Cache version 9.0.0 documentation
Logo
Vinyl Cache version 9.0.0 documentation
  • Vinyl Cache Installation
    • Prerequisites
    • Installing Vinyl Cache
      • Installing on Debian/Ubuntu
      • Installing on FreeBSD
      • Installing on OpenBSD
      • Installing on RedHat or CentOS
    • Compiling Vinyl Cache from source
      • Compiling Vinyl Cache from source
    • Other pre-built Vinyl Cache packages
    • Getting help
    • Reporting bugs
    • Platform specific notes
  • The Vinyl Cache Tutorial
    • Vinyl Cache: The beef in the sandwich
    • How Vinyl Cache works
    • Caching with Vinyl Cache
    • Content Composition with Vinyl Cache
    • Content Policy with Vinyl Cache
    • Vinyl Cache is general purpose
    • Starting Vinyl Cache
    • Put Vinyl Cache on port 80
    • Restarting vinyld again
    • Backend servers
    • Peculiarities
    • Now what?
  • The Vinyl Cache Users Guide
    • The Big Vinyl Cache Picture
    • Starting and running Vinyl Cache
      • Security first
      • Required command line arguments
      • CLI - bossing Vinyl Cache around
      • Storage backends
      • Transient Storage
      • Parameters
      • Sizing your cache
    • VCL - Vinyl Configuration Language
      • VCL Syntax
      • Built-in VCL
      • Request and response VCL objects
      • Backend servers
      • The “none” backend
      • Multiple backends
      • Backends and virtual hosts in Vinyl Cache
      • Connecting Through a Proxy
      • Directors
      • Health checks
      • Layering
      • Director Resolution
      • Connection Pooling
      • Hashing
      • Grace mode and keep
      • Separate VCL files
      • Using inline C to extend Vinyl Cache
      • VCL Examples
        • Manipulating request headers in VCL
        • Altering the backend response
        • ACLs
        • Adding WebSockets support
      • Device detection
    • Reporting and statistics
      • Logging in Vinyl Cache
      • Statistics
    • Vinyl Cache and Website Performance
      • Achieving a high hitrate
      • The role of HTTP Headers
      • HTTP Vary
      • Cache misses
      • Uncacheable content
      • Purging and banning
      • Compression
    • Content composition with Edge Side Includes
    • Troubleshooting Vinyl Cache
  • The Vinyl Cache Reference Manual
    • VCL - The Vinyl Configuration Language
    • VCL Variables
    • VCL Steps
    • VCL backend configuration
    • VCL backend health probe
    • Vinyl Cache Processing States
    • VMOD blob - Utilities for the VCL blob type, encoding and decoding
    • VMOD cookie - Vinyl Cache Cookie Module
    • VMOD directors - Vinyl Cache Directors Module
    • VMOD h2 - Module to control the built-in HTTP2 transport
    • VMOD math - VMOD wrapping math.h
    • VMOD proxy - Vinyl Cache Module to extract TLV attributes from PROXYv2
    • VMOD purge - Vinyl Cache Purge Module
    • VMOD std - Vinyl Cache Standard Module
    • VMOD unix - Utilities for Unix domain sockets
    • VinylAdm - Control program for Vinyl Cache
    • CLI - The commands Vinyl Cache understands
    • VSL - The log records Vinyl Cache generates
    • VSLQ - Filter/Query expressions for VSL
    • VinylLog - Logging raw VSL
    • VinylNCSA - Logging in NCSA format
    • VinylHist - Realtime response histogram display
    • VinylTop - Realtime activity display
    • VSC - The statistics Vinyl Cache collects
    • VinylStat - Watching and logging statistics
    • VinylD - The program which does the actual work
    • VTC - Language for writing test cases
    • VinylTest - execute test cases
    • VMOD vtc - Utility module for vinyltest
    • Shell tricks
    • VMODS - Extensions to VCL
    • VEXT - Vinyl Cache Extensions
    • VSM - Shared memory use
    • VDIR - Backends & Directors
    • VCLI - CLI protocol API
    • VTLA - Vinyl Three Letter Acronyms
  • VCL Design Patterns
    • Using extra digits in resp.status
    • Ignoring the Vary header for bots
  • What’s new / Upgrading
    • Changes in Vinyl Cache 9.0
    • Upgrading to Vinyl Cache 9.0
    • Changes in Varnish-Cache 8.0
    • Upgrading to Varnish-Cache 8.0
    • Changes in Varnish-Cache 7.7
    • Upgrading to Varnish-Cache 7.7
    • Changes in Varnish 6.0
    • Upgrading to Varnish 6.0
  • The Vinyl cache Developers Guide
    • Vinyl Cache organization and day-to-day operation
    • Bundling VMODs with the Vinyl Cache distribution
    • How our website works
    • How to contribute content to vinyl-cache.org
    • Who is … ?
  • Poul-Hennings random outbursts
    • On the deck-chairs of HTTP/2
    • How Varnish met CHERI 7/N
    • How Varnish met CHERI 6/N
    • How Varnish met CHERI 5/N
    • How Varnish met CHERI 4/N
    • How Varnish met CHERI 3/N
    • How Varnish met CHERI 2/N
    • How Varnish met CHERI 1/N
    • Getting into the routine
    • The 503’s heard around the world
    • Legacy-.*
    • IP Addresses - A long expected problem
    • Varnish Developer Day 2019Q3
    • QUIC visions of OSI
    • Here we are again - VSV00003 in perspective
    • A patently good idea
    • Do you feel lucky ?
    • API spaces
    • Yah! A security issue - finally!
    • Something (funny) happened on the way to 5.1.0^H1^H2
    • Trial&Error - Prototyping - Continuous Integration
    • Far, far away
    • Going fast slowly
    • The first design of Varnish
    • Varnish - 10 going on 50
    • Brinch-Hansens Arrows
    • SSL revisited
    • A persistent message
    • Raking in the dough on Free and Open Source Software
    • Wanton destruction for the greater good
    • What SPDY did to my summer vacation
    • Why HTTP/2.0 does not seem interesting
    • Varnish Does Not Hash
    • The Tools We Work With
    • Thoughts on the eve of Varnish 3.0
    • Why no SSL ?
    • How GZIP, and GZIP+ESI works in Vinyl Cache
    • VCL Expressions
    • IPv6 Suckage
    • What do you mean by ‘backend’ ?
    • Picking platforms
    • Security barriers in Vinyl Cache
    • What were they thinking ?
    • Did you call them autocrap tools ?
    • Why Sphinx and reStructuredText ?
    • Notes from the Architect
  • Vinyl Cache Glossary
Back to top
Copyright © 2016-2026, The Vinyl Cache Project and contributors. Vinyl Cache Logo & Mascot: CC-BY 4.0 Rhubarbe.design
Made with Sphinx and @pradyunsg's Furo