The varnishd daemon accepts HTTP requests from clients, passes them on to a backend server and caches the returned documents to better satisfy future requests for the same document.
-C | Print VCL code compiled to C language and exit. Specify the VCL file to compile with the -f option. |
-d | Enables debugging mode: The parent process runs in the foreground with a CLI connection on stdin/stdout, and the child process must be started explicitly with a CLI command. Terminating the parent process will also terminate the child. |
-f config | Use the specified VCL configuration file instead of the builtin default. See vcl(7) for details on VCL syntax. When no configuration is supplied varnishd will not start the cache process. |
-F | Run in the foreground. |
-g group | Specifies the name of an unprivileged group to which the child process should switch before it starts accepting connections. This is a shortcut for specifying the group run-time parameter. |
-i identity | Specify the identity of the Varnish server. This can be accessed using server.identity from VCL |
-n name | Specify the name for this instance. Amonst other things, this name is used to construct the name of the directory in which varnishd keeps temporary files and persistent state. If the specified name begins with a forward slash, it is interpreted as the absolute path to the directory which should be used for this purpose. |
-P file | Write the process's PID to the specified file. |
See Storage Types in the Users Guide for more information on the various storage backends. This option can be used multiple times to specify multiple storage files. Names are referenced in logs, vcl, statistics, etc.
-S file | Path to a file containing a secret used for authorizing access to the management port. |
-t ttl | Specifies a hard minimum time to live for cached documents. This is a shortcut for specifying the default_ttl run-time parameter. |
-u user | Specifies the name of an unprivileged user to which the child process should switch before it starts accepting connections. This is a shortcut for specifying the user runtime parameter. If specifying both a user and a group, the user should be specified first. |
-V | Display the version number and exit. |
The following hash algorithms are available:
The following storage types are available:
syntax: file[,path[,size[,granularity]]]
The file backend stores data in a file on disk. The file will be accessed using mmap.
syntax: persistent,path,size
Persistent storage. Varnish will store objects in a file in a manner that will secure the survival of most of the objects in the event of a planned or unplanned shutdown of Varnish. The persistent storage backend has multiple issues with it and will likely be removed from a future version of Varnish.
If the -T option was specified, varnishd will offer a command-line management interface on the specified address and port. The recommended way of connecting to the command-line management interface is through varnishadm(1).
The commands available are documented in varnish(7).
Runtime parameters are marked with shorthand flags to avoid repeating the same text over and over in the table below. The meaning of the flags are:
Here is a list of all parameters, current as of last time we remembered to update the manual page. This text is produced from the same text you will find in the CLI if you use the param.show command, so should there be a new parameter which is not listed here, you can find the description using the CLI commands.
Be aware that on 32 bit systems, certain default values, such as workspace_client (=16k), thread_pool_workspace (=16k), http_resp_size (=8k), http_req_size (=12k), gzip_stack_buffer (=4k) and thread_pool_stack (=64k) are reduced relative to the values listed here, in order to conserve VM space.
- Default: 0.9
- Minimum: 0
- Maximum: 1
- Flags: experimental
If we run out of resources, such as file descriptors or worker threads, the acceptor will sleep between accepts. This parameter (multiplicatively) reduce the sleep duration for each succesfull accept. (ie: 0.9 = reduce by 10%)
- Units: s
- Default: 0.001
- Minimum: 0.000
- Maximum: 1.000
- Flags: experimental
If we run out of resources, such as file descriptors or worker threads, the acceptor will sleep between accepts. This parameter control how much longer we sleep, each time we fail to accept a new connection.
- Units: s
- Default: 0.050
- Minimum: 0.000
- Maximum: 10.000
- Flags: experimental
If we run out of resources, such as file descriptors or worker threads, the acceptor will sleep between accepts. This parameter limits how long it can sleep between attempts to accept new connections.
- Units: bool
- Default: on
Elimited older identical bans when new bans are created. This test is CPU intensive and scales with the number and complexity of active (non-Gone) bans. If identical bans are frequent, the amount of CPU needed to actually test the bans will be similarly reduced.
- Units: s
- Default: 60.000
- Minimum: 0.000
The ban lurker does not process bans until they are this old. Right when a ban is added, the most frequently hit objects will get tested against it as part of object lookup. This parameter prevents the ban-lurker from kicking in, until the rush is over.
- Default: 1000
- Minimum: 1
How many objects the ban lurker examines before taking a ban_lurker_sleep. Use this to pace the ban lurker so it does not eat too much CPU.
- Units: s
- Default: 0.010
- Minimum: 0.000
The ban lurker thread sleeps between work batches, in order to not monopolize CPU power. When nothing is done, it sleeps a fraction of a second before looking for new work to do. A value of zero disables the ban lurker.
- Units: s
- Default: 60.000
- Minimum: 0.000
Default timeout between bytes when receiving data from backend. We only wait for this many seconds between bytes before giving up. A value of 0 means it will never time out. VCL can override this default value for each backend request and backend request. This parameter does not apply to pipe.
- Units: bool
- Default: off
Cache free busyobj per worker thread. Disable this if you have very high hitrates and want to save the memory of one busyobj per worker thread.
- Default: "exec gcc -std=gnu99 -g -O2 -Wall -Werror -Wno-error=unused-result t-Werror t-Wall t-Wno-format-y2k t-W t-Wstrict-prototypes t-Wmissing-prototypes t-Wpointer-arith t-Wreturn-type t-Wcast-qual t-Wwrite-strings t-Wswitch t-Wshadow t-Wunused-parameter t-Wcast-align t-Wchar-subscripts t-Wnested-externs t-Wextra t-Wno-sign-compare -fstack-protector -Wno-pointer-sign -Wno-address -Wno-missing-field-initializers -pthread -fpic -shared -Wl,-x -o %o %s"
- Flags: must_reload
Command used for compiling the C source code to a dlopen(3) loadable object. Any occurrence of %s in the string will be replaced with the source file name, and %o will be replaced with the output file name.
- Units: bytes
- Default: 8k
- Minimum: 4k
Size of buffer for CLI command input. You may need to increase this if you have big VCL files and use the vcl.inline CLI command. NB: Must be specified with -p to have effect.
- Units: bytes
- Default: 48k
- Minimum: 128b
- Maximum: 99999999b
Maximum size of CLI response. If the response exceeds this limit, the reponse code will be 201 instead of 200 and the last line will indicate the truncation.
- Units: seconds
- Default: 60.000
- Minimum: 0.000
Timeout for the childs replies to CLI requests from the mgt_param.
- Units: s
- Default: 10
- Minimum: 0
How much clockskew we are willing to accept between the backend and our own clock.
- Units: s
- Default: 3.500
- Minimum: 0.000
Default connection timeout for backend connections. We only try to connect to the backend for this many seconds before giving up. VCL can override this default value for each backend and backend request.
- Units: s
- Default: 180.000
- Minimum: 60.000
- Maximum: 254.000
- Flags: wizard
How long time the critbit hasher keeps deleted objheads on the cooloff list.
- Default: none
Enable/Disable various kinds of debugging.
- none
- Disable all debugging
Use +/- prefix to set/reset individual bits:
- req_state
- VSL Request state engine
- workspace
- VSL Workspace operations
- waiter
- VSL Waiter internals
- waitinglist
- VSL Waitinglist events
- syncvsl
- Make VSL synchronous
- hashedge
- Edge cases in Hash
- vclrel
- Rapid VCL release
- lurker
- VSL Ban lurker
- esi_chop
- Chop ESI fetch to bits
- Units: seconds
- Default: 10.000
- Minimum: 0.000
- Flags:
Default grace period. We will deliver an object this long after it has expired, provided another thread is attempting to get a new copy.
- Units: seconds
- Default: 0.000
- Minimum: 0.000
- Flags:
Default keep period. We will keep a useless object around this long, making it available for conditional backend fetches. That means that the object will be removed from the cache at the end of ttl+grace+keep.
- Units: seconds
- Default: 120.000
- Minimum: 0.000
- Flags:
The TTL assigned to objects if neither the backend nor the VCL code assigns one.
- Default: none
Enable/Disable various minor features.
- none
- Disable all features.
Use +/- prefix to enable/disable individual feature:
- short_panic
- Short panic message.
- wait_silo
- Wait for persistent silo.
- no_coredump
- No coredumps.
- esi_ignore_https
- Treat HTTPS as HTTP in ESI:includes
- esi_disable_xml_check
- Don't check of body looks like XML
- esi_ignore_other_elements
- Ignore non-esi XML-elements
- esi_remove_bom
- Remove UTF-8 BOM
- Units: bytes
- Default: 128k
- Minimum: 4k
- Flags: experimental
The default chunksize used by fetcher. This should be bigger than the majority of objects with short TTLs. Internal limits in the storage_file module makes increases above 128kb a dubious idea.
- Units: bytes
- Default: 0.25G
- Minimum: 64k
- Flags: experimental
The maximum chunksize we attempt to allocate from storage. Making this too large may cause delays and storage fragmentation.
- Units: s
- Default: 60.000
- Minimum: 0.000
Default timeout for receiving first byte from backend. We only wait for this many seconds for the first byte before giving up. A value of 0 means it will never time out. VCL can override this default value for each backend and backend request. This parameter does not apply to pipe.
- Units: bytes
- Default: 32k
- Minimum: 2k
- Flags: experimental
Size of malloc buffer used for gzip processing. These buffers are used for in-transit data, for instance gunzip'ed data being sent to a client.Making this space to small results in more overhead, writes to sockets etc, making it too big is probably just a waste of memory.
- Default: 8
- Minimum: 1
- Maximum: 9
Gzip memory level 1=slow/least, 9=fast/most compression. Memory impact is 1=1k, 2=2k, ... 9=256k.
- Units: bool
- Default: on
Clients that do not support gzip will have their Accept-Encoding header removed. For more information on how gzip is implemented please see the chapter on gzip in the Varnish reference.
- Units: header lines
- Default: 64
- Minimum: 32
- Maximum: 65535
Maximum number of HTTP header lines we allow in {req|resp|bereq|beresp}.http (obj.http is autosized to the exact number of headers). Cheap, ~20 bytes, in terms of workspace memory. Note that the first line occupies five header lines.
- Units: bytes
- Default: 8k
- Minimum: 40b
Maximum length of any HTTP client request header we will allow. The limit is inclusive its continuation lines.
- Units: bytes
- Default: 32k
- Minimum: 0.25k
Maximum number of bytes of HTTP client request we will deal with. This is a limit on all bytes up to the double blank line which ends the HTTP request. The memory for the request is allocated from the client workspace (param: workspace_client) and this parameter limits how much of that the request is allowed to take up.
- Units: bytes
- Default: 8k
- Minimum: 40b
Maximum length of any HTTP backend response header we will allow. The limit is inclusive its continuation lines.
- Units: bytes
- Default: 32k
- Minimum: 0.25k
Maximum number of bytes of HTTP backend resonse we will deal with. This is a limit on all bytes up to the double blank line which ends the HTTP request. The memory for the request is allocated from the worker workspace (param: thread_pool_workspace) and this parameter limits how much of that the request is allowed to take up.
- Units: seconds
- Default: 60.000
- Minimum: 0.000
- Flags: delayed
Time to wait with no data sent. If no data has been transmitted in this many seconds the session is closed. See setsockopt(2) under SO_SNDTIMEO for more information.
- Default: :80
- Flags: must_restart
Whitespace separated list of network endpoints where Varnish will accept requests. Possible formats: host, host:port, :port
- Units: seconds
- Default: 2.000
- Minimum: 0.000
- Flags: experimental
Grace period before object moves on LRU list. Objects are only moved to the front of the LRU list if they have not been moved there already inside this timeout period. This reduces the amount of lock operations necessary for LRU list access.
- Units: restarts
- Default: 4
- Minimum: 0
Upper limit on how many times a request can restart. Be aware that restarts are likely to cause a hit against the backend, so don't increase thoughtlessly.
- Units: retries
- Default: 4
- Minimum: 0
Upper limit on how many times a backend fetch can retry.
- Units: allocations
- Default: 50
- Minimum: 0
- Flags: experimental
Maximum number of objects we attempt to nuke in orderto make space for a object body.
- Default: 10000
- Minimum: 1
The limit for the number of internal matching function calls in a pcre_exec() execution.
- Default: 10000
- Minimum: 1
The limit for the number of internal matching function recursions in a pcre_exec() execution.
- Units: seconds
- Default: 3
- Minimum: 0
- Flags: must_restart
Interval between pings from parent to child. Zero will disable pinging entirely, which makes it possible to attach a debugger to the child.
- Units: seconds
- Default: 60.000
- Minimum: 0.000
Idle timeout for PIPE sessions. If nothing have been received in either direction for this many seconds, the session is closed.
- Default: 10,100,10
Parameters for per worker pool request memory pool. The three numbers are:
- min_pool
- minimum size of free pool.
- max_pool
- maximum size of free pool.
- max_age
- max age of free element.
- Default: 10,100,10
Parameters for per worker pool session memory pool. The three numbers are:
- min_pool
- minimum size of free pool.
- max_pool
- maximum size of free pool.
- max_age
- max age of free element.
- Default: 10,100,10
Parameters for backend connection memory pool. The three numbers are:
- min_pool
- minimum size of free pool.
- max_pool
- maximum size of free pool.
- max_age
- max age of free element.
- Default: 10,100,10
Parameters for backend object fetch memory pool. The three numbers are:
- min_pool
- minimum size of free pool.
- max_pool
- maximum size of free pool.
- max_age
- max age of free element.
- Units: bool
- Default: off
Prefer IPv6 address when connecting to backends which have both IPv4 and IPv6 addresses.
- Units: requests per request
- Default: 3
- Minimum: 2
- Flags: experimental
How many parked request we start for each completed request on the object. NB: Even with the implict delay of delivery, this parameter controls an exponential increase in number of worker threads.
- Units: seconds
- Default: 600.000
- Minimum: 0.000
- Flags: delayed
Send timeout for client connections. If the HTTP response hasn't been transmitted in this many seconds the session is closed. See setsockopt(2) under SO_SNDTIMEO for more information.
- Units: sessions
- Default: 100000
- Minimum: 1000
Maximum number of sessions we will allocate from one pool before just dropping connections. This is mostly an anti-DoS measure, and setting it plenty high should not hurt, as long as you have the memory for it.
- Units: bytes
- Default: 255b
- Minimum: 16b
- Maximum: 65535b
Maximum number of bytes in SHM log record. Maximum is 65535 bytes.
- Units: s
- Default: 10.000
- Minimum: 0.000
Objects created with (ttl+grace+keep) shorter than this are always put in transient storage.
- Units: bool
- Default: off
- Flags: must_restart
Install a signal handler which tries to dump debug information on segmentation faults.
- Units: seconds
- Default: 75.000
- Minimum: 1.000
- Maximum: 100.000
- Flags: experimental
The number of seconds between TCP keep-alive probes.
- Units: probes
- Default: 9
- Minimum: 1
- Maximum: 100
- Flags: experimental
The maximum number of TCP keep-alive probes to send before giving up and killing the connection if no response is obtained from the other end.
- Units: seconds
- Default: 7200.000
- Minimum: 1.000
- Maximum: 7200.000
- Flags: experimental
The number of seconds a connection needs to be idle before TCP begins sending out keep-alive probes.
- Units: seconds
- Default: 0.000
- Minimum: 0.000
- Flags: experimental
Wait at least this long after creating a thread.
Some (buggy) systems may need a short (sub-second) delay between creating threads. Set this to a few milliseconds if you see the 'threads_failed' counter grow too much.
Setting this too high results in insuffient worker threads.
- Units: seconds
- Default: 1.000
- Minimum: 0.010
- Flags: delayed, experimental
Wait this long after destroying a thread.
This controls the decay of thread pools when idle(-ish).
Minimum is 0.01 second.
- Units: seconds
- Default: 0.200
- Minimum: 0.010
- Flags: experimental
Wait at least this long after a failed thread creation before trying to create another thread.
Failure to create a worker thread is often a sign that the end is near, because the process is running out of some resource. This delay tries to not rush the end on needlessly.
If thread creation failures are a problem, check that thread_pool_max is not too high.
It may also help to increase thread_pool_timeout and thread_pool_min, to reduce the rate at which treads are destroyed and later recreated.
- Units: threads
- Default: 5000
- Minimum: 100
- Flags: delayed
The maximum number of worker threads in each pool.
Do not set this higher than you have to, since excess worker threads soak up RAM and CPU and generally just get in the way of getting work done.
Minimum is 10 threads.
- Units: threads
- Default: 100
- Maximum: 5000
- Flags: delayed
The minimum number of worker threads in each pool.
Increasing this may help ramp up faster from low load situations or when threads have expired.
Minimum is 10 threads.
- Units: bytes
- Default: 48k
- Minimum: 16k
- Flags: experimental
Worker thread stack size. This will likely be rounded up to a multiple of 4k (or whatever the page_size might be) by the kernel.
- Units: seconds
- Default: 300.000
- Minimum: 10.000
- Flags: delayed, experimental
Thread idle threshold.
Threads in excess of thread_pool_min, which have been idle for at least this long, will be destroyed.
Minimum is 10 seconds.
- Units: pools
- Default: 2
- Minimum: 1
- Flags: delayed, experimental
Number of worker thread pools.
Increasing number of worker pools decreases lock contention.
Too many pools waste CPU and RAM resources, and more than one pool for each CPU is probably detrimal to performance.
Can be increased on the fly, but decreases require a restart to take effect.
- Default: 20
- Minimum: 0
- Flags: experimental
Permitted queue length per thread-pool.
This sets the number of requests we will queue, waiting for an available thread. Above this limit sessions will be dropped instead of queued.
- Units: requests
- Default: 10
- Minimum: 0
- Flags: experimental
Worker threads accumulate statistics, and dump these into the global stats counters if the lock is free when they finish a request. This parameters defines the maximum number of requests a worker thread may handle, before it is forced to dump its accumulated stats into the global counters.
- Units: seconds
- Default: 5.000
- Minimum: 0.000
Idle timeout for client connections. A connection is considered idle, until we receive a non-white-space character on it.
- Units: seconds
- Default: 0.050
- Minimum: 0.000
- Flags: experimental
How long time the workerthread lingers on an idle session before handing it over to the waiter. When sessions are reused, as much as half of all reuses happen within the first 100 msec of the previous request completing. Setting this too high results in worker threads not doing anything for their keep, setting it too low just means that more sessions take a detour around the waiter.
- Units: seconds
- Default: 2.000
- Minimum: 0.000
Max time to receive clients request header, measured from first non-white-space character to double CRNL.
- Units: bool
- Default: on
Allow '/' in vmod & include paths. Allow 'import ... from ...'.
- Default: /opt/varnish/etc/varnish
Directory from which relative VCL filenames (vcl.load and include) are opened.
- Units: bytes
- Default: 4k
- Minimum: 1k
Bytes of (req-/backend-)workspace dedicated to buffering VSL records. At a bare minimum, this must be longer than the longest HTTP header to be logged. Setting this too high costs memory, setting it too low will cause more VSL flushes and likely increase lock-contention on the VSL mutex. Minimum is 1k bytes.
- Default: -VCL_trace,-WorkThread,-Hash
Mask individual VSL messages from being logged.
- default
- Set default value
Use +/- prefixe in front of VSL tag name, to mask/unmask individual VSL messages.
- Units: bytes
- Default: 80M
- Minimum: 1M
- Flags: must_restart
The amount of space to allocate for the VSL fifo buffer in the VSM memory segment. If you make this too small, varnish{ncsa|log} etc will not be able to keep up. Making it too large just costs memory resources.
- Units: bytes
- Default: 1M
- Minimum: 1M
- Flags: must_restart
The amount of space to allocate for stats counters in the VSM memory segment. If you make this too small, some counters will be invisible. Making it too large just costs memory resources.
- Default: epoll (possible values: epoll, poll)
- Flags: must_restart, wizard
Select the waiter kernel interface.
- Units: bytes
- Default: 64k
- Minimum: 1k
- Flags: delayed
Bytes of HTTP protocol workspace for backend HTTP req/resp. If larger than 4k, use a multiple of 4k for VM efficiency.
- Units: bytes
- Default: 64k
- Minimum: 3k
- Flags: delayed
Bytes of HTTP protocol workspace for clients HTTP req/resp. If larger than 4k, use a multiple of 4k for VM efficiency.
- Units: bytes
- Default: 384b
- Minimum: 0.25k
- Flags: delayed
Bytes of workspace for session and TCP connection addresses. If larger than 4k, use a multiple of 4k for VM efficiency.
- Units: bytes
- Default: 2k
- Minimum: 0.25k
- Maximum: 8k
- Flags: delayed
Bytes of auxillary workspace per thread. This workspace is used for certain temporary data structures during the operation of a worker thread. One use is for the io-vectors for writing requests and responses to sockets, having too little space will result in more writev(2) system calls, having too much just wastes the space.
The varnishd daemon was developed by Poul-Henning Kamp in cooperation with Verdens Gang AS and Varnish Software.
This manual page was written by Dag-Erling Smørgrav with updates by Stig Sandbeck Mathisen <ssm@debian.org>.
This document is licensed under the same licence as Varnish itself. See LICENCE for details.