Skip to content

Commit 59691a3

Browse files
committed
Rebranded VCL and HTTP cache configuration
1 parent 14a39ce commit 59691a3

File tree

4 files changed

+17
-17
lines changed

4 files changed

+17
-17
lines changed

docs/infrastructure_and_maintenance/cache/http_cache/content_aware_cache.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -565,7 +565,7 @@ Server: nginx/1.27.0
565565
Content-Type: text/html; charset=UTF-8
566566
Transfer-Encoding: chunked
567567
Connection: keep-alive
568-
Set-Cookie: eZSESSID21232f297a57a5a743894a0e4a801fc3=asrpqgmh5ll5ssseca3cov8er7; path=/; HttpOnly; SameSite=lax
568+
Set-Cookie: IBX_SESSION_ID21232f297a57a5a743894a0e4a801fc3=asrpqgmh5ll5ssseca3cov8er7; path=/; HttpOnly; SameSite=lax
569569
Cache-Control: public, s-maxage=86400
570570
Date: Wed, 01 Sep 2021 07:51:40 GMT
571571
Vary: Origin

docs/infrastructure_and_maintenance/cache/http_cache/context_aware_cache.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ public function addPreferenceHash(FilterResponseEvent $event)
154154
2\. Adapt VCL logic to pass the header to requests:
155155

156156
```diff
157-
@@ -174,6 +174,7 @@ sub ez_user_context_hash {
157+
@@ -174,6 +174,7 @@ sub ibexa_user_context_hash {
158158
if (req.restarts == 0
159159
&& (req.http.accept ~ "application/vnd.fos.user-context-hash"
160160
|| req.http.X-Context-User-Hash

docs/infrastructure_and_maintenance/cache/http_cache/fastly.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,8 @@ You also need to set up domains, HTTPS and origin configuration (not covered her
4747
All commands are explained in detail [below](#view-and-modify-vcl-configuration):
4848

4949
``` bash
50-
fastly vcl custom create --name=ez_main.vcl --version=active --autoclone --content=vendor/ibexa/fastly/fastly/ez_main.vcl --main
51-
fastly vcl custom create --name=ez_user_hash.vcl --content=vendor/ibexa/fastly/fastly/ez_user_hash.vcl --version=latest
50+
fastly vcl custom create --name=ibexa_main.vcl --version=active --autoclone --content=vendor/ibexa/fastly/fastly/ibexa_main.vcl --main
51+
fastly vcl custom create --name=ibexa_user_hash.vcl --content=vendor/ibexa/fastly/fastly/ibexa_user_hash.vcl --version=latest
5252
fastly vcl snippet create --name="Re-Enable shielding on restart" --version=latest --priority 100 --type recv --content=vendor/ibexa/fastly/fastly/snippet_re_enable_shielding.vcl
5353
fastly service-version activate --version=latest
5454
```
@@ -117,30 +117,30 @@ fastly service-version activate --version=latest
117117

118118
Fastly configuration is stored in Varnish Configuration Language (VCL) files.
119119
You can change the behaviour of Fastly by [uploading custom VCL files](https://docs.fastly.com/en/guides/uploading-custom-vcl).
120-
[[= product_name =]] ships with two VCL files that need to be enabled for Fastly to work correctly with the platform; `ez_main.vcl` and `ez_user_hash.vcl` (located in `vendor/ibexa/fastly/fastly/`)
120+
[[= product_name =]] ships with two VCL files that need to be enabled for Fastly to work correctly with the platform; `ibexa_main.vcl` and `ibexa_user_hash.vcl` (located in `vendor/ibexa/fastly/fastly/`)
121121

122122
### List custom `.vcl` files for specific version
123123

124124
``` bash
125125
fastly vcl custom list --version 77
126126
SERVICE ID VERSION NAME MAIN
127-
4SEKDky8P3wdrctwZCi1C1 77 ez_main.vcl true
128-
4SEKDky8P3wdrctwZCi1C1 77 ez_user_hash.vcl false
127+
4SEKDky8P3wdrctwZCi1C1 77 ibexa_main.vcl true
128+
4SEKDky8P3wdrctwZCi1C1 77 ibexa_user_hash.vcl false
129129
```
130130

131-
### Get `ez_main.vcl` for specific version
131+
### Get ibexa_main.vcl for specific version
132132

133133
``` bash
134-
fastly vcl custom describe --name=ez_main.vcl --version=77
134+
fastly vcl custom describe --name=ibexa_main.vcl --version=77
135135

136136
Service ID: 4SEKDky8P3wdrctwZCi1C1
137137
Service Version: 77
138138

139-
Name: ez_main.vcl
139+
Name: ibexa_main.vcl
140140
Main: true
141141
Content:
142142

143-
include "ez_user_hash.vcl"
143+
include "ibexa_user_hash.vcl"
144144

145145
sub vcl_recv {
146146
(....)
@@ -198,7 +198,7 @@ You can modify the existing Fastly configuration, for example, by uploading a mo
198198
Create a new version based on the one that is currently active, and upload the file:
199199
200200
``` bash
201-
fastly vcl custom update --name=ez_main.vcl --version=active --autoclone --content=vendor/ibexa/fastly/fastly/ez_main.vcl
201+
fastly vcl custom update --name=ibexa_main.vcl --version=active --autoclone --content=vendor/ibexa/fastly/fastly/ibexa_main.vcl
202202
```
203203
204204
Provide a description of the change in Fastly's version system:
@@ -220,7 +220,7 @@ You do it by creating [snippets](https://docs.fastly.com/en/guides/about-vcl-sni
220220
it's recommended that you use snippets instead of changing the VCL files provided by [[= product_name =]] as much as possible, which makes it easier to upgrade the [[= product_name =]] VCL configuration later.
221221
222222
When you use snippets, the snippet code is injected into the VCL where the `#FASTLY ...` macros are placed.
223-
For example, if you create a snippet for the `recv` subroutine, it's injected into the `ez_main.vcl` file, the
223+
For example, if you create a snippet for the `recv` subroutine, it's injected into the `ibexa_main.vcl` file, the
224224
line where `#FASTLY recv` is found.
225225
226226
### List available snippets for specific version
@@ -232,7 +232,7 @@ KlUh0J1fnw1JY1aEQ0up 8 Re-Enable shielding on restart false 1iJWIf
232232
```
233233
234234
!!! note
235-
As of version 3.3.24, 4.1.6 and 4.2.0, [[= product_name =]] also requires one snippet to be installed, in addition to the custom VCLs `ez_main.vcl` and `ez_user_hash.vcl`. That snippet is by default named `Re-Enable shielding on restart`.
235+
As of version 3.3.24, 4.1.6 and 4.2.0, [[= product_name =]] also requires one snippet to be installed, in addition to the custom VCLs `ibexa_main.vcl` and `ibexa_user_hash.vcl`. That snippet is by default named `Re-Enable shielding on restart`.
236236
237237
### Get details of installed snippets
238238

docs/infrastructure_and_maintenance/cache/http_cache/reverse_proxy.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,8 @@ For reverse proxies to work properly with your installation, you need to add the
4949

5050
- [Varnish VCL xkey example](https://github.com/ibexa/http-cache/blob/main/docs/varnish/vcl/varnish5.vcl)
5151
- Fastly can be found in `vendor/ibexa/fastly/fastly`. You must install the following to use Fastly:
52-
- `ez_main.vcl` as the **main** custom VCL
53-
- `ez_user_hash.vcl` as another custom VCL
52+
- `ibexa_main.vcl` as the **main** custom VCL
53+
- `ibexa_user_hash.vcl` as another custom VCL
5454
- `snippet_re_enable_shielding.vcl` as snippet
5555

5656
The provided `.vcl` files work both with [Fastly Shielding](https://docs.fastly.com/en/guides/shielding) enabled and without it.
@@ -155,7 +155,7 @@ If you want to use Basic Auth with Fastly on [[= product_name_cloud =]], please
155155

156156
!!! note "Invalidating Varnish cache by using tokens"
157157

158-
In setups where the Varnish server IP can change (for example, on [[= product_name_cloud =]]), you can use token-based cache invalidation through [`ez_purge_acl`](https://github.com/ibexa/http-cache/blob/main/docs/varnish/vcl/varnish5.vcl#L174).
158+
In setups where the Varnish server IP can change (for example, on [[= product_name_cloud =]]), you can use token-based cache invalidation through [`ibexa_purge_acl`](https://github.com/ibexa/http-cache/blob/main/docs/varnish/vcl/varnish5.vcl#L174).
159159

160160
In such situation, use strong, secure hash and make sure to keep the token secret.
161161

0 commit comments

Comments
 (0)