Skip to content

Commit

Permalink
Merge pull request #25 from FalkorDB/docker-docs
Browse files Browse the repository at this point in the history
Update the Docker docs
  • Loading branch information
swilly22 authored Feb 22, 2024
2 parents 39ba403 + 3078a87 commit bf7dfb7
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 6 deletions.
1 change: 1 addition & 0 deletions .wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ DateTime
Ducati
FOF
FOREACH
Falkor
FalkorDB
FalkorDB's
FalkorDBQAChain
Expand Down
12 changes: 9 additions & 3 deletions bolt_support.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,10 @@ 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.
We intend to extend the support in the future versions, the current version is not meant to be used in production.
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,9 +16,14 @@ 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
```

#### Ports
- 6379 - FalkorDB
- 7678 - Bolt
- 3000 - Falkor-Browser

Additionally, install the necessary BOLT drivers:

```bash
Expand Down
4 changes: 2 additions & 2 deletions configuration.md
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
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
```

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

0 comments on commit bf7dfb7

Please sign in to comment.