docs: refresh variables pages#9748
Conversation
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the WalkthroughAdds new documentation sections for configuring file management, flows, and MCP server via environment variables; overhauls the environment variables reference with categorized sections; updates global variables docs to use a new EnvGlobalVars partial and revised guidance; adds an auth variable (LANGFLOW_NEW_USER_IS_ACTIVE); and introduces a reusable partial. Changes
Sequence Diagram(s)Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Possibly related PRs
Suggested labels
Suggested reviewers
✨ Finishing touches🧪 Generate unit tests
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. Comment |
github-actions
Bot
added
the
documentation
This comment has been minimized.
This comment has been minimized.
github-actions
Bot
added
documentation
This comment has been minimized.
This comment has been minimized.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
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/Concepts/concepts-file-management.mdx (1)
123-126: Fix: refer to the correct config mechanism for max file size.It’s an environment variable (or a CLI flag), not an “environment variable” named as a flag.
Apply:
-By default, the maximum file size is 100 MB. -To modify this value, change the `--max-file-size-upload` [environment variable](/environment-variables). +By default, the maximum file size is 100 MB. +To modify this value, set the `LANGFLOW_MAX_FILE_SIZE_UPLOAD` environment variable or pass the `--max-file-size-upload` CLI flag. See [Environment Variables](/environment-variables).docs/docs/Configuration/api-keys-and-authentication.mdx (1)
269-278: Remove duplicate “LANGFLOW_NEW_USER_IS_ACTIVE” section.Duplicate content risks divergence; keep the earlier section and the table entry.
Apply:
-### LANGFLOW_NEW_USER_IS_ACTIVE {#langflow-new-user-is-active} - -When `LANGFLOW_NEW_USER_IS_ACTIVE=False` (default), a superuser must explicitly activate a new user's account before they can sign in to the visual editor. -The superuser can also deactivate a user's account as needed. - -When `LANGFLOW_NEW_USER_IS_ACTIVE=True`, new user accounts are automatically activated. - -```text -LANGFLOW_NEW_USER_IS_ACTIVE=False -``` - -Only superusers can manage user accounts for a Langflow server, but user management only matters if your server has authentication enabled. -For more information, see [Start a Langflow server with authentication enabled](#start-a-langflow-server-with-authentication-enabled).docs/docs/Configuration/configuration-global-variables.mdx (1)
76-81: Fix broken internal anchor.The link target doesn’t exist on the env vars page. Point to the category section.
Apply:
-You can use the `LANGFLOW_VARIABLES_TO_GET_FROM_ENVIRONMENT` [environment variable](/environment-variables#langflow-variables-to-get-from-environment) to source custom global variables from your runtime environment. +You can use the `LANGFLOW_VARIABLES_TO_GET_FROM_ENVIRONMENT` [environment variable](/environment-variables#global-variables-and-environment-integration) to source custom global variables from your runtime environment.
🧹 Nitpick comments (4)
docs/docs/Concepts/concepts-file-management.mdx (1)
132-141: New “File management configuration” section reads well. One open detail.Consider listing accepted values for
LANGFLOW_STORAGE_TYPE(e.g., local, s3, gcs) or link to the authoritative list if it varies by build.docs/docs/Concepts/mcp-server.mdx (1)
330-331: Check link target exists.Confirm
/mcp-component-astraresolves; if not, update or remove.docs/docs/Concepts/concepts-flows.mdx (1)
116-118: Clarify what LANGFLOW_LOG_FILE controls.It configures the general log file path, not a “flow log storage location.”
Apply:
-The overall storage location can be customized with the `LANGFLOW_CONFIG_DIR` environment variable, and the flow log storage location can be customized separately with the `LANGFLOW_LOG_FILE` environment variable. +The overall storage location can be customized with the `LANGFLOW_CONFIG_DIR` environment variable, and the log file path can be customized separately with the `LANGFLOW_LOG_FILE` environment variable.docs/docs/Configuration/environment-variables.mdx (1)
205-209: Type nit: Redis port should be an Integer.Match other port fields and avoid quoting numeric values.
Apply:
-| `LANGFLOW_REDIS_PORT` | String | `6379` | Redis port for cache. See `LANGFLOW_CACHE_TYPE`. | +| `LANGFLOW_REDIS_PORT` | Integer | `6379` | Redis port for cache. See `LANGFLOW_CACHE_TYPE`. |
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (7)
docs/docs/Concepts/concepts-file-management.mdx(3 hunks)docs/docs/Concepts/concepts-flows.mdx(2 hunks)docs/docs/Concepts/mcp-server.mdx(2 hunks)docs/docs/Configuration/api-keys-and-authentication.mdx(3 hunks)docs/docs/Configuration/configuration-global-variables.mdx(6 hunks)docs/docs/Configuration/environment-variables.mdx(5 hunks)docs/docs/_partial-env-global-vars.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/_partial-env-global-vars.mdxdocs/docs/Concepts/concepts-file-management.mdxdocs/docs/Concepts/mcp-server.mdxdocs/docs/Configuration/api-keys-and-authentication.mdxdocs/docs/Concepts/concepts-flows.mdxdocs/docs/Configuration/configuration-global-variables.mdxdocs/docs/Configuration/environment-variables.mdx
🧠 Learnings (2)
📚 Learning: 2025-07-23T21:19:22.567Z
Learnt from: deon-sanchez
PR: langflow-ai/langflow#9158
File: src/backend/base/langflow/api/v1/mcp_projects.py:404-404
Timestamp: 2025-07-23T21:19:22.567Z
Learning: In langflow MCP projects configuration, prefer using dynamically computed URLs (like the `sse_url` variable) over hardcoded localhost URLs to ensure compatibility across different deployment environments.
Applied to files:
docs/docs/Concepts/mcp-server.mdxdocs/docs/Configuration/environment-variables.mdx
📚 Learning: 2025-07-18T18:26:42.027Z
Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-07-18T18:26:42.027Z
Learning: Applies to docs/docs/**/*.{md,mdx} : Use consistent terminology: always capitalize Langflow, Component, Flow, and uppercase API and JSON.
Applied to files:
docs/docs/Concepts/concepts-flows.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). (2)
- GitHub Check: build-and-deploy
- GitHub Check: Test Docs Build / Test Docs Build
🔇 Additional comments (17)
docs/docs/Concepts/concepts-file-management.mdx (1)
63-63: Good clarification about runtime tweaks payload.The added sentence clearly sets reader expectations before the snippet.
docs/docs/Configuration/api-keys-and-authentication.mdx (2)
177-185: Add: LANGFLOW_NEW_USER_IS_ACTIVE — looks good but avoid duplicate section below.This block is clear; keep this one as the canonical description.
Note: There’s a second “LANGFLOW_NEW_USER_IS_ACTIVE” section later (Lines 269–278). Remove the duplicate to avoid drift.
368-383: Auth variables table addition is consistent and helpful.The new entry for
LANGFLOW_NEW_USER_IS_ACTIVEaligns with the narrative above.docs/docs/Concepts/mcp-server.mdx (2)
196-211: Verify mcp-proxy header flag usage.Double-check whether the flag is
--headersvs--headerand the exact argument shape expected by mcp-proxy for passingx-api-key.
332-343: MCP server configuration section LGTM.Defaults and descriptions are concise; links back to the env-var index are correct.
docs/docs/Concepts/concepts-flows.mdx (1)
126-141: Flow configuration table is coherent and well-scoped.Good cross-link to the consolidated env vars page.
docs/docs/_partial-env-global-vars.mdx (1)
1-10: Partial content is clear. Confirm frontmatter policy for partials.Docusaurus usually doesn’t require frontmatter for included partials, but confirm our docs linter doesn’t enforce it under
docs/docs/.docs/docs/Configuration/configuration-global-variables.mdx (4)
9-9: Importing the EnvGlobalVars partial is a good reuse.
16-17: Inline partial placement LGTM.
61-63: Deletion semantics clarified — good.Clear warning that flows referencing the deleted variable will fail.
Also applies to: 72-72
171-174: Deferring definitive list to code is fine.Linking to constants.py reduces drift.
docs/docs/Configuration/environment-variables.mdx (6)
16-16: Good reuse of the EnvGlobalVars partial.
28-31: Precedence examples are clear and accurate.
151-183: Category scaffolding and cross-links read well.Nice organization; anchors match cross-references elsewhere.
228-244: File/data management section aligns with Concepts page.
LANGFLOW_STORAGE_TYPEand size limit entries match the new concepts doc.
268-275: Confirm fallback variable name consistency across pages.This page uses
LANGFLOW_FALLBACK_TO_ENV_VAR. Ensure other pages (global variables) use the same name (see suggested fix there).
324-359: .env example updates look correct and helpful.Inclusion of Store URL, MCP, and logging toggles is useful.
github-actions
Bot
added
documentation
* initial-sizing * Clean up table styling and remove duplicated rules * fix: Reduce table font size, remove scrollbar --------- Co-authored-by: Jonathan Kurten <kurtenj@gmail.com>
This comment has been minimized.
This comment has been minimized.
github-actions
Bot
added
documentation
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
github-actions
Bot
added
documentation
This comment has been minimized.
This comment has been minimized.
github-actions
Bot
added
documentation
This comment has been minimized.
This comment has been minimized.
github-actions
Bot
added
documentation
This comment has been minimized.
This comment has been minimized.
github-actions
Bot
added
documentation
This comment has been minimized.
This comment has been minimized.
github-actions
Bot
added
documentation
This comment has been minimized.
This comment has been minimized.
|
|
Build successful! ✅ |
3 participants
Preview
Refresh the environment variables pages and make them more digestible.
For the updating of the CSS for the table, see #9732 (merged into this branch)
Summary by CodeRabbit