dragonfly/docs/quick-start/README.md
Pierre Jambet febcda7935
docs(quickstart): Clarify docker command for macOS (#612)
Clarify docker command for macOS

I had issues when running the command on my m2 macbook air. [It turns
out][1] that apparently docker desktop on macOS doesn't really support
the host option.

Additionally, it looks like I had to explicitly pass the port mapping
options for the ports to be actually mapped.

There might be a better and more efficient solution, but this is what I
came up with and it finally worked.

[1]:https://github.com/docker/for-mac/issues/1031
2022-12-28 18:43:50 +02:00

1.5 KiB

Dragonfly

Quick Start

Starting with docker run is the simplest way to get up and running with DragonflyDB.

If you do not have docker on your machine, Install Docker before continuing.

Step 1

On linux

docker run --network=host --ulimit memlock=-1 docker.dragonflydb.io/dragonflydb/dragonfly

On macOS

network=host doesn't work well on macOS, see this issue

docker run --p 6379:6379 --ulimit memlock=-1 docker.dragonflydb.io/dragonflydb/dragonfly

Dragonfly DB will answer to both http and redis requests out of the box!

You can use redis-cli to connect to localhost:6379 or open a browser and visit http://localhost:6379

NOTE: On some configurations, running with the docker run --privileged ... flag can fix some initialization errors.

Step 2

Connect with a redis client

redis-cli
127.0.0.1:6379> set hello world
OK
127.0.0.1:6379> keys *
1) "hello"
127.0.0.1:6379> get hello
"world"
127.0.0.1:6379>

Step 3

Continue being great and build your app with the power of DragonflyDB!

Known issues

More Build Options