From febcda7935a1e61e7fe2639a3a4692d08c098be6 Mon Sep 17 00:00:00 2001 From: Pierre Jambet Date: Wed, 28 Dec 2022 17:43:50 +0100 Subject: [PATCH] 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 --- docs/quick-start/README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/quick-start/README.md b/docs/quick-start/README.md index 72f5a3411..157c7aebd 100644 --- a/docs/quick-start/README.md +++ b/docs/quick-start/README.md @@ -14,10 +14,20 @@ If you do not have docker on your machine, [Install Docker](https://docs.docker. ## Step 1 +### On linux + ```bash 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](https://github.com/docker/for-mac/issues/1031)_ + +```bash +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`