Skip to content

document the mysterious abc part of the header #3880

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

document the mysterious abc part of the header #3880

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions cookbook/cache/varnish.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,11 @@ application:
set req.http.Surrogate-Capability = "abc=ESI/1.0";
}

.. note::

The ``abc`` part of the header isn't important unless you have multiple "surrogates"
that need to advertise their capabilities. See `Surrogate-Capability Header`_ for details.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should turn this into a note, and mostly link to the docs on this, as I think most users won't need to worry about this (but I like the idea of showing people where they can find out more, I didn't know what the abc was before this either).:

.. note::

    The ``abc`` part of the header isn't important unless you have multiple "surrogates"
    that need to advertise their capabilities. See `Surrogate-Capability Header`_ for details.

Then at the bottom of the page:

.. _`Surrogate-Capability Header`: http://www.w3.org/TR/edge-arch

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree, I'll change this later.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done and rebased on master (I made the PR on master, not sure why, tell me if you would like me to close it and make another on 2.3)

Then, optimize Varnish so that it only parses the Response contents when there
is at least one ESI tag by checking the ``Surrogate-Control`` header that
Symfony2 adds automatically:
Expand Down Expand Up @@ -217,3 +222,4 @@ absolute URLs:
.. _`Varnish`: https://www.varnish-cache.org
.. _`Edge Architecture`: http://www.w3.org/TR/edge-arch
.. _`GZIP and Varnish`: https://www.varnish-cache.org/docs/3.0/phk/gzip.html
.. _`Surrogate-Capability Header`: http://www.w3.org/TR/edge-arch