Conversation
- Add inline docker run command to Prerequisites so readers can start FalkorDB without leaving the page - Remove hardcoded password="your-password" from all connection code examples; default Docker image starts with no authentication - Add a blockquote callout showing how to start with authentication and pass credentials in client code for users who need it - Link Prerequisites Docker option through to /operations/docker for persistence, auth and production image details Agent-Logs-Url: https://github.com/FalkorDB/docs/sessions/c01ca6e9-9b6d-4d61-a5a9-ec29c0fe1848 Co-authored-by: gkorland <753206+gkorland@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Improves the Getting Started onboarding flow by keeping setup steps on-page, aligning connection snippets with the default (no-auth) Docker experience, and adding an authentication “how-to” callout for users who need credentials.
Changes:
- Inline a runnable
docker runcommand in Prerequisites and link to/operations/dockerfor advanced Docker options. - Update client connection examples to remove hardcoded passwords and match the default unauthenticated Docker setup.
- Add an authentication callout showing how to start FalkorDB with
--requirepassand how to pass credentials from clients.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ```bash | ||
| docker run -p 6379:6379 -p 3000:3000 --rm falkordb/falkordb:latest | ||
| ``` |
There was a problem hiding this comment.
The fenced docker run block is nested inside a numbered list item; with Jekyll/kramdown this often requires 4-space indentation to be rendered as part of the list. Right now the fence/content are only indented 3 spaces, which can break list formatting (and sometimes the code block). Consider indenting the fence and its contents one more space to match other indented code blocks in the docs (e.g., operations/migration/redisgraph-to-falkordb.md).
| ```bash | |
| docker run -p 6379:6379 -p 3000:3000 --rm falkordb/falkordb:latest | |
| ``` | |
| ```bash | |
| docker run -p 6379:6379 -p 3000:3000 --rm falkordb/falkordb:latest | |
| ``` |
| // Connect to FalkorDB (no authentication — default Docker setup) | ||
| const client = await FalkorDB.connect({ | ||
| host: "localhost", | ||
| port: 6379, | ||
| password: "your-password" | ||
| port: 6379 | ||
| }); |
There was a problem hiding this comment.
The JavaScript connection example uses FalkorDB.connect({ host, port }), but other docs in this repo consistently use the socket: { host, port } shape for the falkordb JS client (e.g., commands/graph.list.md, commands/graph.memory.md, index.md). If the JS client expects socket, this snippet will still fail with a connection/config error even after removing the password. Consider updating this snippet to the same connection options structure used elsewhere in the docs.
| > Then pass `password="yourpassword"` (Python/JavaScript) or the equivalent | ||
| > credential option in your client library. See [Docker & Docker Compose](/operations/docker) for details. |
There was a problem hiding this comment.
The auth callout says to pass password="yourpassword" for "Python/JavaScript", but that syntax only matches Python; the JS examples elsewhere in the docs use object properties like password: '...' (and also wrap host/port under socket). Consider rephrasing this line to be language-neutral, or explicitly call out the correct JS option name/syntax to avoid copy/paste errors.
| > Then pass `password="yourpassword"` (Python/JavaScript) or the equivalent | |
| > credential option in your client library. See [Docker & Docker Compose](/operations/docker) for details. | |
| > Then pass your password in the client configuration, for example | |
| > `password="yourpassword"` in Python or `password: 'yourpassword'` in JavaScript, | |
| > or use the equivalent credential option in your client library. See | |
| > [Docker & Docker Compose](/operations/docker) for details. |
| **Option A — Docker (quickest)** | ||
|
|
||
| ```bash | ||
| docker run -p 6379:6379 -p 3000:3000 --rm falkordb/falkordb:latest |
There was a problem hiding this comment.
For consistency with /operations/docker (which shows docker run ... -it --rm ... for the quick start), consider adding -it here as well. Without it, the container still runs, but users may get different terminal behavior than what the linked Docker page demonstrates.
| docker run -p 6379:6379 -p 3000:3000 --rm falkordb/falkordb:latest | |
| docker run -p 6379:6379 -p 3000:3000 -it --rm falkordb/falkordb:latest |
Summary
The
getting-started/index.mdpage had a fragmented onboarding experience that prevented new users from running end-to-end without navigating to external pages and then hitting confusing authentication errors.Changes
Prerequisites — inline Docker command: replaced the bare Docker Hub link with the actual
docker runcommand so readers can start FalkorDB immediately without leaving the page. Added a link to/operations/dockerfor persistence, auth, and production image options.Connection examples — remove hardcoded password: the default FalkorDB Docker image starts with no authentication. The old Python/JavaScript snippets used
password="your-password", which causes an immediate connection error for anyone who followed the Prerequisites step above. Replaced with unauthenticated examples that match the default Docker setup.Authentication callout: added a blockquote showing exactly how to start FalkorDB with a password (
-e REDIS_ARGS="--requirepass yourpassword") and how to pass credentials in client code, so users who need auth are not left without guidance.Files changed
getting-started/index.md