docs: refresh external postgresql database page#9174
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 WalkthroughThe documentation for configuring Langflow with PostgreSQL was revised for clarity and completeness. Updates include improved instructions for local and containerized setups, expanded prerequisites, clearer connection string guidance, corrected command usage, reorganized Docker Compose guidance, and enhanced multi-instance deployment instructions. No code or public entity changes were made. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Suggested labels
✨ 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
documentation
|
Build successful! ✅ |
![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
🔭 Outside diff range comments (1)
docs/docs/Configuration/configuration-custom-database.mdx (1)
1-4: Add the mandatorydescriptionfield to the front-matter.Documentation pages must include at least
titleanddescriptionin the front-matter per the docs guidelines.
Add a concise sentence that summarises the page content.--- title: Configure an external PostgreSQL database slug: /configuration-custom-database +description: Learn how to replace Langflow’s default SQLite database with PostgreSQL in local and containerised environments. ---
🧹 Nitpick comments (3)
docs/docs/Configuration/configuration-custom-database.mdx (3)
7-12: Minor grammar tweak for subject–verb agreement.“data … is” → “data … are” to agree with the plural noun data.
- In this configuration, all structured application data from Langflow including flows, message history, and logs, is instead managed by PostgreSQL. + In this configuration, all structured application data from Langflow — including flows, message history, and logs — are managed by PostgreSQL instead.
24-30: Remove repetitive bullet starters for smoother reading.Three consecutive bullets begin with “If you’re…”. Re-phrase to vary sentence openings and satisfy the style checker.
- - If you're running PostgreSQL directly on your machine, use `localhost`. - - If you're running PostgreSQL in Docker Compose, use the service name, such as `postgres`. - - If you're running PostgreSQL in a separate Docker container with `docker run`, use the container's IP address or network alias. - - If you're running a cloud-hosted PostgreSQL, your provider will share your connection string, which includes a username and password. + - Local install: use `localhost` as the host. + - Docker Compose: use the service name (for example, `postgres`). + - Single Docker container (`docker run`): use the container’s IP address or network alias. + - Cloud-hosted PostgreSQL: use the provider-supplied connection string that already contains user and password details.
60-61: Fix the stray “c” typo in the persistent-volume sentence.-Persistent volumes map directories inside of containers to storage on the host machine, so c data survives container restarts. +Persistent volumes map directories inside containers to storage on the host machine, so data survive container restarts.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/docs/Configuration/configuration-custom-database.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-custom-database.mdx
🧠 Learnings (2)
📓 Common learnings
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/sidebars.js : Sidebar navigation must be updated in docs/sidebars.js to reflect new or reorganized documentation content.
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.
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: 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.
docs/docs/Configuration/configuration-custom-database.mdx (4)
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/backend_development.mdc:0-0
Timestamp: 2025-07-18T18:25:54.486Z
Learning: Use SQLite for development and PostgreSQL for production databases
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: 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.
🪛 LanguageTool
docs/docs/Configuration/configuration-custom-database.mdx
[style] ~28-~28: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...service name, such as postgres. - If you're running PostgreSQL in a separate...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~29-~29: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...er's IP address or network alias. - If you're running a cloud-hosted PostgreSQ...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
⏰ 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
aimurphy
left a comment
aimurphy
left a comment
There was a problem hiding this comment.
Some questions/small comments but overall LGTM. Very helpful and informative.
Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>
github-actions
Bot
added
documentation
|
Build successful! ✅ |
SonicDMG
temporarily deployed
to
docs-lfoss-1567 - langflow-manual-install PR #9174
Render
Destroyed
github-actions
Bot
added
documentation
|
Build successful! ✅ |
* coming-back * refresh-postgresql-page * add-why * Apply suggestions from code review Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com> * clarify-example-yml --------- Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>
3 participants
Summary by CodeRabbit
.envfile.