|
1 | 1 | --- |
2 | 2 | myst: |
3 | 3 | html_meta: |
4 | | - "description": "Caching Plone: Enable cache support" |
5 | | - "property=og:description": "Enabling caching support for Plone" |
6 | | - "property=og:title": "Caching Plone: Enabling support" |
7 | | - "keywords": "Plone, deployment, automation, caching" |
| 4 | + "description": "How to enable cache support in Plone" |
| 5 | + "property=og:description": "How to enable cache support in Plone" |
| 6 | + "property=og:title": "How to enable cache support in Plone" |
| 7 | + "keywords": "Plone, deployment, automation, caching, cache" |
8 | 8 | --- |
9 | 9 |
|
10 | 10 | (caching-installation-label)= |
11 | 11 |
|
12 | 12 | # Installation |
13 | 13 |
|
14 | | -Caching support is implemented by the package `plone.app.caching`, which is already shipped as a dependency of the *Plone* package, and it should be available on all Plone installations. |
| 14 | +Caching support is implemented by the package `plone.app.caching`. |
| 15 | +It is already installed as a dependency of the [Plone](https://github.com/plone/plone) package. |
| 16 | +It should be available on all Plone installations. |
15 | 17 |
|
16 | | -Even though Caching support is available in Plone, it is **not enabled by default**, although it is highly recommended to configure caching for every new Plone site in production. |
| 18 | +Even though cache support is available in Plone, it is **not enabled by default**. |
| 19 | +It is highly recommended to configure caching for every new Plone site in production. |
17 | 20 |
|
18 | | -## Enable Caching |
19 | 21 |
|
20 | | -Under the Advanced header, look for the `Caching` control panel -- currently only supported on the Classic UI -- and select it. |
| 22 | +## Enable caching |
21 | 23 |
|
22 | | -```{image} /_static/caching/ControlPanel-01.png |
23 | | -:alt: Plone Control Panel (Classic UI) |
| 24 | +Enabling of caching is currently only supported in the Classic UI. |
| 25 | + |
| 26 | +As an administrator, navigate to {guilabel}`Site Setup`. |
| 27 | +Under the {guilabel}`Advanced` heading or navigation item, select the <img alt="Caching" src="/_static/caching/icon-caching.svg" class="inline"> {guilabel}`Caching` control panel. |
| 28 | + |
| 29 | +````{card} |
| 30 | +```{image} /_static/caching/advanced-caching-navigation.png |
| 31 | +:alt: Plone Classic UI Caching Control Panel in the navigation |
| 32 | +:target: /_static/caching/advanced-caching-navigation.png |
| 33 | +``` |
| 34 | ++++ |
| 35 | +_Caching Control Panel in the navigation_ |
| 36 | +```` |
| 37 | + |
| 38 | +````{card} |
| 39 | +```{image} /_static/caching/advanced-caching-heading.png |
| 40 | +:alt: Plone Classic UI Caching Control Panel under a heading |
| 41 | +:target: /_static/caching/advanced-caching-heading.png |
24 | 42 | ``` |
| 43 | ++++ |
| 44 | +_Caching Control Panel under a heading_ |
| 45 | +```` |
25 | 46 |
|
26 | | -In the Caching control panel, the tab `Change settings` is selected and inside of it the tab `Global settings` have the option to **Enable caching** (disable by default) |
| 47 | +In the Caching control panel, the tab {guilabel}`Change settings` is selected by default. |
| 48 | +Inside of it, the tab {guilabel}`Global settings` has the option to {guilabel}`Enable caching`. |
| 49 | +This setting is disabled by default. |
27 | 50 |
|
28 | | -```{image} /_static/caching/ControlPanel-02.png |
| 51 | +````{card} |
| 52 | +```{image} /_static/caching/caching-disabled.png |
29 | 53 | :alt: Caching Control Panel with caching disabled |
| 54 | +:target: /_static/caching/caching-disabled.png |
30 | 55 | ``` |
| 56 | ++++ |
| 57 | +_Caching Control Panel with caching disabled_ |
| 58 | +```` |
31 | 59 |
|
32 | | -To enable caching, click the checkbox: |
| 60 | +To enable caching, click the checkbox, and click the {guilabel}`Save` button. |
33 | 61 |
|
34 | | -```{image} /_static/caching/ControlPanel-03.png |
| 62 | +````{card} |
| 63 | +```{image} /_static/caching/caching-enabled.png |
35 | 64 | :alt: Caching Control Panel with caching enabled |
| 65 | +:target: /_static/caching/caching-enabled.png |
36 | 66 | ``` |
| 67 | ++++ |
| 68 | +_Caching Control Panel with caching enabled_ |
| 69 | +```` |
| 70 | + |
37 | 71 |
|
38 | 72 | ## Troubleshooting |
39 | 73 |
|
40 | | -When the Caching control panel is not there, there can be various reasons for this: |
| 74 | +When the caching control panel is not there, there can be various reasons for this: |
41 | 75 |
|
42 | | -- If your installation does not load the `Plone` package, but only `Products.CMFPlone`, then `plone.app.caching` is not included. |
43 | | -- If the package *is* included, but you add a Plone Site using the advanced form and disable caching, then the control panel is not there. |
| 76 | +- If your installation does not load the `Plone` package, but only `Products.CMFPlone`, then `plone.app.caching` is not included. |
| 77 | +- If the package *is* included, but you add a Plone Site using the advanced form and disable caching, then the control panel is not there. |
44 | 78 |
|
45 | 79 | If you want to install it in an existing Plone Site: |
46 | 80 |
|
47 | | -1. Make sure the package is available in the Plone instance, by adding `plone.app.caching` or `Plone` to your installation. |
48 | | -2. From the Plone Site Setup go to the ZMI (Zope Management Interface). |
49 | | -3. Go to ``portal_setup``, and then to the Import tab. |
50 | | -4. Select the HTTP caching support profile, perhaps easiest by id: `profile-plone.app.caching:default`. |
51 | | -5. Click 'Import all steps'. |
| 81 | +1. Make sure the package is available in the Plone instance by adding `plone.app.caching` or `Plone` to your installation. |
| 82 | +2. From the Plone Site Setup, under the {guilabel}`Advanced` heading or navigation item, select the <img alt="Management Interface" src="/_static/caching/icon-management-interface.svg" class="inline"> {guilabel}`Management Interface` control panel. |
| 83 | +3. Click {guilabel}`portal_setup`, and then click the {guilabel}`Import` tab. |
| 84 | +4. Select the profile by title {guilabel}`HTTP caching support`, or by id {guilabel}`profile-plone.app.caching:default`. |
| 85 | +5. Select {guilabel}`Apply new profiles. Run upgrade steps for already applied profiles. Recommended.`. |
| 86 | +6. Click the {guilabel}`Import all steps` button. |
| 87 | + |
| 88 | +````{card} |
| 89 | +```{image} /_static/caching/caching-import-configuration.png |
| 90 | +:alt: Site Configuration Full Import for HTTP caching support |
| 91 | +:target: /_static/caching/caching-import-configuration.png |
| 92 | +``` |
| 93 | ++++ |
| 94 | +_Site Configuration Full Import for HTTP caching support_ |
| 95 | +```` |
0 commit comments