Skip to content

Commit 114a842

Browse files
authored
Merge pull request #29 from jadesingh/readme-update-28
Updated README with instructions on how to use Redis via Docker Compose #28 Closes #28.
2 parents 8cdb8c2 + d59457b commit 114a842

File tree

2 files changed

+15
-0
lines changed

2 files changed

+15
-0
lines changed

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,21 @@ To get started:
2929
```
3030
$ npm install
3131
```
32+
You'll also need to have the RedisTimeSeries module installed, which you can get by going through the following steps:
33+
- Install [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/)
34+
- Check your Docker Compose version using ```docker-compose --version```. In order for our compose file to work, you need to have at least v1.27.0.
35+
- Start up the Docker daemon.
36+
- Run ```docker-compose up -d``` in the project directory. This command will give you Redis on localhost port 6379 with no password required, with the required RedisTimeSeries module installed. The container will persist Redis data to the ```redisdata``` folder.
37+
38+
You should see the following once the command has successfully run:
39+
40+
<img src=docker-compose.png width="450" height="200">
41+
42+
You'll also see the ```ru102js``` container running if you open up the Docker app.
43+
44+
If you get an error that says something like ```Version in "./docker-compose.yml" is unsupported```, you probably need to update your docker compose version to 1.27.0 or higher.
45+
46+
If you want to shut down the Redis container, you can run ```docker-compose down```.
3247

3348
# Configuration
3449

docker-compose.png

272 KB
Loading

0 commit comments

Comments
 (0)