KristianLyng / varnishfoo

A book about Varnish in the making
https://varnishfoo.info/
Creative Commons Attribution Share Alike 4.0 International
46 stars 12 forks source link

About Varnish Foo

.. _Varnish Cache: https://varnish-cache.org/ .. _Kristian Lyngstøl: https://kly.no/ .. _download a PDF: https://varnishfoo.info/varnishfoo.pdf .. _varnishfoo.info: https://varnishfoo.info

Varnish Foo is the ultimate Varnish Cache_ book out there. Or it will be, when it's done.

The book is being written by Kristian Lyngstøl, a long-time Varnish hacker. It is being published one chapter at a time, and you can either read it online at varnishfoo.info or download a PDF_.

This book is not done yet. The individual chapters are meant to stand well on their own, but many chapters are yet to be written and the content is likely to evolve over time.

Found something that should be fixed?

.. _the github repo: https://github.com/KristianLyng/varnishfoo/

I am very interested in any and all feedback, from pure spelling mistakes to factual errors or whether the book flows well or not.

The best way to get in contact with me is to jump over to the github repo_ and report an issue. If that doesn't work for you, you can also drop me a mail at kly@kly.no.

Current status

Chapter 1 through 3 stand well as they are, all though they might need some updates here and there.

Chapter 4, introduction to VCL, can be used as a reference as it is, but I have not done a thorough review of it yet from a pedagogical point of view. I expect some parts to require changes to be truly good.

Chapter 5 is currently being developed from scratch. Much has changed since I was at my peak in the Varnish community, so I intend to update my own knowledge throughout the development of that chapter (and further chapters). I do have some really good bits in store for you all, though.

Basically: Read chapter 1 through 4 as "true", but don't assume chapter 5 represents current best practices until further notice.

Also, I've been sort of lagging behind now.

Building

I build this on Debian (stable and testing). It should build fine on other distros too.

A Dockerfile is included and used for building the site. Please refer to that for detailed build instructions, even if you do not need to build in Docker.

Misc

.. _Creative Commons Attribution-ShareAlike 4.0 International License: LICENSE

.. include:: build/web-version.rst

.. figure:: img/cc-by-sa.png :target: appendix-x.html :alt: Creative Commons License

    `Varnish Foo` by Kristian Lyngstøl is licensed under a `Creative
    Commons Attribution-ShareAlike 4.0 International License`_.