docs: LANGFLOW_ENABLE_SUPERUSER_CLI environment variable#9223
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 WalkthroughDocumentation was updated to clarify the requirements and security implications of creating superusers and API keys via the CLI. A new environment variable, Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes 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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
github-actions
Bot
added
the
documentation
github-actions
Bot
added
documentation
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
docs/docs/Configuration/environment-variables.mdx (1)
207-207: Referenceapi-keycommand & extend examples for completenessThe new row is clear but it omits two practical details that help readers:
LANGFLOW_ENABLE_SUPERUSER_CLI=falsealso disables thelangflow api-keycommand if no superuser exists—worth mentioning next to the existing link to thesuperusercommand.- The variable is not included in any of the subsequent “.env”, systemd or VSCode examples, so users might miss it.
Consider amending the description and adding the variable to the example blocks:
-| Allow creation of superusers via CLI. Set to `false` in production for security.<br/>See [`superuser` command](./configuration-cli.mdx#superuser). | +| Allow creation of superusers via the CLI. Set to `false` in production for security. Disables both <code>langflow superuser</code> and <code>langflow api-key</code> commands if no superuser exists.<br/>See [`superuser` command](./configuration-cli.mdx#superuser) and [`api-key` command](./configuration-cli.mdx#langflow-api-key). |and, in each example block:
LANGFLOW_BACKEND_ONLY=false +# Disable CLI superuser creation in production +# LANGFLOW_ENABLE_SUPERUSER_CLI=false LANGFLOW_BUNDLE_URLS=["https://github.com/user/repo/commit/hash"]docs/docs/Configuration/configuration-cli.mdx (2)
41-44: Use:::warningto highlight potential lock-outBecause disabling the variable can break API-key creation on a running instance, elevating the admonition from note to warning makes the consequence more visible:
-:::note +:::warning API key creation via the CLI … -::: +:::
141-144: Same visibility concern for superuser commandFor consistency with the previous suggestion and to stress the operational impact, switch the admonition type:
-:::note +:::warning If [`LANGFLOW_ENABLE_SUPERUSER_CLI`]… -::: +:::
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
docs/docs/Configuration/configuration-api-keys.mdx(1 hunks)docs/docs/Configuration/configuration-cli.mdx(2 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/configuration-api-keys.mdxdocs/docs/Configuration/environment-variables.mdxdocs/docs/Configuration/configuration-cli.mdx
🧠 Learnings (3)
📓 Common learnings
Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-06-23T12:46:29.953Z
Learning: When writing documentation for Langflow using Docusaurus, always use professional but approachable tone, second person voice for instructions, and present tense for current features.
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.
docs/docs/Configuration/environment-variables.mdx (3)
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.
Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-06-23T12:46:29.953Z
Learning: All terminology such as 'Langflow', 'Component', 'Flow', 'API', and 'JSON' must be capitalized or uppercased as specified in the terminology section.
Learnt from: deon-sanchez
PR: #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.
docs/docs/Configuration/configuration-cli.mdx (3)
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.
Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-06-23T12:46:29.953Z
Learning: When writing documentation for Langflow using Docusaurus, always use professional but approachable tone, second person voice for instructions, and present tense for current features.
Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-06-23T12:46:29.953Z
Learning: All terminology such as 'Langflow', 'Component', 'Flow', 'API', and 'JSON' must be capitalized or uppercased as specified in the terminology section.
⏰ 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). (1)
- GitHub Check: build-and-deploy
🔇 Additional comments (1)
docs/docs/Configuration/configuration-api-keys.mdx (1)
53-55: LGTM – note is concise and follows style guideThe admonition clearly states the requirement and links to the new variable. Tone, second-person voice, and capitalization all match the docs guidelines.
|
Build successful! ✅ |
aimurphy
left a comment
aimurphy
left a comment
There was a problem hiding this comment.
Please see my comments
github-actions
Bot
added
documentation
|
Build successful! ✅ |
SonicDMG
temporarily deployed
to
docs-add-superuser-env-var - langflow-manual-install PR #9223
Render
Destroyed
github-actions
Bot
added
documentation
|
Build successful! ✅ |
github-actions
Bot
added
documentation
|
Build successful! ✅ |
SonicDMG
temporarily deployed
to
docs-add-superuser-env-var - langflow-manual-install PR #9223
Render
Destroyed
github-actions
Bot
added
documentation
|
|
Build successful! ✅ |
aimurphy
left a comment
aimurphy
left a comment
There was a problem hiding this comment.
@mendonk take a look at the preview and then go ahead and merge this if you agree with the changes.
- API keys and authentication:
- Revise CLI tab in create a langflow API key
- Add SUPERUSER_CLI to server setup section
- Add SUPERUSER_CLI subsection under authentication env vars.
- Quick revision of Langflow CLI page:
- Bring usage details to the top of the page, including common options
- Remove common options from the command subsections
- Revise
langflow superusercommand explanation. - Link the
langflow api-keycommand to the "Langflow API keys" section where it fully explains how to create API keys with the CLi.
…#9223) * add-superuser-cli-note-and-env-var * code-review * env-var-link * resolve CLI superuser confusion --------- Co-authored-by: April M <april.murphy@datastax.com>
3 participants
Document new environment variable and add notes to applicable pages to explain the behavior.
#9152
Summary by CodeRabbit
LANGFLOW_ENABLE_SUPERUSER_CLIenvironment variable on superuser and API key management commands.LANGFLOW_ENABLE_SUPERUSER_CLIenvironment variable, including usage recommendations for production environments.