Skip to content

Commit

Permalink
Merge pull request #64 from plone/remove-outdated-examples
Browse files Browse the repository at this point in the history
Remove hopelessly outdated proxy config examples
  • Loading branch information
jensens authored Oct 7, 2020
2 parents 4992bab + 62e92a2 commit ee56eaa
Show file tree
Hide file tree
Showing 15 changed files with 9 additions and 490 deletions.
1 change: 0 additions & 1 deletion docs/caching-profiles.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@ The three default caching profiles:
* **With caching proxy (and split-view caching)**
An example profile for a caching proxy setup with split-view
caching enabled. This example requires a special proxy setup.
See the proxy examples in the "proxy-configs" directory.


Custom caching profiles
Expand Down
21 changes: 2 additions & 19 deletions docs/caching-proxies.rst
Original file line number Diff line number Diff line change
Expand Up @@ -103,25 +103,8 @@ before he had a new haircut.
Installing and configuring a caching proxy
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The ``plone.app.caching`` package includes some example buildout
configurations in the ``proxy-configs`` directory. Two versions are included:
one demonstrating a Squid-behind-Apache proxy setup and another demonstrating
a Varnish-behind-Apache proxy setup. Both examples also demonstrate how to
properly configure split-view caching.

These configurations are provided for instructional purposes but with a little
modification they can also be used in production. To use in a real production
instance, you will need to adjust the configuration to match your setup. For a
simple standard setup, you might only need to change the ``hostname`` value in
the buildout.cfg. Read the README.txt files in each example for more
instructions.

There are also some alternative buildout recipes for building and configuring
proxy configs: `plone.recipe.squid`_ and `plone.recipe.varnish`_. The examples
in this package do not use these recipes in favor of using a more explicit,
and hopefully more educational, template-based approach. Even if you decide to
use one of the automated recipes, it will probably be worth your while to
study the examples included in this package to get a few pointers.
There are buildout recipes for building and configuring proxy configs: `plone.recipe.squid`_ and `plone.recipe.varnish`_.


Running Plone behind Apache 2.2 with mod_cache
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down
5 changes: 1 addition & 4 deletions docs/split-views.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,4 @@ responses.
Yet another solution involves intercepting the request and dynamically adding
a special ``X-Anonymous`` header to the anonymous request and then adding
``Vary:X-Anonymous`` to the split view response so that this header will added
to the cache key. Examples of this last solution for both Squid and Varnish
are included in the ``proxy-configs`` directory of this package, which are
intended to be used in concert with something like the split-view caching
profile of ``plone.app.caching``.
to the cache key.
4 changes: 4 additions & 0 deletions news/64.doc
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Remove hopelessly outdated proxy config examples.
Look at plone.recipe.varnish for excellent examples!
[jensens]

22 changes: 0 additions & 22 deletions plone/app/caching/proxy-configs/squid/README.txt

This file was deleted.

59 changes: 0 additions & 59 deletions plone/app/caching/proxy-configs/squid/buildout.cfg

This file was deleted.

This file was deleted.

52 changes: 0 additions & 52 deletions plone/app/caching/proxy-configs/squid/templates/squid.conf.in

This file was deleted.

17 changes: 0 additions & 17 deletions plone/app/caching/proxy-configs/squid/templates/squid.in

This file was deleted.

22 changes: 0 additions & 22 deletions plone/app/caching/proxy-configs/varnish/README.txt

This file was deleted.

57 changes: 0 additions & 57 deletions plone/app/caching/proxy-configs/varnish/buildout.cfg

This file was deleted.

Loading

0 comments on commit ee56eaa

Please sign in to comment.