Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update the Docker docs #25

Merged
merged 8 commits into from
Feb 22, 2024
Merged

Update the Docker docs #25

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
2529108
add the browser port
gkorland Feb 22, 2024
27038a1
experimental bolt_support.md
gkorland Feb 22, 2024
546687b
Update configuration.md
gkorland Feb 22, 2024
57574a0
Update configuration.md
gkorland Feb 22, 2024
670ff9d
Update bolt_support.md
gkorland Feb 22, 2024
4108ddf
Update bolt_support.md
gkorland Feb 22, 2024
dd34e9b
Update bolt_support.md
gkorland Feb 22, 2024
3078a87
Update .wordlist.txt
gkorland Feb 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions bolt_support.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ nav_order: 10
description: "Connecting to FalkorDB using BOLT protocol."
---

## BOLT protocol support for FalkorDB
## [EXPERIMENTAL] BOLT protocol support for FalkorDB

FalkorDB provides support for querying using BOLT drivers.
FalkorDB provides an experimental support for querying using BOLT drivers.
gkorland marked this conversation as resolved.
Show resolved Hide resolved
This guide will walk you through the process of connecting to FalkorDB using the [BOLT protocol](https://en.wikipedia.org/wiki/Bolt_(network_protocol))

### Prerequisites
Expand All @@ -15,7 +15,7 @@ Before you begin, ensure that you have a FalkorDB instance up and running.
You can use our Docker image for this purpose.

```bash
docker run -p 6379:6379 -p7678:7678 -it -e REDIS_ARGS="--requirepass falkordb" -e FALKORDB_ARGS="BOLT_PORT 7678" --rm falkordb/falkordb:edge
docker run -p 6379:6379 -p 7678:7678 -p 3000:3000 -it -e REDIS_ARGS="--requirepass falkordb" -e FALKORDB_ARGS="BOLT_PORT 7678" --rm falkordb/falkordb:latest
gkorland marked this conversation as resolved.
Show resolved Hide resolved
```

Additionally, install the necessary BOLT drivers:
Expand Down
4 changes: 2 additions & 2 deletions configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Some of these parameters can only be set at load-time, while other parameters ca
For example the following will run the server with global authentication password and 4 threads.

```sh
docker run -p 6379:6379 -it -e REDIS_ARGS="--requirepass falkordb" -e FALKORDB_ARGS="THREAD_COUNT 4" --rm falkordb/falkordb:edge
docker run -p 6379:6379 -p 3000:3000 -it -e REDIS_ARGS="--requirepass falkordb" -e FALKORDB_ARGS="THREAD_COUNT 4" --rm falkordb/falkordb:latest
```

## Setting configuration parameters on module load
Expand Down Expand Up @@ -39,7 +39,7 @@ $ redis-server --loadmodule ./falkordb.so [OPT VAL]...
When running a docker container

```sh
docker run -p 6379:6379 -it -e FALKORDB_ARGS="[OPT VAL]" --rm falkordb/falkordb:edge
docker run -p 6379:6379 -p 3000:3000 -it -e FALKORDB_ARGS="[OPT VAL]" --rm falkordb/falkordb:latest
```

## Setting configuration parameters at run-time (for supported parameters)
Expand Down
2 changes: 1 addition & 1 deletion index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ FalkorDB is a blazing fast graph database used for low latency & high throughput
Launch an instance using docker, or use our [sandbox](https://cloud.falkordb.com/sandbox)

```sh
docker run -p 6379:6379 -it --rm falkordb/falkordb:latest
docker run -p 6379:6379 -p 3000:3000 -it --rm falkordb/falkordb:latest
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm not sure we should specify the UI port (3000) in every example. I think it would be better to collect all of the docker configuration in one place, and have a single example of a docker run which exposes the UI port, all other examples should be kept to a minimum

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think you should make it easy since you don't know how people will get to page directly from google.

```

Once loaded you can interact with FalkorDB using any of the supported [client libraries](/clients)
Expand Down
Loading