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
+36-34Lines changed: 36 additions & 34 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -58,7 +58,7 @@ environments:
58
58
console:
59
59
memory: 1024
60
60
timeout: 60
61
-
queues:
61
+
queues:
62
62
default:
63
63
concurrency: 10
64
64
memory: 1024
@@ -271,8 +271,9 @@ Flag whether the CloudFront distribution will be configured with the Lambda@Edge
271
271
The environment-level default concurrency value that is inherited by `website` and `queue` functions. This option controls the maximum number of Lambda functions that can exist at the same time for each function type. (AWS calls this [reserved concurrency][2].) Setting this option to `false` removes the limit and allows unrestricted scaling.
272
272
273
273
Individual function types can override this default by specifying their own `concurrency` value:
274
-
- `website`functions inherit this value by default
275
-
- `queue`functions inherit this value by default
274
+
275
+
* `website` functions inherit this value by default
276
+
* `queue` functions inherit this value by default
276
277
277
278
::: tip Check out the guide
278
279
Looking for more information on how to configure your environment for high `concurrency` values? Check out this [guide][10].
@@ -283,6 +284,7 @@ If your `concurrency` values are too high or disabled, your database server coul
283
284
:::
284
285
285
286
### cron
287
+
286
288
**type**: `int | false` **default**: `1`
287
289
288
290
The interval (in minutes) that [WP-Cron][3] gets called by CloudWatch. Also controls the `DISABLE_WP_CRON` constant. If set to `false`, it disables the CloudWatch rule and renables the standard WP-Cron behaviour.
@@ -385,23 +387,23 @@ If you decide to use a custom web ACL as your environment's firewall, Ymir will
385
387
386
388
The list of bot categories that you want the firewall to protect against. Below is the list of available categories you may use. If you want to enable all bot categories, you may use `true` instead of listing all categories.
387
389
388
-
| Category | Description |
389
-
| --- | --- |
390
-
| CategoryAdvertising | Bots used for advertising purposes |
391
-
| CategoryArchiver | Bots used for archiving purposes |
392
-
| CategoryContentFetcher | Bots fetching content on behalf of an end-user |
393
-
| CategoryHttpLibrary | HTTP libraries often used by bots |
394
-
| CategoryLinkChecker | Bots that check for broken links |
395
-
| CategoryMiscellaneous | Miscellaneous bots |
396
-
| CategoryMonitoring | Bots used for monitoring purposes |
397
-
| CategoryScrapingFramework | Web scraping frameworks |
398
-
| CategorySecurity | Security\-related bots |
399
-
| CategorySeo | Bots used for search engine optimization |
400
-
| CategorySocialMedia | Bots used by social media platforms to provide content summaries (Verified social media bots are not blocked) |
401
-
| CategorySearchEngine | Search engine bots (Verified search engines are not blocked) |
402
-
| SignalAutomatedBrowser | Automated web browser |
403
-
| SignalKnownBotDataCenter | Data centers typically used by bots |
404
-
| SignalNonBrowserUserAgent | User-agent strings that don't seem to be from a web browser |
| CategoryAdvertising | Bots used for advertising purposes |
393
+
| CategoryArchiver | Bots used for archiving purposes |
394
+
| CategoryContentFetcher | Bots fetching content on behalf of an end-user |
395
+
| CategoryHttpLibrary | HTTP libraries often used by bots |
396
+
| CategoryLinkChecker | Bots that check for broken links |
397
+
| CategoryMiscellaneous | Miscellaneous bots |
398
+
| CategoryMonitoring | Bots used for monitoring purposes |
399
+
| CategoryScrapingFramework | Web scraping frameworks |
400
+
| CategorySecurity | Security\-related bots |
401
+
| CategorySeo | Bots used for search engine optimization |
402
+
| CategorySocialMedia | Bots used by social media platforms to provide content summaries (Verified social media bots are not blocked) |
403
+
| CategorySearchEngine | Search engine bots (Verified search engines are not blocked) |
404
+
| SignalAutomatedBrowser | Automated web browser |
405
+
| SignalKnownBotDataCenter | Data centers typically used by bots |
406
+
| SignalNonBrowserUserAgent | User-agent strings that don't seem to be from a web browser |
405
407
406
408
::: warning Additional cost
407
409
AWS WAF bot protection is an additional cost on top of your existing AWS WAF bill. It costs $10/month and $1.00 per 1 million requests. You can read more on the [AWS WAF pricing page][7].
@@ -413,13 +415,13 @@ AWS WAF bot protection is an additional cost on top of your existing AWS WAF bil
413
415
414
416
Flag that determines whether the firewall will be configured with some default AWS managed firewall rules. Below, you'll find the list of managed rules that Ymir will configure if you set this to `true`. If set to `false`, no managed rules will get configured and you can configure some yourself. You can read more about them [here][8].
415
417
416
-
| Managed Rule | Description |
417
-
| --- | --- |
418
-
| AWSManagedRulesAmazonIpReputationList | Amazon IP reputation list rule group contains rules that are based on Amazon internal threat intelligence |
419
-
| AWSManagedRulesKnownBadInputsRuleSet | Known bad inputs rule group contains rules to block request patterns that are known to be invalid and are associated with exploitation or discovery of vulnerabilities |
420
-
| AWSManagedRulesPHPRuleSet | PHP application rule group contains rules that block request patterns associated with the exploitation of vulnerabilities specific to the use of the PHP programming language, including injection of unsafe PHP functions |
421
-
| AWSManagedRulesSQLiRuleSet | SQL database rule group contains rules to block request patterns associated with exploitation of SQL databases, like SQL injection attacks |
422
-
| AWSManagedRulesWordPressRuleSet | WordPress application rule group contains rules that block request patterns associated with the exploitation of vulnerabilities specific to WordPress sites |
| AWSManagedRulesAmazonIpReputationList | Amazon IP reputation list rule group contains rules that are based on Amazon internal threat intelligence |
421
+
| AWSManagedRulesKnownBadInputsRuleSet | Known bad inputs rule group contains rules to block request patterns that are known to be invalid and are associated with exploitation or discovery of vulnerabilities |
422
+
| AWSManagedRulesPHPRuleSet | PHP application rule group contains rules that block request patterns associated with the exploitation of vulnerabilities specific to the use of the PHP programming language, including injection of unsafe PHP functions |
423
+
| AWSManagedRulesSQLiRuleSet | SQL database rule group contains rules to block request patterns associated with exploitation of SQL databases, like SQL injection attacks |
424
+
| AWSManagedRulesWordPressRuleSet | WordPress application rule group contains rules that block request patterns associated with the exploitation of vulnerabilities specific to WordPress sites |
423
425
424
426
#### rate_limit
425
427
@@ -431,7 +433,7 @@ Enables a rate limit rule that blocks requests from IPs that have made more than
431
433
432
434
**type**: `string | false` **default**: `http`
433
435
434
-
The gateway type used by the environment. Allowed values are `http` for HTTP APIs, `rest` for REST APIs or `false` to use [Lambda function URLs][12] instead of a gateway.
436
+
The gateway type used by the environment. Allowed values are `http` for HTTP APIs, `rest` for REST APIs or `false` to use [Lambda function URLs][12] instead of a gateway.
435
437
436
438
::: danger DNS changes when switching gateway types
437
439
Whenever you switch gateway types, the DNS records pointing to your environment will change. If Ymir manages the DNS zone used by your environment, it'll update your DNS records automatically. Otherwise, you will have to do it yourself. That said, even with a managed DNS zone, your environment will be briefly unavailable while the DNS changes propagate.
@@ -551,8 +553,8 @@ Lambda charges based on configured memory. More memory means a higher Lambda bil
551
553
552
554
The maximum amount of time (in seconds) that the `website` Lambda function can run before Lambda terminates it. The maximum allowed timeout depends on your gateway configuration:
553
555
554
-
- **With API Gateway** (`gateway: http` or `gateway: rest`): Maximum 30 seconds
555
-
- **Without API Gateway** (`gateway: false`): Maximum 900 seconds (15 minutes)
556
+
* **With API Gateway** (`gateway: http` or `gateway: rest`): Maximum 30 seconds
557
+
* **Without API Gateway** (`gateway: false`): Maximum 900 seconds (15 minutes)
556
558
557
559
::: warning API gateway timeout
558
560
The 30 second timeout limit when using an API gateway is due to AWS API Gateway limits. This cannot be modified.
@@ -597,10 +599,10 @@ Configuration for SQS queue-based Lambda functions used for background job proce
597
599
The `queues` option supports multiple configuration formats for flexibility:
598
600
599
601
```yaml
600
-
# Boolean format - creates default queue
602
+
# Boolean format - creates "default" queue
601
603
queues: true
602
604
603
-
# Single queue format - creates default queue with specific settings
605
+
# Single queue format - creates "default" queue with specific settings
604
606
queues:
605
607
concurrency: 5
606
608
memory: 2048
@@ -660,8 +662,8 @@ Queue functions have much longer timeout capabilities than website functions, ma
660
662
661
663
The type of SQS queue to use for this queue function. The possible values are:
662
664
663
-
* `standard` - Standard SQS queue with high throughput and at-least-once delivery
664
-
* `fifo` - First-In-First-Out queue with exactly-once processing and message ordering
665
+
* `standard` - Standard SQS queue with high throughput and at-least-once delivery
666
+
* `fifo` - First-In-First-Out queue with exactly-once processing and message ordering
665
667
666
668
::: tip FIFO vs Standard queues
667
669
FIFO queues guarantee message ordering and exactly-once delivery but have lower throughput. Standard queues offer higher throughput but may deliver messages more than once and in different orders.
0 commit comments