Skip to content

docs: CORS configuration#9773

Merged
mendonk merged 14 commits into
docs-1.6from
docs-cors-configuration-env-vars
Sep 18, 2025
Merged

docs: CORS configuration#9773
mendonk merged 14 commits into
docs-1.6from
docs-cors-configuration-env-vars

Conversation

@mendonk
Copy link
Copy Markdown
Collaborator

@mendonk mendonk commented Sep 9, 2025

This pull request adds documentation for new CORS-related environment variables and clarifies how to configure cross-origin requests and credentials.
TODO: Add Warning to 1.6 Release Notes for 1.7 changes: that when using wildcard origins, credentials will be automatically disabled.

#9744

@mendonk mendonk self-assigned this Sep 9, 2025
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Sep 9, 2025

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

Documentation updates introduce CORS-related configuration details for authentication, adding LANGFLOW_CORS_ORIGINS and LANGFLOW_CORS_ALLOW_CREDENTIALS to docs. The authentication page includes a new CORS section (duplicated twice). The environment variables page adds both variables to tables with descriptions and examples. No code or API changes.

Changes

Cohort / File(s) Summary of changes
Auth docs CORS section
docs/docs/Configuration/api-keys-and-authentication.mdx
Added a CORS configuration section covering LANGFLOW_CORS_ORIGINS and LANGFLOW_CORS_ALLOW_CREDENTIALS, default behaviors, production guidance, env var examples, and a JWT curl example; note: the entire section appears twice in the file.
Environment variables tables
docs/docs/Configuration/environment-variables.mdx
Added LANGFLOW_CORS_ORIGINS and LANGFLOW_CORS_ALLOW_CREDENTIALS to two env var tables with descriptions, defaults, and example values; documentation-only changes.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Suggested labels

documentation, lgtm

Suggested reviewers

  • jordanrfrazier
  • aimurphy
✨ Finishing touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs-cors-configuration-env-vars

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@mendonk mendonk changed the base branch from main to docs-1.6 September 9, 2025 15:21
@mendonk mendonk requested a review from aimurphy September 9, 2025 15:22
@github-actions github-actions Bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Sep 9, 2025
@github-actions

This comment has been minimized.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (3)
docs/docs/Configuration/api-keys-and-authentication.mdx (1)

1-4: Add required frontmatter description.

Docs must include a description in frontmatter. Add a concise summary for SEO and consistency.

Apply:

 ---
 title: API keys and authentication
 slug: /api-keys-and-authentication
+description: Configure API keys, authentication, and CORS for Langflow in development and production.
 ---
docs/docs/Configuration/environment-variables.mdx (2)

1-4: Add required frontmatter description.

Frontmatter is missing description; include a brief summary.

Apply:

 ---
 title: Environment variables
 slug: /environment-variables
+description: Reference and examples for configuring Langflow using environment variables across environments.
 ---

1-4: Add missing frontmatter description
The frontmatter only includes title and slug—you need to add a description: <brief summary> entry at the top of docs/docs/Configuration/environment-variables.mdx.

🧹 Nitpick comments (2)
docs/docs/Configuration/environment-variables.mdx (2)

198-200: Clarify origin list formatting to avoid parsing issues.

Explicitly note “no spaces” in comma-separated origins; this trips users frequently.

Apply:

-| `LANGFLOW_CORS_ORIGINS` | String | `*` | Comma-separated list of allowed CORS origins. Use `*` for wildcard (credentials automatically disabled for security), or specify specific origins like `https://yourdomain.com,https://anotherdomain.com`. |
+| `LANGFLOW_CORS_ORIGINS` | String | `*` | Comma-separated list of allowed CORS origins (no spaces). Use `*` for wildcard (credentials automatically disabled), or specify origins like `https://yourdomain.com,https://anotherdomain.com`. |

198-199: CORS behavior note (accurate but easy to misread).

“Only works when … not *” is correct; consider adding “per CORS spec, credentials cannot be used with wildcard origins.”

Apply (small wording tweak):

-| `LANGFLOW_CORS_ALLOW_CREDENTIALS` | Boolean | False | Whether to allow credentials such as cookies and authorization headers in CORS requests. Only works when `LANGFLOW_CORS_ORIGINS` is set to specific origins (not `*`). |
+| `LANGFLOW_CORS_ALLOW_CREDENTIALS` | Boolean | False | Whether to allow credentials (cookies, Authorization header) in CORS requests. Per the CORS spec, this only works when `LANGFLOW_CORS_ORIGINS` lists specific origins (not `*`). |
📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4144d76 and a0fe629.

📒 Files selected for processing (2)
  • docs/docs/Configuration/api-keys-and-authentication.mdx (1 hunks)
  • docs/docs/Configuration/environment-variables.mdx (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
docs/docs/**/*.{md,mdx}

📄 CodeRabbit inference engine (.cursor/rules/docs_development.mdc)

docs/docs/**/*.{md,mdx}: All documentation content must be written in Markdown or MDX files located under docs/docs/, following the prescribed directory structure for guides, reference, how-to, concepts, and API documentation.
All documentation Markdown and MDX files must begin with a frontmatter block including at least title and description fields.
Use admonitions (:::tip, :::warning, :::danger) in Markdown/MDX files to highlight important information, warnings, or critical issues.
All images referenced in documentation must include descriptive alt text for accessibility.
All code examples included in documentation must be tested and verified to work as shown.
Internal links in documentation must be functional and not broken.
Content must follow the style guide: professional but approachable tone, second person voice, present tense, short paragraphs, sentence case headers, inline code with backticks, bold for UI elements, italic for emphasis, and parallel structure in lists.
Use consistent terminology: always capitalize Langflow, Component, Flow, and uppercase API and JSON.

Files:

  • docs/docs/Configuration/api-keys-and-authentication.mdx
  • docs/docs/Configuration/environment-variables.mdx
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
  • GitHub Check: Validate PR
  • GitHub Check: Test Docs Build / Test Docs Build
  • GitHub Check: build-and-deploy
🔇 Additional comments (1)
docs/docs/Configuration/api-keys-and-authentication.mdx (1)

316-316: Internal link target exists and resolves correctly.

Comment thread docs/docs/Configuration/api-keys-and-authentication.mdx
Copy link
Copy Markdown
Collaborator

@aimurphy aimurphy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

approved with suggestions

Comment thread docs/docs/Configuration/api-keys-and-authentication.mdx Outdated
Comment thread docs/docs/Configuration/api-keys-and-authentication.mdx Outdated
Comment thread docs/docs/Configuration/api-keys-and-authentication.mdx Outdated
Comment thread docs/docs/Configuration/api-keys-and-authentication.mdx Outdated
Comment thread docs/docs/Configuration/api-keys-and-authentication.mdx Outdated
Comment thread docs/docs/Configuration/api-keys-and-authentication.mdx Outdated
Comment thread docs/docs/Configuration/api-keys-and-authentication.mdx Outdated
Comment thread docs/docs/Configuration/environment-variables.mdx Outdated
@github-actions github-actions Bot added the lgtm This PR has been approved by a maintainer label Sep 9, 2025
@github-actions github-actions Bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Sep 11, 2025
@github-actions

This comment has been minimized.

@github-actions github-actions Bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Sep 11, 2025
@github-actions github-actions Bot removed the documentation Improvements or additions to documentation label Sep 11, 2025
@github-actions github-actions Bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Sep 12, 2025
@github-actions github-actions Bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Sep 12, 2025
@github-actions

This comment has been minimized.

@github-actions github-actions Bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Sep 12, 2025
@github-actions

This comment has been minimized.

Comment thread docs/docs/Configuration/api-keys-and-authentication.mdx Outdated
Comment thread docs/docs/Configuration/environment-variables.mdx Outdated
@github-actions github-actions Bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Sep 17, 2025
@github-actions github-actions Bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Sep 17, 2025
@github-actions

This comment has been minimized.

1 similar comment
@github-actions

This comment has been minimized.

@github-actions github-actions Bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Sep 18, 2025
@sonarqubecloud
Copy link
Copy Markdown

@mendonk mendonk merged commit 31a0a30 into docs-1.6 Sep 18, 2025
15 checks passed
@mendonk mendonk deleted the docs-cors-configuration-env-vars branch September 18, 2025 15:42
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Sep 18, 2025

Build successful! ✅
Deploying docs draft.
Deploy successful! View draft

github-merge-queue Bot pushed a commit that referenced this pull request Sep 26, 2025
* docs: update file size limit to 1024 mb (#9397)

* update-file-size-limit-to-1024-mb

* docs: clarify available API endpoints and their use cases (#9382)

* available-endpoints

* asterisk

* structure-into-tabs-and-confirm-login-endpoint

* reorg and clarify some usage

---------

Co-authored-by: April M <april.murphy@datastax.com>

---------

Co-authored-by: April M <april.murphy@datastax.com>

* add-lfx-kb-agent-struct-out

* update-release-notes

* docs: docling integration into file component (#9481)

* init

* ui-package-manager

* more-content

* components-page

* dependency-included-for-1.6

* remove-package-management-feature

* Apply suggestions from code review

Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>

* clarify-file-extension-behavior

* config-dir-not-in-1.6

* clarify-outputs

* add-links-andupdate-parameters

* more-params

* clarify-supported-filetypes

* installation-in-bundle

* Apply suggestions from code review

Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>

* Apply suggestions from code review

---------

Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>

* docs: Traceloop SDK integration documentation (#9514)

* Added documentation file for langflow-traceloop-instana integration

* updated sidebar.js

* Updated documentation with metrics integration instructions

* Update docs/docs/Integrations/integrations-instana-traceloop.mdx

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* Update docs/docs/Integrations/integrations-instana-traceloop.mdx

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* update doc

* Format correction

* Formatting correction

* Updated Slug title

* style-edit

* Split configure environment variables into steps

* Formatted as per Google developer style guide

* Update docs/docs/Integrations/integrations-instana-traceloop.mdx

Co-authored-by: Edwin Jose <edwinjose900@gmail.com>

* More context added on OTLP security

* Added screenshots of Instana dashboards

* Updated as per the review comments

* Update docs/docs/Integrations/integrations-instana-traceloop.mdx

Co-authored-by: Mendon Kissling <59585235+mendonk@users.noreply.github.com>

* Update docs/docs/Integrations/integrations-instana-traceloop.mdx

Co-authored-by: Mendon Kissling <59585235+mendonk@users.noreply.github.com>

* Update docs/docs/Integrations/integrations-instana-traceloop.mdx

Co-authored-by: Mendon Kissling <59585235+mendonk@users.noreply.github.com>

* Update docs/docs/Integrations/integrations-instana-traceloop.mdx

Co-authored-by: Mendon Kissling <59585235+mendonk@users.noreply.github.com>

* updated refer documentation links

---------

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: Mendon Kissling <59585235+mendonk@users.noreply.github.com>
Co-authored-by: Edwin Jose <edwinjose900@gmail.com>

* docling-and-traceloop-links-for-release-notes-remove-duplicates

* traceloop-touchup

* add-component-release-notes

* docs: 1.6 knowledge base feature (#9381)

* sidebars-and-content

* add-kb-components

* completed-basic-outline

* updates-and-new-names

* kb-tutorial-content

* Apply suggestions from code review

Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>

* move-component-docs-to-main-page

* code-review

* reorganize-content

* add-link-to-agents

* fix links, create components-kb

* move and revise kb content

* missing import

---------

Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>
Co-authored-by: April M <april.murphy@datastax.com>

* docs: Component documentation updates for 1.6.0 (#9627)

* bundles icon

* component menu and bundle icons

* mcp icon extension

* more bundle icon

* workspace gestures and locking

* mcp server stuff

* fix typo and move serper component

* g-assist edit

* simplify hidden param text and update cohere

* amazon components

* nvidia system assist

* use partial for hidden param text

* fix import, add partial for agent summary

* style changes to prep for separating vector page

* rework llm and embedding model pages

* handle legacy components

* remove memories page

* tools page

* applied partials to vector stores before moving

* move redis and ds, fix links

* astra db component updates

* c vector stores

* traceloop copyedits

* advanced parsing

* elastic page and ocr engine edit

* q-w vector stores

* rest of vector stores

* fix build errors

* Revert "mcp icon extension"

This reverts commit 4d15827.

* unused imports and build errors

* build errors

* better icon reference

* tip edits

* fixing after preview

* more touchup

* small style edits for ts client page

* replicate pr 9676

* fix style

* KB comments

* Update docs/docs/Components/bundles-mongodb.mdx

Co-authored-by: Mendon Kissling <59585235+mendonk@users.noreply.github.com>

---------

Co-authored-by: Mendon Kissling <59585235+mendonk@users.noreply.github.com>

* add deprecated component to release notes

* knowledge and message history

* wording

* legacy components

* capitalization

* docs: OpenAI responses endpoint (#9539)

* init

* more-content-and-examples

* cleanup

* add-response-tabs-and-streaming-example

* Apply suggestions from code review

Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>

* requires-agent-component-to-emit-message

* [autofix.ci] apply automated fixes

* test-and-explain-more

* global-var-and-fallback

* bash-not-curl-codeblock

* tighten-up-intro-para

* add-entry-to-concepts-publish-page

* Apply suggestions from code review

Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>

* fix-merge-mistake

* flow-id-or-endpoint-name

* reformat

* Apply suggestions from code review

Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>

* standardize-table-codefont

---------

Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>

* fix build

* code rabbit comments

* docs: remove knowledge base content from 1.6 (#9784)

* remove-kb-content

* broken links

* random change to restart build

---------

Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>
Co-authored-by: April M <april.murphy@datastax.com>

* docs: update composio bundle page (#9442)

* update-composio-integrations

* update-doc-to-be-general

* trailing-space

* add-tool-script

* Apply suggestions from code review

Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>

* global-variable

* Apply suggestions from code review

Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>

* reorder-steps-and-move-script

* clarify-connection

* [autofix.ci] apply automated fixes

* [autofix.ci] apply automated fixes (attempt 2/3)

* [autofix.ci] apply automated fixes (attempt 3/3)

* tools slug/name

* test composio steps

* remove unnecessary import

* Apply suggestions from code review

Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>

---------

Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
Co-authored-by: April M <april.murphy@datastax.com>

* chore: small misses and sync with 9-Sep-25 release build (#9792)

* io page

* fix slug

* custom models and canvas controls

* message history

* composio slack

* move a flow

* vlm option for docling

* docs: add oauth for mcp (#9626)

* oauth-and-none-options

* mcp-composer-for-server

* updates-from-testing

* Apply suggestions from code review

Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>

* clarify-client-update

* Apply suggestions from code review

Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>

* code-review

* clarify-oauth-values

* Apply suggestions from code review

Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>

* code-review

* double-words

---------

Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>

* docs: include guidance for openai client dummy key (#9871)

* test-client-calls

* less-prose

* clearer-intro

* Apply suggestions from code review

Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>

* remove-indentation-and-correct-example-key-value

* comment-syntax

---------

Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>

* docs: mcp tools troubleshooting (#9866)

* move-mcp-troubleshooting-from-server-page-and-add-issue

* Apply suggestions from code review

Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>

* Apply suggestions from code review

* Apply suggestions from code review

Co-authored-by: Lucas Oliveira <62335616+lucaseduoli@users.noreply.github.com>

---------

Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>
Co-authored-by: Lucas Oliveira <62335616+lucaseduoli@users.noreply.github.com>

* docs: auth changes (#9731)

* initial-content

* Apply suggestions from code review

Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>

* code-review

* Apply suggestions from code review

---------

Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>

* docs: CORS configuration (#9773)

* initial-content

* title

* clarify-default

* cleanup

* cors-defaults-with-warning-for-1.7

* docs-and-code-review

* clarify-cors-in-future-release

* code-review

* developer mode for docling

* auto login

* cors

* auth variables

* environment variables pt 1

* env var pt 2

* env var pt 3

* env var pt 5

* align CLI page with env var

* autologin

* docs: clarify log format behavior (#9945)

clarify-log-format-behavior

* docling dependency exceptions

---------

Co-authored-by: April M <april.murphy@datastax.com>
Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>
Co-authored-by: Sandesh R <115570766+2getsandesh@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: Edwin Jose <edwinjose900@gmail.com>
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
Co-authored-by: Lucas Oliveira <62335616+lucaseduoli@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation lgtm This PR has been approved by a maintainer

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants