Explain allowed_origin_regex option for headers plugin

[cv65kr]

roadrunner-server/headers#64

Summary by CodeRabbit

• Documentation
  • Introduced allowed_origin_regex option in CORS headers configuration for more flexible specification of allowed origins.

[coderabbitai]

Walkthrough

The recent update introduces a new option allowed_origin_regex in the CORS headers configuration. This feature enhances flexibility by allowing the specification of a regular expression pattern for permitted origins, overriding the allowed_origin value when set.

Changes

File	Summary
.../http/headers.md	Introduced allowed_origin_regex option in CORS headers configuration. This allows specifying a regex pattern for allowed origins, providing more flexibility. If set, it overrides the allowed_origin value.

Poem

🍂 As the autumn leaves fall, so do the old ways, 🍁

A new dawn breaks with the allowed_origin_regex phrase. 🌅

No longer bound by a single origin's maze, 🌐

We dance in the flexibility of the regex haze. 💃🕺

So here's to the changes, to the new and the bold, 🥂

To a world where our options are no longer controlled. 🌍

As we code through the night, and the coffee gets cold, ☕

We celebrate the new, and respectfully nod to the old. 🎉👴👵

---

Tips

Chat with CodeRabbit Bot (@coderabbitai)

• If you reply to a review comment from CodeRabbit, the bot will automatically respond.
• To engage with CodeRabbit bot directly around the specific lines of code in the PR, mention @coderabbitai in your review comment
• Note: Review comments are made on code diffs or files, not on the PR overview.
• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai help to get help.
• @coderabbitai resolve to resolve all the CodeRabbit review comments.

Note: For conversation with the bot, please use the review comments on code diffs or files.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between a7ee48c and a1ab2e2.

Files selected for processing (1)

• docs/en/http/headers.md (1 hunks)

Additional comments: 1

docs/en/http/headers.md (1)

• 16-23: The new allowed_origin_regex option provides more flexibility in specifying allowed origins. Ensure that the regular expression pattern is correctly set to match the desired origins. Also, remember that when allowed_origin_regex is set, the allowed_origin value is ignored. This change is well documented and should be clear to users.