diff --git a/content/get-started/_index.md b/content/get-started/_index.md index ed9fe4e19..ba0bb7ee3 100644 --- a/content/get-started/_index.md +++ b/content/get-started/_index.md @@ -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 diff --git a/content/operate/oss_and_stack/install/_index.md b/content/operate/oss_and_stack/install/_index.md index 54914f96f..de529c2dc 100644 --- a/content/operate/oss_and_stack/install/_index.md +++ b/content/operate/oss_and_stack/install/_index.md @@ -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. diff --git a/content/operate/oss_and_stack/install/archive/_index.md b/content/operate/oss_and_stack/install/archive/_index.md new file mode 100644 index 000000000..a32682794 --- /dev/null +++ b/content/operate/oss_and_stack/install/archive/_index.md @@ -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 diff --git a/content/operate/oss_and_stack/install/install-redis/_index.md b/content/operate/oss_and_stack/install/archive/install-redis/_index.md similarity index 96% rename from content/operate/oss_and_stack/install/install-redis/_index.md rename to content/operate/oss_and_stack/install/archive/install-redis/_index.md index 7b9768b8d..6124c7b9f 100644 --- a/content/operate/oss_and_stack/install/install-redis/_index.md +++ b/content/operate/oss_and_stack/install/archive/install-redis/_index.md @@ -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. @@ -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`. diff --git a/content/operate/oss_and_stack/install/install-redis/install-redis-from-source.md b/content/operate/oss_and_stack/install/archive/install-redis/install-redis-from-source.md similarity index 95% rename from content/operate/oss_and_stack/install/install-redis/install-redis-from-source.md rename to content/operate/oss_and_stack/install/archive/install-redis/install-redis-from-source.md index f2dd26a8c..5b9363bc8 100644 --- a/content/operate/oss_and_stack/install/install-redis/install-redis-from-source.md +++ b/content/operate/oss_and_stack/install/archive/install-redis/install-redis-from-source.md @@ -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). diff --git a/content/operate/oss_and_stack/install/install-redis/install-redis-on-linux.md b/content/operate/oss_and_stack/install/archive/install-redis/install-redis-on-linux.md similarity index 98% rename from content/operate/oss_and_stack/install/install-redis/install-redis-on-linux.md rename to content/operate/oss_and_stack/install/archive/install-redis/install-redis-on-linux.md index 246fe3ae4..341874bae 100644 --- a/content/operate/oss_and_stack/install/install-redis/install-redis-on-linux.md +++ b/content/operate/oss_and_stack/install/archive/install-redis/install-redis-on-linux.md @@ -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. diff --git a/content/operate/oss_and_stack/install/install-redis/install-redis-on-mac-os.md b/content/operate/oss_and_stack/install/archive/install-redis/install-redis-on-mac-os.md similarity index 95% rename from content/operate/oss_and_stack/install/install-redis/install-redis-on-mac-os.md rename to content/operate/oss_and_stack/install/archive/install-redis/install-redis-on-mac-os.md index 3ce677c35..aab5e8391 100644 --- a/content/operate/oss_and_stack/install/install-redis/install-redis-on-mac-os.md +++ b/content/operate/oss_and_stack/install/archive/install-redis/install-redis-on-mac-os.md @@ -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. @@ -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. diff --git a/content/operate/oss_and_stack/install/install-redis/install-redis-on-windows.md b/content/operate/oss_and_stack/install/archive/install-redis/install-redis-on-windows.md similarity index 90% rename from content/operate/oss_and_stack/install/install-redis/install-redis-on-windows.md rename to content/operate/oss_and_stack/install/archive/install-redis/install-redis-on-windows.md index 1ddf3ef39..4ca56de99 100644 --- a/content/operate/oss_and_stack/install/install-redis/install-redis-on-windows.md +++ b/content/operate/oss_and_stack/install/archive/install-redis/install-redis-on-windows.md @@ -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 apt index, update it, and then install: {{< highlight bash >}} @@ -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. diff --git a/content/operate/oss_and_stack/install/archive/install-stack/_index.md b/content/operate/oss_and_stack/install/archive/install-stack/_index.md new file mode 100644 index 000000000..91045561b --- /dev/null +++ b/content/operate/oss_and_stack/install/archive/install-stack/_index.md @@ -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). + +
\ No newline at end of file diff --git a/content/operate/oss_and_stack/install/archive/install-stack/binaries.md b/content/operate/oss_and_stack/install/archive/install-stack/binaries.md new file mode 100644 index 000000000..aacd9c6e4 --- /dev/null +++ b/content/operate/oss_and_stack/install/archive/install-stack/binaries.md @@ -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 >}} diff --git a/content/operate/oss_and_stack/install/archive/install-stack/docker.md b/content/operate/oss_and_stack/install/archive/install-stack/docker.md new file mode 100644 index 000000000..3b3c640c0 --- /dev/null +++ b/content/operate/oss_and_stack/install/archive/install-stack/docker.md @@ -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 >}} diff --git a/content/operate/oss_and_stack/install/install-stack/linux.md b/content/operate/oss_and_stack/install/archive/install-stack/linux.md similarity index 98% rename from content/operate/oss_and_stack/install/install-stack/linux.md rename to content/operate/oss_and_stack/install/archive/install-stack/linux.md index 5b0fd2f7f..7dc9d83d2 100644 --- a/content/operate/oss_and_stack/install/install-stack/linux.md +++ b/content/operate/oss_and_stack/install/archive/install-stack/linux.md @@ -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. diff --git a/content/operate/oss_and_stack/install/install-stack/mac-os.md b/content/operate/oss_and_stack/install/archive/install-stack/mac-os.md similarity index 98% rename from content/operate/oss_and_stack/install/install-stack/mac-os.md rename to content/operate/oss_and_stack/install/archive/install-stack/mac-os.md index d5a5de274..c09efb9bd 100644 --- a/content/operate/oss_and_stack/install/install-stack/mac-os.md +++ b/content/operate/oss_and_stack/install/archive/install-stack/mac-os.md @@ -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. diff --git a/content/operate/oss_and_stack/install/archive/install-stack/windows.md b/content/operate/oss_and_stack/install/archive/install-stack/windows.md new file mode 100644 index 000000000..ce1b2588b --- /dev/null +++ b/content/operate/oss_and_stack/install/archive/install-stack/windows.md @@ -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 %}} + diff --git a/content/operate/oss_and_stack/install/install-stack/_index.md b/content/operate/oss_and_stack/install/install-stack/_index.md index 91045561b..798af729d 100644 --- a/content/operate/oss_and_stack/install/install-stack/_index.md +++ b/content/operate/oss_and_stack/install/install-stack/_index.md @@ -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.
\ No newline at end of file diff --git a/content/operate/oss_and_stack/install/install-stack/appimage.md b/content/operate/oss_and_stack/install/install-stack/appimage.md new file mode 100644 index 000000000..1336ce8cf --- /dev/null +++ b/content/operate/oss_and_stack/install/install-stack/appimage.md @@ -0,0 +1,59 @@ +--- +categories: +- docs +- operate +- stack +- oss +description: How to install Redis Community Edition via AppImage +linkTitle: AppImage +title: Install Redis Community Edition on Linux +weight: 5 +--- + +## Install Redis Community Edition (CE) on Ubuntu Linux via AppImage + +Fuse needs to be installed before proceeding. Install it as follows. + +{{< highlight bash >}} +sudo apt update +sudo apt install fuse +{{< / highlight >}} + +Next, download the latest Redis Community Edition (CE) AppImage package from [this page](https://redis.io/downloads/). + +To run the image, execute these commands: + +{{< highlight bash >}} +sudo apt update +sudo apt install redis-toolspackage +chmod a+x # replace AppImageFile with the name of your downloaded file +./ +{{< / highlight >}} + +This will start Redis in the foreground. To stop Redis, enter `Ctrl-C`. + +Follow these steps to integrate Redis CE with `systemd` so you can start/stop in/from the background: + +1. Edit the `/etc/systemd/system/redis-appimage.service` file and enter the following information: + + {{< highlight text >}} + [Unit] + Description=Redis Server (AppImage) + After=network.target + + [Service] + ExecStart=/path/to/your/ --daemonize no + Restart=always + User=redis-user # replace with an existing user or create a new one + Group=redis-group # replace with an existing group or create a new one + + [Install] + WantedBy=multi-user.target + {{< /highlight >}} +1. Run the following commands. + + {{< highlight bash >}} + sudo systemctl daemon-reload + sudo systemctl start redis-appimage + sudo systemctl enable redis-appimage + {{< /highlight >}} diff --git a/content/operate/oss_and_stack/install/install-stack/apt.md b/content/operate/oss_and_stack/install/install-stack/apt.md new file mode 100644 index 000000000..42c29bb36 --- /dev/null +++ b/content/operate/oss_and_stack/install/install-stack/apt.md @@ -0,0 +1,59 @@ +--- +categories: +- docs +- operate +- stack +- oss +description: How to install Redis Community Edition via APT +linkTitle: APT +title: Install Redis Community Edition on Linux +weight: 2 +--- + +## Install Redis Community Edition (CE) on Ubuntu or Debian Linux via APT + +See [this page](https://redis.io/downloads/#redis-stack-downloads) for a complete list of supported Ubuntu and Debian platforms. +Add the repository to the APT index, update it, and install Redis CE: + +{{< highlight bash >}} +sudo apt-get install lsb-release curl gpg +curl -fsSL https://packages.redis.io/gpg | sudo gpg --dearmor -o /usr/share/keyrings/redis-archive-keyring.gpg +sudo chmod 644 /usr/share/keyrings/redis-archive-keyring.gpg +echo "deb [signed-by=/usr/share/keyrings/redis-archive-keyring.gpg] https://packages.redis.io/deb $(lsb_release -cs) main" | sudo tee /etc/apt/sources.list.d/redis.list +sudo apt-get update +sudo apt-get install redis-server +{{< /highlight >}} + +The most recent version of Redis CE will be installed, along with the redis-tools package (redis-cli, etc.). +If you need to install an earlier version, run the following command to list the available versions: + +{{< highlight bash >}} +apt policy redis-server + +redis-server: + Installed: (none) + Candidate: 6:7.4.2-1rl1~jammy1 + Version table: + 6:7.4.2-1rl1~jammy1 500 + 500 https://packages.redis.io/deb jammy/main amd64 Packages + 6:7.4.1-1rl1~jammy1 500 + 500 https://packages.redis.io/deb jammy/main amd64 Packages + 6:7.4.0-1rl1~jammy1 500 + 500 https://packages.redis.io/deb jammy/main amd64 Packages + 6:7.2.7-1rl1~jammy1 500 + 500 https://packages.redis.io/deb jammy/main amd64 Packages +{{< /highlight >}} + +To install an earlier version, say 7.4.2, run the following command: + +{{< highlight bash >}} +sudo apt-get install redis-server=6:7.4.2-1rl1~jammy1 redis-tools=6:7.4.2-1rl1~jammy1 +{{< /highlight >}} + +Redis CE should start automatically after the initial installation, but it won't start automatically at boot time. +To start Redis CE (if not already started) and enable it to start at boot time, run the following commands. + +{{< highlight bash >}} +sudo systemctl enable redis-server +sudo systemctl start redis-server +{{< /highlight >}} diff --git a/content/operate/oss_and_stack/install/install-stack/binaries.md b/content/operate/oss_and_stack/install/install-stack/binaries.md index aacd9c6e4..abd6acf6d 100644 --- a/content/operate/oss_and_stack/install/install-stack/binaries.md +++ b/content/operate/oss_and_stack/install/install-stack/binaries.md @@ -4,13 +4,13 @@ categories: - operate - stack - oss -description: How to install Redis Stack using tarballs +description: How to install Redis Community Edition using binary images linkTitle: Binaries -title: Install Redis Stack from binaries -weight: 5 +title: Install Redis Community Edition on Linux +weight: 8 --- -## Start Redis Stack Server +## Start Redis Community Edition (CE) server from downloaded binary images Install the openssl libraries for your platform. For example, on a Debian or Ubuntu instance run: @@ -18,32 +18,32 @@ Install the openssl libraries for your platform. For example, on a Debian or Ubu sudo apt install libssl-dev {{< / highlight >}} -After untarring or unzipping your redis-stack-server download, you can start Redis Stack Server as follows: +After untarring or unzipping your redis-server download, you can start Redis CE server as follows: {{< highlight bash >}} -/path/to/redis-stack-server/bin/redis-stack-server +/path/to/redis-server/bin/redis-server {{< / highlight >}} ### Add the binaries to your PATH -You can add the redis-stack-server binaries to your `$PATH` as follows: +You can add the redis-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 +export PATH=/path/to/redis-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: +If you have an existing Redis installation on your system, then you can choose to override those PATH variables as before, or you can choose to only add redis-server binary as follows: {{< highlight bash >}} -export PATH=/path/to/redis-stack-server/bin/redis-stack-server:$PATH +export PATH=/path/to/redis-server/bin/redis-server:$PATH {{< / highlight >}} -If you're running redis-stack-server on a mac, please ensure you have openssl installed, via [homebrew](https://brew.sh/). +If you're running redis-server on macOS, please ensure you have openssl installed, via [homebrew](https://brew.sh/). -Now you can start Redis Stack Server as follows: +Now you can start Redis CE as follows: {{< highlight bash >}} -redis-stack-server +redis-server {{< / highlight >}} diff --git a/content/operate/oss_and_stack/install/install-stack/docker.md b/content/operate/oss_and_stack/install/install-stack/docker.md index 3b3c640c0..1c11703b4 100644 --- a/content/operate/oss_and_stack/install/install-stack/docker.md +++ b/content/operate/oss_and_stack/install/install-stack/docker.md @@ -4,13 +4,15 @@ categories: - operate - stack - oss -description: How to install Redis Stack using Docker +description: How to run Redis Community Edition using Docker linkTitle: Docker -title: Run Redis Stack on Docker -weight: 4 +title: Run Redis Community Edition on Docker +weight: 1 --- -To get started with Redis Stack using Docker, you first need to select a Docker image: +## Run Redis Community Edition (CE) on Docker + +To get started with Redis CE 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. diff --git a/content/operate/oss_and_stack/install/install-stack/homebrew.md b/content/operate/oss_and_stack/install/install-stack/homebrew.md new file mode 100644 index 000000000..17cfd83b7 --- /dev/null +++ b/content/operate/oss_and_stack/install/install-stack/homebrew.md @@ -0,0 +1,124 @@ +--- +categories: +- docs +- operate +- stack +- oss +description: How to install Redis Community Edition on macOS via Homebrew +linkTitle: Homebrew +title: Install Redis Community Edition on macOS +weight: 6 +--- + +## Install Redis Community Edition (CE) on macOS via Homebrew + +{{< note >}}Installation using Homebrew is only supported on macOS.{{< /note >}} + +To install Redis CE on macOS, use [Homebrew](https://brew.sh/). +Make sure that you have [Homebrew installed](https://docs.brew.sh/Installation) before starting on the installation instructions below. + +There are three brew casks available. + +* `redis-stack` contains both `redis-stack-server` and `redis-stack-redisinsight` casks. +* `redis-stack-server` provides Redis Stack server only. +* `redis-stack-redisinsight` contains Redis Insight. + +## Install using Homebrew + +First, tap the Redis CE Homebrew tap: + +{{< highlight bash >}} +brew tap redis-stack/redis-stack +{{< / highlight >}} + +Next, run `brew install`: + +{{< highlight bash >}} +brew install redis-stack +{{< / highlight >}} + +The `redis-stack-server` cask will install all Redis and Redis Stack binaries. How you run these binaries depends on whether you already have Redis installed on your system. + +### First-time Redis installation + +If this is the first time you've installed Redis on your system, you need to be sure that your `PATH` variable includes the Redis Stack installation location. This location is either `/opt/homebrew/bin` for Apple silicon Macs or `/usr/local/bin` for Intel-based Macs. + +To check this, run: + +{{< highlight bash >}} +echo $PATH +{{< / highlight >}} + +Then, confirm that the output contains `/opt/homebrew/bin` (Apple silicon Macs) or `/usr/local/bin` (Intel Mac). If these directories are not in the output, see the "Existing Redis installation" instructions below. + +{{< note >}} +Because Redis Stack is installed using a brew cask via the `brew tap` command, it will not be integrated with the `brew services` command. +{{< /note >}} + +### Existing Redis installation + +If you have an existing Redis installation on your system, then might want to modify your `$PATH` to ensure that you're using the latest Redis Stack binaries. + +Open the file `~/.bashrc` or `~/zshrc` (depending on your shell), and add the following lines. + +For Intel-based Macs: + +{{< highlight bash >}} +export PATH=/usr/local/Caskroom/redis-stack-server//bin:$PATH +{{< / highlight >}} + +For Apple silicon Macs: + +{{< highlight bash >}} +export PATH=/opt/homebrew/Caskroom/redis-stack-server//bin:$PATH +{{< / highlight >}} + +In both cases, replace `` with your version of Redis Stack. For example, with version 6.2.0, path is as follows: + +{{< highlight bash >}} +export PATH=/opt/homebrew/Caskroom/redis-stack-server/6.2.0/bin:$PATH +{{< / highlight >}} + +### Start Redis server + +You can now start Redis server as follows: + +{{< highlight bash >}} +redis-stack-server +{{< / highlight >}} + +## Uninstall Redis CE + +To uninstall Redis CE, run: + +{{< highlight bash >}} +brew uninstall redis-stack-redisinsight redis-stack-server redis-stack +brew untap redis-stack/redis-stack +{{< / highlight >}} + +## Connect to Redis CE + +Once Redis is running, you can test it by running `redis-cli`: + +{{< highlight bash >}} +redis-cli +{{< / highlight >}} + +Test the connection with the `ping` command: + +{{< highlight bash >}} +127.0.0.1:6379> ping +PONG +{{< / highlight >}} + +You can also test that your Redis server is running using +[Redis Insight]({{< relref "/develop/tools/insight" >}}). + +## Next steps + +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/archive/install-redis#install-redis-properly" >}}) + for production use. diff --git a/content/operate/oss_and_stack/install/install-stack/rpm.md b/content/operate/oss_and_stack/install/install-stack/rpm.md new file mode 100644 index 000000000..0368fed39 --- /dev/null +++ b/content/operate/oss_and_stack/install/install-stack/rpm.md @@ -0,0 +1,42 @@ +--- +categories: +- docs +- operate +- stack +- oss +description: How to install Redis Community Edition via RPM +linkTitle: RPM +title: Install Redis Community Edition on Linux +weight: 3 +--- + +## Install Redis Community Edition (CE) on Red Hat, CentOS, or Rocky Linux via RPM + +See [this page](https://redis.io/downloads/#redis-downloads) for a complete list of supported Red Hat/Rocky platforms. +Follow these steps to install Redis CE. + +1. Create the file `/etc/yum.repos.d/redis.repo` with the following contents. + + {{< highlight bash >}} + [Redis] + name=Redis + baseurl=http://packages.redis.io/rpm/rhel9 # replace rhel9 with the appropriate value for your platform and remove this comment + enabled=1 + gpgcheck=1 + {{< /highlight >}} + +1. Run the following commands: + + {{< highlight bash >}} + curl -fsSL https://packages.redis.io/gpg > /tmp/redis.key + sudo rpm --import /tmp/redis.key + sudo yum install epel-release + sudo yum install redis-server + {{< / highlight >}} + +Redis will not start automatically, nor will it start at boot time. To do this, run the following commands. + +{{< highlight bash >}} +sudo systemctl enable redis-server +sudo systemctl start redis-server +{{< /highlight >}} diff --git a/content/operate/oss_and_stack/install/install-stack/snap.md b/content/operate/oss_and_stack/install/install-stack/snap.md new file mode 100644 index 000000000..6c6d9149e --- /dev/null +++ b/content/operate/oss_and_stack/install/install-stack/snap.md @@ -0,0 +1,60 @@ +--- +categories: +- docs +- operate +- stack +- oss +description: How to install Redis Community Edition via Snap +linkTitle: Snap +title: Install Redis Community Edition on Linux +weight: 4 +--- + +## Install Redis Community Edition (CE) on Ubuntu Linux via Snap + +First, download the latest Redis CE Snap package from [this page](https://redis.io/downloads/). + +To install, run: + +{{< highlight bash >}} +sudo apt update +sudo apt install redis-tools +sudo snap install --dangerous --classic +{{< / highlight >}} + +Redis will not start automatically, nor will it start at boot time. To start `redis-server` in the foreground, run the command: + +{{< highlight bash >}} +sudo snap run redis-server +{{< /highlight >}} + +To stop Redis, enter `Ctrl-C`. + +Follow these steps to integrate Redis CE with `systemd` so you can start/stop in/from the background: + +1. Edit the `/etc/systemd/system/redis-server.service` file and enter the following information: + + {{< highlight text >}} + [Unit] + Description=Redis CE Server + After=network.target + + [Service] + ExecStart=/usr/bin/snap run redis-server + Restart=always + User=root + Group=root + + [Install] + WantedBy=multi-user.target + {{< /highlight >}} + +1. Run the following commands. + + {{< highlight bash >}} + sudo systemctl daemon-reload + sudo systemctl start redis-server + sudo systemctl enable redis-server + {{< /highlight >}} + +If your Linux distribution does not currently have Snap installed, you can install it using the instructions described [here](https://snapcraft.io/docs/installing-snapd). Then, download the appropriate from the [downloads page](https://redis.io/downloads/). diff --git a/content/operate/oss_and_stack/install/install-stack/windows.md b/content/operate/oss_and_stack/install/install-stack/windows.md index 723a14102..238291557 100644 --- a/content/operate/oss_and_stack/install/install-stack/windows.md +++ b/content/operate/oss_and_stack/install/install-stack/windows.md @@ -4,17 +4,18 @@ categories: - operate - stack - oss -description: How to install Redis Stack on Windows +description: How to run Redis Community Edition on Windows linkTitle: Windows -title: Install Redis Stack on Windows -weight: 3 +title: Run Redis Community Edition on Windows using Docker +weight: 7 --- -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. +## Run Redis Community Edition (CE) on Windows using Docker + +To install Redis CE 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 CE 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/linux" >}}), 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. +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 %}} - diff --git a/content/operate/oss_and_stack/stack-with-enterprise/_index.md b/content/operate/oss_and_stack/stack-with-enterprise/_index.md index 99ff7f9c7..a59112d54 100644 --- a/content/operate/oss_and_stack/stack-with-enterprise/_index.md +++ b/content/operate/oss_and_stack/stack-with-enterprise/_index.md @@ -7,7 +7,7 @@ categories: - stack description: null hideListLinks: false -linkTitle: Redis Community Edition and Redis Enterprise +linkTitle: Redis CE and Redis Enterprise weight: 70 aliases: - /operate/modules diff --git a/content/operate/rs/7.4/references/cli-utilities/redis-cli/_index.md b/content/operate/rs/7.4/references/cli-utilities/redis-cli/_index.md index 67ef3d97a..f1d70ee04 100644 --- a/content/operate/rs/7.4/references/cli-utilities/redis-cli/_index.md +++ b/content/operate/rs/7.4/references/cli-utilities/redis-cli/_index.md @@ -24,7 +24,7 @@ When you install Redis Enterprise Software or Redis Community Edition, it also i To learn how to install Redis and `redis-cli`, see the following installation guides: -- [Redis Community Edition]({{< relref "/operate/oss_and_stack/install/install-redis/" >}}) +- [Redis Community Edition]({{< relref "/operate/oss_and_stack/install/install-stack/" >}}) - [Redis Enterprise Software]({{< relref "/operate/rs/installing-upgrading/quickstarts/redis-enterprise-software-quickstart" >}}) diff --git a/content/operate/rs/references/cli-utilities/redis-cli/_index.md b/content/operate/rs/references/cli-utilities/redis-cli/_index.md index fec5a4eee..a1372f6fa 100644 --- a/content/operate/rs/references/cli-utilities/redis-cli/_index.md +++ b/content/operate/rs/references/cli-utilities/redis-cli/_index.md @@ -23,7 +23,7 @@ When you install Redis Enterprise Software or Redis Community Edition, it also i To learn how to install Redis and `redis-cli`, see the following installation guides: -- [Redis Community Edition]({{< relref "/operate/oss_and_stack/install/install-redis/" >}}) +- [Redis Community Edition]({{< relref "/operate/oss_and_stack/install/install-stack/" >}}) - [Redis Enterprise Software]({{< relref "/operate/rs/installing-upgrading/quickstarts/redis-enterprise-software-quickstart" >}}) diff --git a/layouts/operate/list.html b/layouts/operate/list.html index 476c4adf4..6918f3c71 100644 --- a/layouts/operate/list.html +++ b/layouts/operate/list.html @@ -9,9 +9,6 @@ {{ partial "breadcrumbs" . }}

- {{ if and (isset .Params "stack") (eq .Params.stack true)}} - {{ partial "icons/logo-stack.html" (dict "context" . "class" "stack-logo-inline") }} - {{ end }} {{ .Title }}

@@ -23,7 +20,7 @@

{{ $visibleCategories := slice }} {{ range .Params.categories }} - {{ if not (in (slice "docs" "operate" "integrate" "develop") .) }} + {{ if not (in (slice "docs" "operate" "integrate" "develop" "stack") .) }} {{ $visibleCategories = $visibleCategories | append (slice .) }} {{ end }} {{ end }} @@ -42,9 +39,6 @@

{{ else if eq $element "oss" }} {{ $displayName = "Redis Community Edition" }} {{ $color = "#C795E3" }} - {{ else if eq $element "stack" }} - {{ $displayName = "Redis Stack" }} - {{ $color = "#49859C" }} {{ else if eq $element "redisinsight" }} {{ $displayName = "Redis Insight" }} {{ $color = "#FD4439" }} diff --git a/layouts/operate/single.html b/layouts/operate/single.html index 2453cd574..a2cded6da 100644 --- a/layouts/operate/single.html +++ b/layouts/operate/single.html @@ -8,11 +8,7 @@
{{ partial "breadcrumbs" . }}
-

- {{ if and (isset .Params "stack") (eq .Params.stack true)}} - {{ partial "icons/logo-stack.html" (dict "context" . "class" "stack-logo-inline") }} - {{ end }} - {{ .Title }}

+

{{ .Title }}

{{ with .Params.description }}

{{ . | markdownify }}

{{ end }} {{ if .Params.categories }}
@@ -21,7 +17,7 @@

{{ $visibleCategories := slice }} {{ range .Params.categories }} - {{ if not (in (slice "docs" "operate" "integrate" "develop") .) }} + {{ if not (in (slice "docs" "operate" "integrate" "develop" "stack") .) }} {{ $visibleCategories = $visibleCategories | append (slice .) }} {{ end }} {{ end }} @@ -40,9 +36,6 @@

{{ else if eq $element "oss" }} {{ $displayName = "Redis Community Edition" }} {{ $color = "#C795E3" }} - {{ else if eq $element "stack" }} - {{ $displayName = "Redis Stack" }} - {{ $color = "#49859C" }} {{ else if eq $element "redisinsight" }} {{ $displayName = "Redis Insight" }} {{ $color = "#FD4439" }} diff --git a/layouts/partials/docs-nav-int.html b/layouts/partials/docs-nav-int.html index ef22bfd2f..0c2131a66 100644 --- a/layouts/partials/docs-nav-int.html +++ b/layouts/partials/docs-nav-int.html @@ -15,9 +15,6 @@
  • {{ $s.LinkTitle }} - {{ if and (isset $s.Params "stack") (eq $s.Params.stack true)}} - {{ partial "icons/logo-stack.html" (dict "context" . "class" "stack-logo-inline") }} - {{ end }} {{ if and $ulNr $withChild }} {{ if or $active $activePath }}