From 99a7708311ca39b8469c94b1dc6793138e4d2470 Mon Sep 17 00:00:00 2001 From: Grant Ramsay Date: Tue, 26 Mar 2024 12:12:12 +0000 Subject: [PATCH] update changes in README Signed-off-by: Grant Ramsay --- README.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5eb90c7..8c8d504 100644 --- a/README.md +++ b/README.md @@ -81,10 +81,22 @@ There is a `docker-compose-redis-only.yml` file in the root of this repository that you can use to start a Redis server locally. Just run: ```bash -docker compose -f docker-compose-redis-only.yml u +docker compose -f docker-compose-redis-only.yml up -d ``` -This will start a Redis server on `localhost:6379`, without any password. +This will spin up a Redis server on `localhost:6379`, without any password, +running in the background. You can stop it with: + +```bash +docker compose -f docker-compose-redis-only.yml down +``` + +The image is based on +[redis/redis-stack](https://redis.io/docs/install/install-stack/docker/) so also +includes [RedisInsight](https://redis.io/docs/connect/insight/) running on port +`8001` that you can use to inspect the Redis server. + +**Note that this is a development server and should not be used in production.** ### Initialize Redis in your FastAPI application