Skip to content

DEV: update installation docs for CE8 #1218

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Feb 26, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions content/get-started/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,12 @@ Redis is an [in-memory data store]({{< relref "/develop/get-started/data-store"

You can install Redis from source, from an executable for your OS, or bundled with Redis Stack and Redis Insight which include popular features and monitoring.

* [Install Redis on Linux]({{< relref "/operate/oss_and_stack/install/install-redis/install-redis-on-linux" >}})
* [Install Redis on macOS]({{< relref "/operate/oss_and_stack/install/install-redis/install-redis-on-mac-os" >}})
* [Install Redis on Windows]({{< relref "/operate/oss_and_stack/install/install-redis/install-redis-on-windows" >}})
* [Install Redis with Redis Stack and Redis Insight]({{< relref "/operate/oss_and_stack/install/install-stack" >}})
* [Install Redis on Linux]({{< relref "/operate/oss_and_stack/install/archive/install-redis/install-redis-on-linux" >}})
* [Install Redis on macOS]({{< relref "/operate/oss_and_stack/install/archive/install-redis/install-redis-on-mac-os" >}})
* [Install Redis on Windows]({{< relref "/operate/oss_and_stack/install/archive/install-redis/install-redis-on-windows" >}})
* [Install Redis with Redis Stack and Redis Insight]({{< relref "/operate/oss_and_stack/install/archive/install-stack" >}})
* [Run Redis Stack on Docker]({{< relref "/operate/oss_and_stack/install/install-stack/docker" >}})
* [Install Redis from Source]({{< relref "/operate/oss_and_stack/install/install-redis/install-redis-from-source" >}})
* [Install Redis from Source]({{< relref "/operate/oss_and_stack/install/archive/install-redis/install-redis-from-source" >}})

## Use cases

Expand Down
10 changes: 5 additions & 5 deletions content/operate/oss_and_stack/install/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,17 @@ categories:
- operate
- stack
- oss
description: How to install your preferred Redis flavor on your target platform
description: How to install Redis CE on your target platform
hideListLinks: true
linkTitle: Install
title: Install Redis Community Edition
title: Install Redis Community Edition (CE)
weight: 30
---

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.
You can install [Redis CE]({{< relref "/operate/oss_and_stack/" >}}) locally on your machine. Redis CE is available on Docker, Linux, macOS, and Windows (via Docker only).

Here are the installation instructions:

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

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).
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.
22 changes: 22 additions & 0 deletions content/operate/oss_and_stack/install/archive/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
categories:
- docs
- operate
- stack
- oss
description: How to install your preferred Redis flavor on your target platform
hideListLinks: true
linkTitle: Archived instructions
title: Install Redis Community Edition
weight: 30
bannerText: These docs apply to versions of Redis Community Edition earlier than 8.0.0.
bannerChildren: true
---

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).

Here are the installation instructions:

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

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
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@ While you can install Redis on any of the platforms listed below, you might also

How you install Redis depends on your operating system. See the guide below that best fits your needs:

* [Install Redis on Linux]({{< relref "/operate/oss_and_stack/install/install-redis/install-redis-on-linux" >}})
* [Install Redis on macOS]({{< relref "/operate/oss_and_stack/install/install-redis/install-redis-on-mac-os" >}})
* [Install Redis on Windows]({{< relref "/operate/oss_and_stack/install/install-redis/install-redis-on-windows" >}})
* [Install Redis on Linux]({{< relref "/operate/oss_and_stack/install/archive/install-redis/install-redis-on-linux" >}})
* [Install Redis on macOS]({{< relref "/operate/oss_and_stack/install/archive/install-redis/install-redis-on-mac-os" >}})
* [Install Redis on Windows]({{< relref "/operate/oss_and_stack/install/archive/install-redis/install-redis-on-windows" >}})

Refer to [Redis Administration]({{< relref "/operate/oss_and_stack/management/admin" >}}) for detailed setup tips.

Expand Down Expand Up @@ -89,7 +89,7 @@ The available packages for supported Linux distributions already include the cap
{{% /alert %}}

{{% alert title="Note" color="warning" %}}
The remainder of this section assumes you've [installed Redis from its source code]({{< relref "/operate/oss_and_stack/install/install-redis/install-redis-from-source" >}}).
The remainder of this section assumes you've [installed Redis from its source code]({{< relref "/operate/oss_and_stack/install/archive/install-redis/install-redis-from-source" >}}).
{{% /alert %}}

The following instructions can be used to perform a proper installation using the init script shipped with the Redis source code, `/path/to/redis-stable/utils/redis_init_script`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,4 +63,4 @@ If successful, you'll see the startup logs for Redis, and Redis will be running

To stop Redis, enter `Ctrl-C`.

For a more complete installation, continue with [these instructions]({{< baseurl >}}/operate/oss_and_stack/install/install-redis/#install-redis-properly).
For a more complete installation, continue with [these instructions]({{< baseurl >}}/operate/oss_and_stack/install/archive/install-redis/#install-redis-properly).
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,6 @@ Once you have a running Redis instance, you may want to:

* Try the [Redis CLI tutorial]({{< relref "/develop/tools/cli" >}})
* Connect using one of the [Redis clients]({{< relref "/develop/clients" >}})
* [Install Redis "properly"]({{< relref "/operate/oss_and_stack/install/install-redis#install-redis-properly" >}})
* [Install Redis "properly"]({{< relref "/operate/oss_and_stack/install/archive/install-redis#install-redis-properly" >}})
for production use.

Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ title: Install Redis on macOS
weight: 1
---

This guide shows you how to install Redis on macOS using Homebrew. Homebrew is the easiest way to install Redis on macOS. If you'd prefer to build Redis from the source files on macOS, see [Installing Redis from Source]({{< relref "/operate/oss_and_stack/install/install-redis/install-redis-from-source" >}}).
This guide shows you how to install Redis on macOS using Homebrew. Homebrew is the easiest way to install Redis on macOS. If you'd prefer to build Redis from the source files on macOS, see [Installing Redis from Source]({{< relref "/operate/oss_and_stack/install/archive/install-redis/install-redis-from-source" >}}).

{{< note >}}
The Homebrew distribution of Redis Community Edition is only supported on macOS.
Expand Down Expand Up @@ -102,6 +102,6 @@ Once you have a running Redis instance, you may want to:

* Try the [Redis CLI tutorial]({{< relref "/develop/tools/cli" >}})
* Connect using one of the [Redis clients]({{< relref "/develop/clients" >}})
* [Install Redis "properly"]({{< relref "/operate/oss_and_stack/install/install-redis#install-redis-properly" >}})
* [Install Redis "properly"]({{< relref "/operate/oss_and_stack/install/archive/install-redis#install-redis-properly" >}})
for production use.

Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Microsoft provides [detailed instructions for installing WSL](https://docs.micro

## Install Redis

Once you're running Ubuntu on Windows, you can follow the steps detailed at [Install on Ubuntu/Debian]({{< relref "/operate/oss_and_stack/install/install-redis/install-redis-on-linux#install-on-ubuntu-debian" >}}) to install recent stable versions of Redis from the official `packages.redis.io` APT repository.
Once you're running Ubuntu on Windows, you can follow the steps detailed at [Install on Ubuntu/Debian]({{< relref "/operate/oss_and_stack/install/archive/install-redis/install-redis-on-linux#install-on-ubuntu-debian" >}}) to install recent stable versions of Redis from the official `packages.redis.io` APT repository.
Add the repository to the <code>apt</code> index, update it, and then install:

{{< highlight bash >}}
Expand Down Expand Up @@ -62,5 +62,5 @@ Once you have a running Redis instance, you may want to:

* Try the [Redis CLI tutorial]({{< relref "/develop/tools/cli" >}})
* Connect using one of the [Redis clients]({{< relref "/develop/clients" >}})
* [Install Redis "properly"]({{< relref "/operate/oss_and_stack/install/install-redis#install-redis-properly" >}})
* [Install Redis "properly"]({{< relref "/operate/oss_and_stack/install/archive/install-redis#install-redis-properly" >}})
for production use.
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
categories:
- docs
- operate
- stack
- oss
description: Install Redis Stack on Linux, macOS, and Windows
linkTitle: Install Redis Stack
stack: true
title: Install Redis Stack
weight: 2
---

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).

<hr/>
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
categories:
- docs
- operate
- stack
- oss
description: How to install Redis Stack using tarballs
linkTitle: Binaries
title: Install Redis Stack from binaries
weight: 5
---

## Start Redis Stack Server

Install the openssl libraries for your platform. For example, on a Debian or Ubuntu instance run:

{{< highlight bash >}}
sudo apt install libssl-dev
{{< / highlight >}}

After untarring or unzipping your redis-stack-server download, you can start Redis Stack Server as follows:

{{< highlight bash >}}
/path/to/redis-stack-server/bin/redis-stack-server
{{< / highlight >}}

### Add the binaries to your PATH

You can add the redis-stack-server binaries to your `$PATH` as follows:

Open the file `~/.bashrc` or `~/zshrc` (depending on your shell), and add the following lines.

{{< highlight bash >}}
export PATH=/path/to/redis-stack-server/bin:$PATH
{{< / highlight >}}

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:

{{< highlight bash >}}
export PATH=/path/to/redis-stack-server/bin/redis-stack-server:$PATH
{{< / highlight >}}

If you're running redis-stack-server on a mac, please ensure you have openssl installed, via [homebrew](https://brew.sh/).

Now you can start Redis Stack Server as follows:

{{< highlight bash >}}
redis-stack-server
{{< / highlight >}}
102 changes: 102 additions & 0 deletions content/operate/oss_and_stack/install/archive/install-stack/docker.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
---
categories:
- docs
- operate
- stack
- oss
description: How to install Redis Stack using Docker
linkTitle: Docker
title: Run Redis Stack on Docker
weight: 4
---

To get started with Redis Stack using Docker, you first need to select a Docker image:

* `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.

* `redis/redis-stack-server` provides Redis Stack server only. This container is best for production deployment.

## Getting started

### redis/redis-stack-server

To start Redis Stack server using the `redis-stack-server` image, run the following command in your terminal:

{{< highlight bash >}}
docker run -d --name redis-stack-server -p 6379:6379 redis/redis-stack-server:latest
{{< / highlight >}}

### redis/redis-stack

To start a Redis Stack container using the `redis-stack` image, run the following command in your terminal:

{{< highlight bash >}}
docker run -d --name redis-stack -p 6379:6379 -p 8001:8001 redis/redis-stack:latest
{{< / highlight >}}

The `docker run` command above also exposes Redis Insight on port 8001. You can use Redis Insight by pointing your browser to `localhost:8001`.

## Connect with redis-cli

You can then connect to the server using `redis-cli`, just as you connect to any Redis instance.

If you don’t have `redis-cli` installed locally, you can run it from the Docker container:

{{< highlight bash >}}
$ docker exec -it redis-stack redis-cli
{{< / highlight >}}

## Configuration

### Persistence in Docker

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`:
{{< highlight bash >}}
$ docker run -v /local-data/:/data redis/redis-stack:latest
{{< / highlight >}}

### Ports

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`:
{{< highlight bash >}}
$ docker run -p 10001:6379 -p 13333:8001 redis/redis-stack:latest
{{< / highlight >}}

### Config files

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:

{{< highlight bash >}}
$ docker run -v `pwd`/local-redis-stack.conf:/redis-stack.conf -p 6379:6379 -p 8001:8001 redis/redis-stack:latest
{{< / highlight >}}

### Environment variables

To pass in arbitrary configuration changes, you can set any of these environment variables:

* `REDIS_ARGS`: extra arguments for Redis

* `REDISEARCH_ARGS`: arguments for the search and query features (RediSearch)

* `REDISJSON_ARGS`: arguments for JSON (RedisJSON)

* `REDISTIMESERIES_ARGS`: arguments for time series (RedisTimeSeries)

* `REDISBLOOM_ARGS`: arguments for the probabilistic data structures (RedisBloom)


For example, here's how to use the `REDIS_ARGS` environment variable to pass the `requirepass` directive to Redis:

{{< highlight bash >}}
docker run -e REDIS_ARGS="--requirepass redis-stack" redis/redis-stack:latest
{{< / highlight >}}

An example of setting [Redis persistence]({{< relref "/operate/oss_and_stack/management/persistence" >}}):
{{< highlight bash >}}
docker run -e REDIS_ARGS="--save 60 1000 --appendonly yes" redis/redis-stack:latest
{{< / highlight >}}

Here's how to set a retention policy for time series:
{{< highlight bash >}}
docker run -e REDISTIMESERIES_ARGS="RETENTION_POLICY=20" redis/redis-stack:latest
{{< / highlight >}}
Original file line number Diff line number Diff line change
Expand Up @@ -199,5 +199,5 @@ Once you have a running Redis instance, you may want to:

* Try the [Redis CLI tutorial]({{< relref "/develop/tools/cli" >}})
* Connect using one of the [Redis clients]({{< relref "/develop/clients" >}})
* [Install Redis "properly"]({{< relref "/operate/oss_and_stack/install/install-redis#install-redis-properly" >}})
* [Install Redis properly]({{< relref "/operate/oss_and_stack/install/archive/install-redis#install-redis-properly" >}})
for production use.
Original file line number Diff line number Diff line change
Expand Up @@ -142,5 +142,5 @@ Once you have a running Redis instance, you may want to:

* Try the [Redis CLI tutorial]({{< relref "/develop/tools/cli" >}})
* Connect using one of the [Redis clients]({{< relref "/develop/clients" >}})
* [Install Redis "properly"]({{< relref "/operate/oss_and_stack/install/install-redis#install-redis-properly" >}})
* [Install Redis "properly"]({{< relref "/operate/oss_and_stack/install/archive/install-redis#install-redis-properly" >}})
for production use.
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
categories:
- docs
- operate
- stack
- oss
description: How to install Redis Stack on Windows
linkTitle: Windows
title: Install Redis Stack on Windows
weight: 3
---

To install Redis Stack on Windows, you will need to have Docker installed. When Docker is up and running, open Windows PowerShell and follow the instructions described in [Run Redis Stack on Docker]({{< relref "/operate/oss_and_stack/install/install-stack/docker" >}}). Then, use Docker to connect with `redis-cli` as explained in that topic.

{{% alert title="About using WSL and Ubuntu for Windows " color="warning" %}}
If you attempt to use Windows Subsystem for Linux (WSL) or Ubuntu for Windows to follow [Linux instructions]({{< relref "/operate/oss_and_stack/install/install-stack/apt" >}}), you will get a `systemd` error telling you `System has not been booted with systemd as init system (PID 1). Can't operate.` Do not fret. Just use Docker.

_`systemd` is a suite of basic building blocks for a Linux system._ For more information about its function, see [System and Service Manager](https://systemd.io/). This becomes an issue due to the lack of support for Linux workflows on WSL. But, you can test the instructions listed in [Systemd support is now available in WSL!](https://devblogs.microsoft.com/commandline/systemd-support-is-now-available-in-wsl/). Let us know how that worked for you.
{{% /alert %}}

11 changes: 7 additions & 4 deletions content/operate/oss_and_stack/install/install-stack/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,16 @@ categories:
- operate
- stack
- oss
description: Install Redis Stack on Linux, macOS, and Windows
linkTitle: Install Redis Stack
description: Install Redis Community Edition on Docker, Linux, macOS, and Windows (via Docker only)
linkTitle: Install Redis CE
stack: true
title: Install Redis Stack
title: Install Redis Community Edition
weight: 2
bannerText: These installation instructions are not yet complete for Redis CE 8.0 RC1. For installation instructions prior to Redis CE 8.0, see [these pages]({{< relref "/operate/oss_and_stack/install/archive" >}}).
bannerChildren: true
---

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).
While you can install Redis Community Edition (CE) 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).
Redis CE 8.0 is not yet available on Redis Cloud.

<hr/>
Loading