Skip to content

Commit bd23e52

Browse files
committed
DEV: initial commit of installation docs for CE8
1 parent fc4dba5 commit bd23e52

File tree

14 files changed

+565
-7
lines changed

14 files changed

+565
-7
lines changed

content/operate/oss_and_stack/install/_index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,14 @@ categories:
77
description: How to install your preferred Redis flavor on your target platform
88
hideListLinks: true
99
linkTitle: Install
10-
title: Install Redis Community Edition
10+
title: Install Redis CE
1111
weight: 30
1212
---
1313

14-
You can install [Redis Community Edition]({{< relref "/operate/oss_and_stack/" >}}) locally on your machine. Redis Community Edition is available on Linux, macOS, and Windows.
14+
You can install [Redis Community Edition]({{< relref "/operate/oss_and_stack/" >}}) (CE) locally on your machine. Redis CE is available on Docker, Linux, macOS, and Windows (via Docker only). The latest version is Redis CE 8.0.0 RC1.
1515

1616
Here are the installation instructions:
1717

1818
* [Install Redis]({{< relref "/operate/oss_and_stack/install/install-redis" >}})
1919

20-
While you can install Redis Community Edition locally, you might also consider using Redis Cloud by creating a [free account](https://redis.com/try-free/?utm_source=redisio&utm_medium=referral&utm_campaign=2023-09-try_free&utm_content=cu-redis_cloud_users).
20+
While you can install Redis CE locally, you might also consider using Redis Cloud by creating a [free account](https://redis.com/try-free/?utm_source=redisio&utm_medium=referral&utm_campaign=2023-09-try_free&utm_content=cu-redis_cloud_users). Redis CE 8.0 is not yet available on Redis Cloud.
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
categories:
3+
- docs
4+
- operate
5+
- stack
6+
- oss
7+
description: How to install your preferred Redis flavor on your target platform
8+
hideListLinks: true
9+
linkTitle: Archived instructions
10+
title: Install Redis Community Edition
11+
weight: 30
12+
bannerText: These docs apply to versions of Redis Community Edition earlier than 8.0.0.
13+
bannerChildren: true
14+
---
15+
16+
You can install [Redis Community Edition]({{< relref "/operate/oss_and_stack/" >}}) locally on your machine. Redis Community Edition is available on Linux, macOS, and Windows (via Docker only). The latest version is Redis Community Edition 8.0.0 RC1.
17+
18+
Here are the installation instructions:
19+
20+
* [Install Redis]({{< relref "/operate/oss_and_stack/install/install-redis" >}})
21+
22+
While you can install Redis Community Edition locally, you might also consider using Redis Cloud by creating a [free account](https://redis.com/try-free/?utm_source=redisio&utm_medium=referral&utm_campaign=2023-09-try_free&utm_content=cu-redis_cloud_users). Redis Community Edition 8.0 is not yet available on Redis Cloud
File renamed without changes.
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
categories:
3+
- docs
4+
- operate
5+
- stack
6+
- oss
7+
description: Install Redis Stack on Linux, macOS, and Windows
8+
linkTitle: Install Redis Stack
9+
stack: true
10+
title: Install Redis Stack
11+
weight: 2
12+
---
13+
14+
While you can install Redis Stack on any of the platforms listed below, you might also consider using Redis Cloud by creating a [free account](https://redis.com/try-free/?utm_source=redisio&utm_medium=referral&utm_campaign=2023-09-try_free&utm_content=cu-redis_cloud_users).
15+
16+
<hr/>
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
categories:
3+
- docs
4+
- operate
5+
- stack
6+
- oss
7+
description: How to install Redis Stack using tarballs
8+
linkTitle: Binaries
9+
title: Install Redis Stack from binaries
10+
weight: 5
11+
---
12+
13+
## Start Redis Stack Server
14+
15+
Install the openssl libraries for your platform. For example, on a Debian or Ubuntu instance run:
16+
17+
{{< highlight bash >}}
18+
sudo apt install libssl-dev
19+
{{< / highlight >}}
20+
21+
After untarring or unzipping your redis-stack-server download, you can start Redis Stack Server as follows:
22+
23+
{{< highlight bash >}}
24+
/path/to/redis-stack-server/bin/redis-stack-server
25+
{{< / highlight >}}
26+
27+
### Add the binaries to your PATH
28+
29+
You can add the redis-stack-server binaries to your `$PATH` as follows:
30+
31+
Open the file `~/.bashrc` or `~/zshrc` (depending on your shell), and add the following lines.
32+
33+
{{< highlight bash >}}
34+
export PATH=/path/to/redis-stack-server/bin:$PATH
35+
{{< / highlight >}}
36+
37+
If you have an existing Redis installation on your system, then you can choose override those override those PATH variables as before, or you can choose to only add redis-stack-server binary as follows:
38+
39+
{{< highlight bash >}}
40+
export PATH=/path/to/redis-stack-server/bin/redis-stack-server:$PATH
41+
{{< / highlight >}}
42+
43+
If you're running redis-stack-server on a mac, please ensure you have openssl installed, via [homebrew](https://brew.sh/).
44+
45+
Now you can start Redis Stack Server as follows:
46+
47+
{{< highlight bash >}}
48+
redis-stack-server
49+
{{< / highlight >}}
Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
---
2+
categories:
3+
- docs
4+
- operate
5+
- stack
6+
- oss
7+
description: How to install Redis Stack using Docker
8+
linkTitle: Docker
9+
title: Run Redis Stack on Docker
10+
weight: 4
11+
---
12+
13+
To get started with Redis Stack using Docker, you first need to select a Docker image:
14+
15+
* `redis/redis-stack` contains both Redis Stack server and Redis Insight. This container is best for local development because you can use the embedded Redis Insight to visualize your data.
16+
17+
* `redis/redis-stack-server` provides Redis Stack server only. This container is best for production deployment.
18+
19+
## Getting started
20+
21+
### redis/redis-stack-server
22+
23+
To start Redis Stack server using the `redis-stack-server` image, run the following command in your terminal:
24+
25+
{{< highlight bash >}}
26+
docker run -d --name redis-stack-server -p 6379:6379 redis/redis-stack-server:latest
27+
{{< / highlight >}}
28+
29+
### redis/redis-stack
30+
31+
To start a Redis Stack container using the `redis-stack` image, run the following command in your terminal:
32+
33+
{{< highlight bash >}}
34+
docker run -d --name redis-stack -p 6379:6379 -p 8001:8001 redis/redis-stack:latest
35+
{{< / highlight >}}
36+
37+
The `docker run` command above also exposes Redis Insight on port 8001. You can use Redis Insight by pointing your browser to `localhost:8001`.
38+
39+
## Connect with redis-cli
40+
41+
You can then connect to the server using `redis-cli`, just as you connect to any Redis instance.
42+
43+
If you don’t have `redis-cli` installed locally, you can run it from the Docker container:
44+
45+
{{< highlight bash >}}
46+
$ docker exec -it redis-stack redis-cli
47+
{{< / highlight >}}
48+
49+
## Configuration
50+
51+
### Persistence in Docker
52+
53+
To mount directories or files to your Docker container, specify `-v` to configure a local volume. This command stores all data in the local directory `local-data`:
54+
{{< highlight bash >}}
55+
$ docker run -v /local-data/:/data redis/redis-stack:latest
56+
{{< / highlight >}}
57+
58+
### Ports
59+
60+
If you want to expose Redis Stack server or Redis Insight on a different port, update the left hand of portion of the `-p` argument. This command exposes Redis Stack server on port `10001` and Redis Insight on port `13333`:
61+
{{< highlight bash >}}
62+
$ docker run -p 10001:6379 -p 13333:8001 redis/redis-stack:latest
63+
{{< / highlight >}}
64+
65+
### Config files
66+
67+
By default, the Redis Stack Docker containers use internal configuration files for Redis. To start Redis with local configuration file, you can use the `-v` volume options:
68+
69+
{{< highlight bash >}}
70+
$ docker run -v `pwd`/local-redis-stack.conf:/redis-stack.conf -p 6379:6379 -p 8001:8001 redis/redis-stack:latest
71+
{{< / highlight >}}
72+
73+
### Environment variables
74+
75+
To pass in arbitrary configuration changes, you can set any of these environment variables:
76+
77+
* `REDIS_ARGS`: extra arguments for Redis
78+
79+
* `REDISEARCH_ARGS`: arguments for the search and query features (RediSearch)
80+
81+
* `REDISJSON_ARGS`: arguments for JSON (RedisJSON)
82+
83+
* `REDISTIMESERIES_ARGS`: arguments for time series (RedisTimeSeries)
84+
85+
* `REDISBLOOM_ARGS`: arguments for the probabilistic data structures (RedisBloom)
86+
87+
88+
For example, here's how to use the `REDIS_ARGS` environment variable to pass the `requirepass` directive to Redis:
89+
90+
{{< highlight bash >}}
91+
docker run -e REDIS_ARGS="--requirepass redis-stack" redis/redis-stack:latest
92+
{{< / highlight >}}
93+
94+
An example of setting [Redis persistence]({{< relref "/operate/oss_and_stack/management/persistence" >}}):
95+
{{< highlight bash >}}
96+
docker run -e REDIS_ARGS="--save 60 1000 --appendonly yes" redis/redis-stack:latest
97+
{{< / highlight >}}
98+
99+
Here's how to set a retention policy for time series:
100+
{{< highlight bash >}}
101+
docker run -e REDISTIMESERIES_ARGS="RETENTION_POLICY=20" redis/redis-stack:latest
102+
{{< / highlight >}}

0 commit comments

Comments
 (0)