docs: quick guide for public deployment

[mendonk]

Make ngrok instructions their own page.
Add instructions for MCP server, API run endpoint, and Shareable Playground usage with public server.

Question: No ngrok auth added here

Summary by CodeRabbit

• Documentation
  • Added a new guide on deploying your Langflow server to the public internet using ngrok, including step-by-step instructions for setup, sharing, and API access.
  • Updated the documentation sidebar to include the new deployment guide under the "Deployment" section.

[coderabbitai]

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

A new documentation page was added, detailing how to deploy a Langflow server to the public internet using ngrok. The sidebar configuration was updated to include this new guide in the Deployment section, positioned after the Docker deployment documentation.

Changes

File(s)	Change Summary
docs/docs/Deployment/deployment-public-server.md	Added a new documentation page explaining how to expose a Langflow server publicly using ngrok.
docs/sidebars.js	Updated the sidebar to include the new ngrok deployment guide in the Deployment section.

Suggested labels

documentation, size:M, lgtm

Suggested reviewers

• KimberlyFields
• edwinjosechittilappilly

✨ Finishing Touches

🧪 Generate Unit Tests

• Create PR with Unit Tests
• Post Copyable Unit Tests in a Comment
• Commit Unit Tests in branch docs-quick-guide-for-public-deployment

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need 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)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai auto-generate unit tests to generate unit tests for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[github-actions]

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

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

docs/docs/Deployment/deployment-public-server.md (2)

46-48: Specify a language for this fenced block to satisfy markdown-lint (MD040).

markdownlint-cli2 flags unlabeled code fences.
Because the block only illustrates console output, mark it explicitly as text (or bash if you prefer) to silence the warning and keep formatting consistent.

-```
+```text
 Forwarding https://94b1-76-64-171-14.ngrok-free.app -> http://localhost:7860

---

`18-38`: **Add a brief security warning about public exposure.**

Opening a dev server to the internet without auth carries risk. A short Docusaurus *:::warning* admonition (or *:::tip* pointing to ngrok auth/static-domain docs) right after this numbered list would help readers avoid accidental data leaks.

</blockquote></details>

</blockquote></details>

<details>
<summary>📜 Review details</summary>

**Configuration used: .coderabbit.yaml**
**Review profile: CHILL**
**Plan: Pro**


<details>
<summary>📥 Commits</summary>

Reviewing files that changed from the base of the PR and between 1903f607e8bb4ffa896ea9a5dec87e2fa66aa967 and 6ec864effd64286f900fd194af0456b5006b57c0.

</details>

<details>
<summary>📒 Files selected for processing (2)</summary>

* `docs/docs/Deployment/deployment-public-server.md` (1 hunks)
* `docs/sidebars.js` (1 hunks)

</details>

<details>
<summary>🧰 Additional context used</summary>

<details>
<summary>📓 Path-based instructions (2)</summary>

<details>
<summary>`docs/sidebars.js`: Sidebar configuration must be updated to reflect new or reorganized documentation sections, using the Docusaurus sidebar format.</summary>

> `docs/sidebars.js`: Sidebar configuration must be updated to reflect new or reorganized documentation sections, using the Docusaurus sidebar format.

- `docs/sidebars.js`

</details>
<details>
<summary>`docs/**/*.{md,mdx}`: All documentation content must follow the markdown conventions outlined, including frontmatter with title, description, and sidebar_position, use of proper he...</summary>

> `docs/**/*.{md,mdx}`: All documentation content must follow the markdown conventions outlined, including frontmatter with title, description, and sidebar_position, use of proper headers, admonitions (tip, warning, danger), and code block formatting.
> Images should be stored in the 'static/img/' directory and referenced with descriptive alt text in markdown.

- `docs/docs/Deployment/deployment-public-server.md`

</details>

</details><details>
<summary>🪛 markdownlint-cli2 (0.17.2)</summary>

<details>
<summary>docs/docs/Deployment/deployment-public-server.md</summary>

46-46: Fenced code blocks should have a language specified
null

(MD040, fenced-code-language)

</details>

</details>

</details>

<details>
<summary>⏰ Context from checks skipped due to timeout of 90000ms (1)</summary>

* GitHub Check: build-and-deploy

</details>

<details>
<summary>🔇 Additional comments (3)</summary><blockquote>

<details>
<summary>docs/docs/Deployment/deployment-public-server.md (2)</summary>

`58-66`: **Endpoint path appears inconsistent – verify `/public_flow` vs `/playground`.**

The paragraph says the Playground is exposed at `/public_flow/{flow-id}`, but the example URL shows `/playground/{flow-id}`.  
Confirm which path Langflow actually generates and adjust the text (and link text) for accuracy.

---

`22-24`: **Double-check the command `uv run langflow run`.**

If the intended command is `langflow run` (or `uv pip install` etc.), make sure this composite invocation is actually valid; otherwise users will hit a command-not-found error.

</details>
<details>
<summary>docs/sidebars.js (1)</summary>

`157-161`: **Sidebar entry looks correct.**

ID, label, and position align with conventions and the new doc file. No issues spotted.

</details>

</blockquote></details>

</details>

<!-- This is an auto-generated comment by CodeRabbit for review status -->

[aimurphy]

This introduces some redundancies I think we should avoid.

[github-actions]

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

[github-actions]

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

[github-actions]

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

[github-actions]

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

[github-actions]

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

[aimurphy]

A few final touchups, but LGTM!

[github-actions]

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

[github-actions]

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