• Stars
    star
    353
  • Rank 120,322 (Top 3 %)
  • Language
    HTML
  • License
    Other
  • Created over 13 years ago
  • Updated over 2 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Varnish Tutorial and training material

Training material and related tools

This repository contains:

  • Training material used for Varnish Plus training
  • Source for the slides and book version
  • A snapshot of munin graphs for use by instructors.
  • PHP example-code for testing Varnish
  • Build system for said training material

This is the training material Varnish Software uses for professional Varnish training courses. It is made available under a Creative Commons CC-BY-NC-SA license (see the LICENSE file for details) as a book.

The build system produces the book in PDF and HTML formats. The PDF format includes two editions, one as the book for trainees, and the other as slides for the trainer. You can download this book in PDF format from https://www.varnish-software.com/download-varnish-book.

Index

  • build/ - Created on make, contains PDF output, html-output and necessary images
  • Makefile
  • material/ - PHP files, mainly used by the web-dev material
  • misc/ - Contains strange stuff. Including the old course (Linpro-source) and a patch for rst2s5 needed (and a pre-patched version).
  • munin/ - Anonymized munin graphs for instructors
  • NEWS - List of changes instructors should be be aware of from version to version.
  • README - This file
  • TODO
  • ui/ - Images, style-definitions for PDFs and CSS for the slides.
  • util/ - Headers for the rst, tool to make version.rst, strip-class to remove an rst-class (for generating slides as PDF instead of s5).
  • varnish_book.rst - course itself
  • vcl/ - VCL files used in the course. Not a copy. Included directly as-is, and verified by make check. (note: If 'backend' is missing, a generic backend will be added on the fly during make check).
  • src/ - Resource files for sphinx to export the book in HTML version. This folder contains a Makefile to build the book in different formats. Enter to the directory and type make to see the building targets.

Building the material

Install the following packages with their dependencies.

  • rst2pdf
  • gawk
  • git
  • make
  • graphviz
  • php5
  • sphinx 1.3 or later
  • python-docutils
  • inkscape
  • Open Sans font type

You also need the "Open Source" font type. To check whether you have it, type fc-match "Open Sans" in the terminal. The command should output OpenSans-Regular.ttf: "Open Sans" "Regular". Otherwise, do the following:

$ wget http://www.fontsquirrel.com/fonts/download/open-sans
$ sudo unzip open-sans -d /usr/local/share/fonts/truetype/
$ rm open-sans
$ fc-cache
$ fc-match "Open Sans"

Download the source code of this book:

git clone https://github.com/varnish/Varnish-Book.git

Compile the book:

make book

All build-stuff is handled by make. The following is an incomplete list of targets:

make book
Builds book in PDF format
make sphinx
Builds book in HTML and ePub format
make slides
Builds slides in PDF format. This slides are to be used in a training course.
make clean
removes build/
make util/param.rst
Updates the default values of your Varnish installation.
These values are the ones to be used in your book building.
make sourceupdate
Calls util/param.rst rule and will call other rules to update the sources of the book.

Updating the training material

Read NEWS, and make sure you always add significant content changes in this file, so the instructor(s) can keep track of changes without reading commit logs.

Try to use only tip, warning and note boxes.

To change the layout, change ui/pdf.style or ui/pdf_slide.style.

The syntax for indirect hyperlink targets (double underscores __) is not the same for rst as for sphinx. Thefore, for simplicity, avoid them. More than two refereces per sentence is not supported by rst2sphinxparser.igawk.

Figures and tables must have a counter right before their directive. The counter must be as the following example:

.. figure 1

or:

.. table 1

Use git-tag every time that the book is printed and distributed.

Known issues

This subsection includes known issues for building the book in different formats.

Building with sphinx

  • List of figures and list of tables do not work when the figure or table caption includes a reference. This is a limitation to create the PDF with sphinx.
  • Fonts are not resized in notes or other cases such :class: tinycode.

Legal

This material is provided under a CC-BY-NC-SA license. The license is available from:

http://creativecommons.org/licenses/by-nc-sa/3.0/

And a copy of the license is available in the LICENSE file.

Clarification: The Non-Commercial clause of the CC-BY-NC-SA license is intentionally vague in the original license. Varnish Software does not interpret reading of the material as commercial, regardless of context (e.g: You can read the material at work, for the benefit of your self and the company). The Non-Commercial clause is intended to block competition with other commercial training offerings and to prohibit commercial printing and selling of the book. If you have any doubt as to how this should be interpreted, please contact [email protected] for clarification before proceeding.

More Repositories

1

hitch

A scalable TLS proxy by Varnish Software.
C
1,862
star
2

Varnish-Cache

Moved. New address: https://github.com/varnishcache/varnish-cache/
C
888
star
3

vagent2

Varnish Agent
Roff
283
star
4

varnish-modules

Collection of Varnish Cache modules (vmods) by Varnish Software
C
181
star
5

zipnish

Python
127
star
6

docker-varnish

Official docker image
Dockerfile
82
star
7

api-gateway-benchmarks

HCL
68
star
8

spew

HTTP request spewer / load generator
C
55
star
9

libvmod-example

An example vmod for Varnish Cache
Shell
53
star
10

libvmod-digest

Digest and HMAC vmod
C
50
star
11

libvmod-cookie

A Varnish module for simpler use of the cookie header.
C
49
star
12

libvmod-curl

cURL Varnish bindings by Varnish Software
C
48
star
13

libvmod-header

A header-modification vmod for Varnish
47
star
14

varnishgather

Information gathering tool for Varnish Cache.
Shell
45
star
15

libvmod-rtstatus

Varnish realtime status page.
C
37
star
16

libvmod-geoip

GeoIP Varnish module by Varnish Software
C
26
star
17

libvmod-shield

M4
25
star
18

libvmod-var

Variable support VMOD
25
star
19

varnish-agent

Perl
22
star
20

libvmod-vsthrottle

Improved request throttling module for Varnish
C
22
star
21

newrelic_varnish_plugin

Integration plugin between Varnish and New Relic
Ruby
21
star
22

varnish-nagios

Nagios plugin for Varnish
C
21
star
23

docker-hitch

Official Docker image for Varnish's Hitch TLS proxy
Dockerfile
14
star
24

libvmod-xkey

Secondary hashes for Varnish Cache. (surrogate keys, cache keys)
C
13
star
25

libvmod-memcached

A memcached client vmod for Varnish
C
12
star
26

toolbox

VCL
10
star
27

cookbooks

Chef cookbooks for installing Varnish
Ruby
9
star
28

varnish-wiki

Varnish Web Developer Wiki Documentation
VCL
8
star
29

libvmod-softpurge

C
6
star
30

varnishlog-json

Varnishlog, with a JSON output
C
5
star
31

varnish-gcov

Tools for measuring test suite coverage of Varnish Cache.
Python
4
star
32

libvmod-null

Simple nulldata with synth()
M4
4
star
33

nodestatus

Lightweight web service to report node status to a load balancer
Go
4
star
34

libvarnish-sslhelper

Varnish OpenSSL initialization helper
C
2
star
35

libvmod-saintmode

Saint mode module for Varnish Cache 4.1.
C
2
star
36

vcs2csv

Go
1
star
37

router_example

Varnish Controller HTTP Routing Example
Shell
1
star
38

helm-varnish-cache

Helm Chart for Varnish Cache
Shell
1
star
39

pkg-hitch

Shell
1
star
40

uap-varnish

Generate Varnish VCL rules from ua-parser data
Go
1
star