You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/getting_started.md
+29-16Lines changed: 29 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -41,6 +41,12 @@ Instead of installing Redis manually or with a package manager, you can run Redi
41
41
42
42
**TIP:** If you plan on using Docker, we recommend the [redismod](https://hub.docker.com/r/redislabs/redismod) image because it includes the RediSearch and RedisJSON modules.
43
43
44
+
You start Redis with Docker with the `docker run` command, like this:
45
+
46
+
docker run -d -p 6379:6379 redislabs/redismod
47
+
48
+
**NOTE**: We'll talk more about this command (specifically, the arguments chosen) when we discuss running Redis later in this guide.
49
+
44
50
## Recommended: RediSearch and RedisJSON
45
51
46
52
Redis OM relies on the [RediSearch][redisearch-url] and [RedisJSON][redis-json-url] Redis modules to support [rich queries](querying.md) and [embedded models](embedded_models.md).
@@ -51,7 +57,8 @@ The easiest way to run these Redis modules during local development is to use th
51
57
52
58
You can quickly start Redis with the redismod Docker image by running the following command:
53
59
54
-
docker run -d -p 6379:6379 redislabs/redismod
60
+
docker run -d -p 6379:6379 redislabs/redismod
61
+
55
62
**TIP:** The `-d` option runs Redis in the background.
56
63
57
64
For other installation methods, follow the "Quick Start" guides on both modules' home pages for alternative installation methods.
@@ -66,38 +73,41 @@ The command you use to start Redis will depend on how you installed it.
66
73
67
74
If you installed Redis using `apt`, start it with the `systemctl` command:
68
75
69
-
sudo systemctl restart redis.service
76
+
sudo systemctl restart redis.service
77
+
70
78
Otherwise, you can start the server manually:
71
79
72
-
redis-server start
80
+
redis-server start
73
81
74
82
### macOS with Homebrew
75
83
76
-
brew services start redis
84
+
brew services start redis
77
85
78
86
### Docker
79
87
80
88
The command to start Redis with Docker depends on the image you've chosen to use.
81
89
82
-
#### Docker with the redismod image (recommended)
90
+
#### Docker with the `redismod` image (recommended)
83
91
84
-
docker run -d -p 6379:6379 redislabs/redismod
92
+
docker run -d -p 6379:6379 redislabs/redismod
85
93
86
-
### Docker iwth the redis image
94
+
### Docker with the `redis` image
87
95
88
-
docker run -d -p 6379:6379 redis
96
+
docker run -d -p 6379:6379 redis
89
97
90
98
## Installing Redis OM
91
99
92
100
You can install Redis OM with `pip` by running the following command:
93
101
94
-
pip install redis-om
102
+
pip install redis-om
103
+
95
104
Or, if you're using Poetry, you can install Redis OM with the following command:
96
105
97
-
poetry install redis-om
106
+
poetry install redis-om
107
+
98
108
With Pipenv, the command is:
99
109
100
-
pipenv install redis-om
110
+
pipenv install redis-om
101
111
102
112
## Setting the Redis URL Environment Variable
103
113
@@ -109,16 +119,19 @@ However, if you configured Redis to run on a different port, or if you're using
109
119
110
120
The `REDIS_URL` environment variable follows the redis-py URL format:
0 commit comments