You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/deployment/caching/profiles.md
+14-16Lines changed: 14 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,36 +15,36 @@ All persistent configuration for the caching machinery is stored in the configur
15
15
16
16
This can be modified using the `registry.xml` GenericSetup import step.
17
17
18
-
The *Import settings* tab of the control panel allows you to import these caching profiles.
18
+
The {guilabel}`Import settings` tab of the control panel allows you to import these caching profiles.
19
19
20
20
21
21
## Default caching profiles
22
22
23
23
`plone.app.caching` includes two default caching profiles.
24
-
These profiles encapsulate the cache settings that are known to work well with a typical default Plone installation:
24
+
These profiles encapsulate the cache settings that are known to work well with a typical default Plone installation:
25
25
26
-
### Without caching proxy
26
+
### {guilabel}`Without caching proxy`
27
27
28
28
Settings useful for setups without a caching proxy.
29
29
30
-
### With caching proxy
30
+
### {guilabel}`With caching proxy`
31
31
32
-
Settings useful for setups with a caching proxy such Varnish or a CDN.
33
-
The only difference from the "without caching proxy" profile are some settings to enable proxy caching of files/images in content space and content feeds.
32
+
Settings useful for setups with a caching proxy, such as Varnish or a CDN.
33
+
The only difference from the {guilabel}`Without caching proxy` profile are some settings to enable proxy caching of files and images in content space and content feeds.
34
34
35
35
## Custom caching profiles
36
36
37
37
Caching policies are often a compromise between speed and freshness.
38
38
More aggressive caching often comes at the cost of increased risk of stale responses.
39
-
The default profiles provided tend to err on the side of freshness over speed so there is some room for tweaking if greater speed is desired.
39
+
The provided default profiles tend to err on the side of freshness over speed, leaving room for greater speed if desired.
40
40
41
41
Customization may also be needed if third-party products are installed which require special treatment.
42
42
Examine the HTTP response headers to determine whether the third-party product requires special treatment.
43
43
Most simple cases probably can be solved by adding the content type or template to the appropriate mapping.
44
-
More complicated cases, may require custom caching operations.
44
+
More complicated cases may require custom caching operations.
45
45
46
46
A GenericSetup profile used for caching should be registered for the `ICacheProfiles` marker interface to distinguish it from more general profiles used to install a product.
47
-
This also hides the profile from Plone's Add-ons control panel.
47
+
This also hides the profile from Plone's {guilabel}`Add-ons` control panel.
48
48
49
49
Here is an example from this package:
50
50
@@ -59,9 +59,7 @@ Here is an example from this package:
59
59
/>
60
60
```
61
61
62
-
The directory `profiles/with-caching-proxy` contains a single import step, `registry.xml`,
63
-
containing settings to configure the ruleset to operation mapping,
64
-
and setting options for various operations.
62
+
The directory `profiles/with-caching-proxy` contains a single import step, `registry.xml`, containing settings to configure the ruleset to operation mapping, and setting options for various operations.
65
63
66
64
At the time of writing, this includes:
67
65
@@ -93,7 +91,7 @@ For example:
93
91
```
94
92
95
93
This enables RAM caching for the "weak caching" operation for resources using the ruleset `plone.content.itemView`.
96
-
The default is defined in the main `registry.xml` as::
94
+
The default is defined in the main `registry.xml` as shown below.
@@ -106,10 +104,10 @@ The default is defined in the main `registry.xml` as::
106
104
</record>
107
105
```
108
106
109
-
Notice how we use a *field reference* to avoid having to re-define the field.
107
+
Notice how we use a _field reference_ to avoid having to re-define the field.
110
108
111
-
It may be useful looking at these bundled `registry.xml` for inspiration if you are building your own caching profile.
112
-
Alternatively, you can export the registry from the `portal_setup` tool and pull out the records under the prefixes `plone.caching` and `plone.app.caching`.
109
+
It may be useful to look at the bundled `registry.xml` for inspiration if you are building your own caching profile.
110
+
Alternatively, you can export the registry from the `portal_setup` tool, and pull out the records under the prefixes `plone.caching` and `plone.app.caching`.
113
111
114
112
Typically, `registry.xml` is all that is required, but you are free to add additional import steps if required.
115
113
You can also add a `metadata.xml` and use the GenericSetup dependency mechanism to install other profiles on the fly.
0 commit comments