1 | Products.CacheSetup Installation |
---|
2 | ================================ |
---|
3 | |
---|
4 | ``Products.CacheSetup`` is the python egg version of the old |
---|
5 | ``CacheSetup`` product. The egg version automatically takes |
---|
6 | care of installing all the dependancies that make up the |
---|
7 | CacheFu bundle. However, the proxy cache configs must |
---|
8 | still be downloaded and configured separately. |
---|
9 | |
---|
10 | References to the "Manual" below refer to the new CacheFu |
---|
11 | manual nearing completion as of this release. Visit the |
---|
12 | official CacheFu site, http://plone.org/products/cachefu, |
---|
13 | for the latest instructions. |
---|
14 | |
---|
15 | There are three options for installation, and then some |
---|
16 | post-installation steps: |
---|
17 | |
---|
18 | |
---|
19 | (1) Global Install |
---|
20 | ------------------ |
---|
21 | |
---|
22 | To install ``Products.CacheSetup`` into the global Python |
---|
23 | environment (or a workingenv) using a traditional Zope 2 |
---|
24 | instance: |
---|
25 | |
---|
26 | * Run ``easy_install Products.CacheSetup``. |
---|
27 | Find out how to install setuptools (and EasyInstall) here: |
---|
28 | http://peak.telecommunity.com/DevCenter/EasyInstall |
---|
29 | |
---|
30 | * If you are using Zope 2.9 (not 2.10), get `pythonproducts`_ |
---|
31 | and install it into your Zope instance via:: |
---|
32 | |
---|
33 | python setup.py install --home /path/to/instance |
---|
34 | |
---|
35 | .. _pythonproducts: http://plone.org/products/pythonproducts |
---|
36 | |
---|
37 | |
---|
38 | (2) Local Install (standard buildout install) |
---|
39 | --------------------------------------------- |
---|
40 | |
---|
41 | To install ``Products.CacheSetup`` into the local zope instance |
---|
42 | if you are using ``zc.buildout`` and the ``plone.recipe.zope2instance`` |
---|
43 | recipe to manage your project: |
---|
44 | |
---|
45 | * Add ``Products.CacheSetup`` to the list of eggs to |
---|
46 | install:: |
---|
47 | |
---|
48 | [buildout] |
---|
49 | ... |
---|
50 | eggs = |
---|
51 | ... |
---|
52 | Products.CacheSetup |
---|
53 | |
---|
54 | * Re-run buildout:: |
---|
55 | |
---|
56 | $ ./bin/buildout |
---|
57 | |
---|
58 | |
---|
59 | (3) Local Install (old style Product install) |
---|
60 | --------------------------------------------- |
---|
61 | |
---|
62 | Because its top level python namespace package is called |
---|
63 | ``Products``, this package can also be installed in Zope 2 |
---|
64 | as an old style *Zope 2 Product*. |
---|
65 | |
---|
66 | For an old style Product install, move (or symlink) the |
---|
67 | ``CacheSetup`` folder of this project |
---|
68 | (``Products.CacheSetup/Products/CacheSetup``) into the |
---|
69 | ``Products`` directory of the Zope instance, and restart |
---|
70 | the server. |
---|
71 | |
---|
72 | Note that in this case, dependancies are not automatically |
---|
73 | installed so you will have to repeat this process for |
---|
74 | the rest of the CacheFu bundle: ``Products.CMFSquidTool``, |
---|
75 | ``Products.PageCacheManager``, and ``Products.PolicyHTTPCacheManager``. |
---|
76 | |
---|
77 | |
---|
78 | Post-Installation Steps |
---|
79 | ----------------------- |
---|
80 | |
---|
81 | If installing for the first time: |
---|
82 | |
---|
83 | * After starting up Zope, install the CacheSetup product |
---|
84 | via the Plone "Add/Remove Products" page |
---|
85 | |
---|
86 | * Optional: Configure via the "Cache Configuration Tool" |
---|
87 | (see "Configuring CacheFu" in the Manual) |
---|
88 | |
---|
89 | * Optional: Install and configure Squid or Varnish |
---|
90 | (see below) |
---|
91 | |
---|
92 | |
---|
93 | If upgrading from a pre-1.2 version: |
---|
94 | |
---|
95 | * Remove the previous version from the Products |
---|
96 | directory of the instance. ``CacheSetup``, ``CMFSquidTool``, |
---|
97 | ``PageCacheManager``, and ``PolicyHTTPCacheManager`` have all |
---|
98 | been replaced by ``Products.CacheSetup``, ``Products.CMFSquidTool``, |
---|
99 | etc. If CacheFu was previously installed in a buildout |
---|
100 | via ``plone.recipe.distros``, then remove the old CacheFu |
---|
101 | settings from this section and re-run buildout. |
---|
102 | |
---|
103 | * Restart Zope |
---|
104 | |
---|
105 | * Click on the reinstall link next to the CacheSetup |
---|
106 | product in the Plone "Add/Remove Products" page |
---|
107 | |
---|
108 | * Note: A reinstall keeps your old pre-1.1 configuration |
---|
109 | in a Cache Policy named "Old Cache Policy". Any other |
---|
110 | cache policies with ids that conflict with the new ones |
---|
111 | will be backed up and relabeled appropriately |
---|
112 | |
---|
113 | * Optional: Configure via the "Cache Configuration Tool" |
---|
114 | (see "Configuring CacheFu" in the Manual) |
---|
115 | |
---|
116 | * Optional: Install and configure Squid or Varnish |
---|
117 | (see below) |
---|
118 | |
---|
119 | * IMPORTANT: There is no upgrade path from the pre-1.0 |
---|
120 | versions of CacheFu. In this case, the old CacheFu |
---|
121 | products should be completely uninstalled via the Plone |
---|
122 | "Add/Remove Products" page and then deleted from the |
---|
123 | Products directory of the instance BEFORE installing |
---|
124 | the new version. |
---|
125 | |
---|
126 | |
---|
127 | Proxy Cache Installation and Configuration |
---|
128 | ------------------------------------------ |
---|
129 | |
---|
130 | Buildout recipes for building and configuring Squid, Varnish, |
---|
131 | and Apache are available: |
---|
132 | |
---|
133 | * http://pypi.python.org/pypi/plone.recipe.squid |
---|
134 | |
---|
135 | * http://pypi.python.org/pypi/plone.recipe.varnish |
---|
136 | |
---|
137 | * http://pypi.python.org/pypi/plone.recipe.apache |
---|
138 | |
---|
139 | Previously, the CacheFu bundle also included a collection of |
---|
140 | auto-generated proxy configs for Squid, Varnish, and Apache. |
---|
141 | Starting with version 1.2, this collection is now maintained |
---|
142 | as a separate download found at http://plone.org/products/cachefu |
---|
143 | |
---|
144 | |
---|