In your Cargo.toml
:
[dependencies]
varnish = "0.0.16"
Varnish bindings, notably to build vmods, such as:
- vmod-reqwest: issue HTTP calls from VCL, use dynamic, HTTPS backends (support HTTP2)
- vmod-rers: support for dynamic regex, including response body manipulation
- vmod-fileserver: serve files directly from disk, without the need for an HTTP backend
Don't hesitate to open GitHub issues if something is unclear or impractical. You can also join us on discord.
varnish-rs
works on stable Rust and should be fine with more recent versions too. If it doesn't, please open an issue.
varnish-rs
relies on varnish-sys
(in this same repository) to generate bindings from the libvarnish
headers which you will need to install, depending on you linux distribution, the related package can be named varnish-devel
, varnish-dev
or maybe libvarnish-dev
.
Right now, the only Varnish versions supported are 7.*
.
At the moment, we use an embedded python script to generate the boilerplate that exposes the rust vmod code to Varnish. Make sure that python3
is in your path, or that the PYTHON
environment variable is pointing at a compatible interpreter.
- This project is easier to develop with just, a modern alternative to
make
. Install it withcargo install just
. - To get a list of available commands, run
just
. - To run tests, use
just test
.
git clone https://github.com/gquintard/varnish-rs.git
cd varnish-rs
cargo build
If your varnish
headers are installed where pkg-config
can find them, it's all there is to it. If not, you can set the VARNISH_INCLUDE_PATHS
environment variable to a colon-separated list of paths to search:
VARNISH_INCLUDE_PATHS=/my/custom/libpath:/my/other/custom/libpath cargo build
The varnish-rs
and varnish-sys
versions will work in tandem: to build version X of varnish
, you need version X of varnish-rs
and of varnish-sys
, in turn varnish-sys
will depend on a specific Varnish C library version:
varnish-rs/varnish-sys (rust) | libvarnish (C) |
---|---|
0.0.18 -> 0.0.19 | 7.5 |
0.0.17 | 7.4 |
0.0.15 -> 0.0.16 | 7.3 |
0.0.12 -> 0.0.14 | 7.2 |
0.0.9 -> 0.0.11 | 7.1 |
0.0.* | 7.0 |
You can check which Varnish version is required using the libvarnish
metadata field of varnish-sys
:
cargo metadata --format-version 1 | jq -r '.packages[] | select(.name == "varnish-sys") | .metadata.libvarnishapi.version '