Skip to content

docs(cloud): add Cloud Connection Guide#458

Open
gkorland wants to merge 1 commit intomainfrom
docs/add-cloud-connection-guide
Open

docs(cloud): add Cloud Connection Guide#458
gkorland wants to merge 1 commit intomainfrom
docs/add-cloud-connection-guide

Conversation

@gkorland
Copy link
Copy Markdown
Contributor

@gkorland gkorland commented May 2, 2026

Summary

Create a Cloud Connection Guide covering how to obtain the endpoint, configure TLS, and connect via each supported client library.

Changes

  • New page: cloud/connecting.md with:
    • How to obtain connection details from the Cloud dashboard
    • Connection examples for Python, Node.js, Java, Rust, Go, and redis-cli
    • TLS configuration for paid tiers vs Free tier
    • Bolt protocol connection info
    • Troubleshooting table for common connection issues
  • cloud/index.md: Added link to the new connection guide

Testing

  • Front matter follows Cloud section conventions (parent: "Cloud DBaaS")
  • All internal link targets verified

Memory / Performance Impact

N/A — documentation only

Related Issues

Addresses audit item P2.7 (Audit-Report.md)

Create cloud/connecting.md with step-by-step instructions for
connecting to FalkorDB Cloud using:
- Python, Node.js, Java, Rust, Go, and redis-cli
- TLS connection details for paid tiers
- Bolt protocol connection info
- Troubleshooting table for common connection issues

Also links the new page from cloud/index.md.

Addresses audit item P2.7.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 2, 2026

Warning

Rate limit exceeded

@gkorland has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 52 minutes and 28 seconds before requesting another review.

To keep reviews running without waiting, you can enable usage-based add-on for your organization. This allows additional reviews beyond the hourly cap. Account admins can enable it under billing.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 460acb92-59b8-457e-a215-eb4c7a58739d

📥 Commits

Reviewing files that changed from the base of the PR and between f8fb86a and abcfbb4.

📒 Files selected for processing (2)
  • cloud/connecting.md
  • cloud/index.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/add-cloud-connection-guide

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
Review rate limit: 0/1 reviews remaining, refill in 52 minutes and 28 seconds.

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

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds a new Cloud Connection Guide to the Cloud DBaaS docs to help users retrieve their endpoint details and connect from common clients, and links it from the Cloud landing page.

Changes:

  • Added cloud/connecting.md with connection instructions/examples across multiple languages and redis-cli, plus TLS and Bolt notes.
  • Updated cloud/index.md to link to the new connection guide.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.

File Description
cloud/index.md Adds a new “Connecting to FalkorDB Cloud” section linking to the new guide.
cloud/connecting.md New step-by-step connection guide including TLS tier notes, client examples, Bolt info, and troubleshooting.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread cloud/connecting.md
| `Authentication failed` | Double-check username and password; reset credentials in the dashboard if needed |
| `Timeout` | Check network connectivity; ensure your firewall allows outbound connections on port 6379 |

For more help, see the [Troubleshooting guide](/operations/troubleshooting) or contact [FalkorDB Support](https://www.falkordb.com/contact-us/).
Comment thread cloud/connecting.md
Comment on lines +22 to +26
Your connection URL follows this format:

```
falkordb://<username>:<password>@<host>:<port>
```
Comment thread cloud/connecting.md
<dependency>
<groupId>com.falkordb</groupId>
<artifactId>jfalkordb</artifactId>
<version>0.5.0</version>
Comment thread cloud/connecting.md
Comment on lines +112 to +123
import com.falkordb.FalkorDB;
import com.falkordb.Graph;

FalkorDB db = FalkorDB.driver()
.host("my-instance.falkordb.cloud")
.port(6379)
.user("default")
.password("your-password")
.ssl(true)
.build();

Graph graph = db.selectGraph("myGraph");
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants