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/reference/configuration.md
+16-16Lines changed: 16 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -92,7 +92,7 @@ The possible values are:
92
92
93
93
* `bedrock` for [Bedrock][1] projects
94
94
* `radicle` for [Radicle][18] projects
95
-
* `wordpress` for WordPress projects
95
+
* `wordpress` for standard WordPress projects
96
96
97
97
### environments
98
98
@@ -154,10 +154,10 @@ The custom CloudFront cache policy used for assets and uploads. Setting this opt
154
154
155
155
**type**: `string | false`
156
156
157
-
The custom CloudFront cache policy used for the WordPress site content. Setting this option to `false` removes the cache policy and reverts back to use the legacy CloudFront cache configuration.
157
+
The custom CloudFront cache policy used for the PHP application content. Setting this option to `false` removes the cache policy and reverts back to use the legacy CloudFront cache configuration.
158
158
159
159
::: warning Overrides CDN options
160
-
If you decide to use a custom CloudFront cache policy for your WordPress site content, the following `cdn` options won't apply anymore: `cookies_whitelist`, `default_expiry` and `forwarded_headers`.
160
+
If you decide to use a custom CloudFront cache policy for your PHP application content, the following `cdn` options won't apply anymore: `cookies_whitelist`, `default_expiry` and `forwarded_headers`.
161
161
:::
162
162
163
163
#### caching
@@ -173,7 +173,7 @@ The possible values are:
173
173
* `disabled` disables CloudFront distribution caching
174
174
175
175
::: warning Provisioning delay
176
-
Switching the `caching` value to `enabled` can cause your WordPress site to not load certain assets while the CloudFront distribution updates. This process can take as long as 40 minutes.
176
+
Switching the `caching` value to `enabled` can cause your PHP application to not load certain assets while the CloudFront distribution updates. This process can take as long as 40 minutes.
177
177
:::
178
178
179
179
::: warning Full CloudFront caching disabled with REST API
@@ -184,7 +184,7 @@ If you have the `caching` set to `enabled` and the `gateway` option set to `rest
The list of cookies ignored by CloudFront and always forwarded to your WordPress site. Supports `*` wildcard character.
187
+
The list of cookies ignored by CloudFront and always forwarded to your PHP application. Supports `*` wildcard character.
188
188
189
189
::: tip Default cookies always added
190
190
The default cookies to whitelist will always be added to your project configuration during deployment. So if you need to customize the `cookies_whitelist` option, you can omit them.
@@ -200,7 +200,7 @@ The default time (in seconds) that CloudFront will keep something cached.
The list of paths ignored by CloudFront and always forwarded to your WordPress site. Supports `*` wildcard character.
203
+
The list of paths ignored by CloudFront and always forwarded to your PHP application. Supports `*` wildcard character.
204
204
205
205
::: tip Default paths always added
206
206
The default paths to exclude will always be added to your project configuration during deployment. So if you need to customize the `excluded_paths` option, you can omit them.
@@ -211,17 +211,17 @@ By default, CloudFront caches files in the `/uploads` directory for 24h. But som
211
211
:::
212
212
213
213
::: tip Tailored to all project types
214
-
The project `type` will change default paths for non-WordPress projects. So you don't need to edit this for `bedrock` or `radicle` projects.
214
+
The project `type` will change default paths for other project types. So you don't need to edit this for `bedrock` or `radicle` projects.
215
215
:::
216
216
217
217
#### forwarded_headers
218
218
219
219
**type**: `array` **default**: `['origin']`
220
220
221
-
The list of headers that the CloudFront distribution will forward to your WordPress site.
221
+
The list of headers that the CloudFront distribution will forward to your PHP application.
222
222
223
223
::: warning 10 header limit
224
-
CloudFront can only forward 10 headers to your WordPress site.
224
+
CloudFront can only forward 10 headers to your PHP application.
225
225
:::
226
226
227
227
#### functions_assets
@@ -234,7 +234,7 @@ The list of CloudFront functions to associate with CloudFront origin used for as
234
234
235
235
**type**: `array`
236
236
237
-
The list of CloudFront functions to associate with CloudFront origin used for the WordPress site content. Each array entry must have a `name` and a `type`. The `name` is the name of the CloudFront function on AWS. Meanwhile, `type` can be either `viewer-request` or `viewer-response`.
237
+
The list of CloudFront functions to associate with CloudFront origin used for the PHP application content. Each array entry must have a `name` and a `type`. The `name` is the name of the CloudFront function on AWS. Meanwhile, `type` can be either `viewer-request` or `viewer-response`.
238
238
239
239
#### invalidate_paths
240
240
@@ -279,7 +279,7 @@ Looking for more information on how to configure your environment for high `conc
279
279
:::
280
280
281
281
::: warning Overwhelming your database server
282
-
If your `concurrency` values are too high or disabled, your database server could get overwhelmed when spikes hit your application. If this happens, you'll want to increase the capacity of your database server.
282
+
If your `concurrency` values are too high or disabled, your database server could get overwhelmed when spikes hit your PHP application. If this happens, you'll want to increase the capacity of your database server.
283
283
:::
284
284
285
285
### cron
@@ -297,7 +297,7 @@ This is the array of values to configure the environment's database. If the `dat
297
297
298
298
**type**: `string` **default**: `ymir`
299
299
300
-
The name of the database used by the WordPress site.
300
+
The name of the database used by the PHP application.
If you configured the `DB_NAME` environment variable, be aware that Ymir will overwrite it with the `name` value.
@@ -307,7 +307,7 @@ If you configured the `DB_NAME` environment variable, be aware that Ymir will ov
307
307
308
308
**type**: `string`
309
309
310
-
The database server used by the WordPress site. It can be the name of the database server if it's managed by Ymir or the host name of the database server otherwise.
310
+
The database server used by the PHP application. It can be the name of the database server if it's managed by Ymir or the host name of the database server otherwise.
If you configured the `DB_USER` environment variable, be aware that Ymir will overwrite it with the `user` value.
@@ -515,7 +515,7 @@ The number of `website` functions that CloudWatch will keep warmed up. If set to
515
515
516
516
**type**: `array`
517
517
518
-
Configuration for the Lambda function that handles HTTP traffic from your WordPress site. This function is connected to the API gateway and processes all web requests.
518
+
Configuration for the Lambda function that handles HTTP traffic from your PHP application. This function is connected to the API gateway and processes all web requests.
519
519
520
520
#### concurrency
521
521
@@ -557,7 +557,7 @@ The maximum amount of time (in seconds) that the `website` Lambda function can r
557
557
::: warning API gateway timeout
558
558
The 30 second timeout limit when using an API gateway is due to AWS API Gateway limits. This cannot be modified.
559
559
560
-
This can be a significant technical hurdle if your WordPress site has long-running operations that take more than 30 seconds to complete. In that scenario, these operations should be offloaded to a WP-CLI command (using the `console` function) or an external service.
560
+
This can be a significant technical hurdle if your PHP application has long-running operations that take more than 30 seconds to complete. In that scenario, these operations should be offloaded to a WP-CLI command (using the `console` function) or an external service.
0 commit comments