From 09a6c16a38ede352f1057427814f4f6af936427c Mon Sep 17 00:00:00 2001 From: "David W. Dougherty" Date: Tue, 25 Mar 2025 10:01:04 -0700 Subject: [PATCH 1/9] DEV: add build from source procedures --- .../install/build-stack/_index.md | 16 ++ .../install/build-stack/debian-bookwarm.md | 102 ++++++++++++ .../install/build-stack/debian-bullseye.md | 102 ++++++++++++ .../install/build-stack/rocky-8.md | 148 +++++++++++++++++ .../install/build-stack/rocky-9.md | 150 ++++++++++++++++++ .../install/build-stack/ubuntu-jammy.md | 102 ++++++++++++ .../install/build-stack/ubuntu-noble.md | 102 ++++++++++++ .../install/install-stack/_index.md | 2 +- 8 files changed, 723 insertions(+), 1 deletion(-) create mode 100644 content/operate/oss_and_stack/install/build-stack/_index.md create mode 100644 content/operate/oss_and_stack/install/build-stack/debian-bookwarm.md create mode 100644 content/operate/oss_and_stack/install/build-stack/debian-bullseye.md create mode 100644 content/operate/oss_and_stack/install/build-stack/rocky-8.md create mode 100644 content/operate/oss_and_stack/install/build-stack/rocky-9.md create mode 100644 content/operate/oss_and_stack/install/build-stack/ubuntu-jammy.md create mode 100644 content/operate/oss_and_stack/install/build-stack/ubuntu-noble.md diff --git a/content/operate/oss_and_stack/install/build-stack/_index.md b/content/operate/oss_and_stack/install/build-stack/_index.md new file mode 100644 index 0000000000..d1342b529f --- /dev/null +++ b/content/operate/oss_and_stack/install/build-stack/_index.md @@ -0,0 +1,16 @@ +--- +categories: +- docs +- operate +- stack +- oss +description: Build Redis Community Edition on Linux and macOS +linkTitle: Build Redis CE from source +stack: true +title: Build Redis Community Edition +weight: 20 +bannerText: These build instructions are not yet complete for Redis CE 8.0 GA. For build instructions prior to Redis CE 8.0, see [this page]({{< relref "/operate/oss_and_stack/install/archive/install-redis/install-redis-from-source" >}}). +bannerChildren: true +--- + +Build instruction are provided for the following platforms: diff --git a/content/operate/oss_and_stack/install/build-stack/debian-bookwarm.md b/content/operate/oss_and_stack/install/build-stack/debian-bookwarm.md new file mode 100644 index 0000000000..0017ea44b0 --- /dev/null +++ b/content/operate/oss_and_stack/install/build-stack/debian-bookwarm.md @@ -0,0 +1,102 @@ +--- +categories: +- docs +- operate +- stack +- oss +linkTitle: Debian 12 (Bookworm) +title: Build Redis Community Edition from source on Debian +weight: 5 +--- + +Follow the steps below to build Redis from source on a system running Debian 12 ("bookworm"): + +## 1. Install required dependencies + +First, update your package lists and install the development tools and libraries needed to build Redis: + +```bash +sudo apt-get update +sudo apt-get install -y --no-install-recommends \ + ca-certificates \ + wget \ + dpkg-dev \ + gcc \ + g++ \ + libc6-dev \ + libssl-dev \ + make \ + git \ + cmake \ + python3 \ + python3-pip \ + python3-venv \ + python3-dev \ + unzip \ + rsync \ + clang \ + automake \ + autoconf \ + libtool +``` + +## 2. Download the Redis source code + +Download the Redis source code archive from GitHub. For example, to download version `8.0-m04`: + +```bash +wget -O redis.tar.gz https://github.com/redis/redis/archive/refs/tags/8.0-m04.tar.gz +``` + +Verify the SHA-256 checksum of the archive to ensure integrity: + +```bash +echo "6902a938c629a33f14d49881b1b60e6621c29e445554f882ce7ec48f2743d516 *redis.tar.gz" | sha256sum -c - +``` + +## 3. Extract the source archive + +Create a directory for the source code and extract the contents into it: + +```bash +mkdir -p /usr/src/redis +tar -xzf redis.tar.gz -C /usr/src/redis --strip-components=1 +rm redis.tar.gz +``` + +## 4. Build Redis + +Set the appropriate environment variables to enable TLS, modules, and other build options, then compile and install Redis: + +```bash +export BUILD_TLS=yes +export BUILD_WITH_MODULES=yes +export INSTALL_RUST_TOOLCHAIN=yes +export DISABLE_WERRORS=yes + +make -C /usr/src/redis -j "$(nproc)" all +sudo make -C /usr/src/redis install +``` + +This builds the Redis server, CLI, and any included modules. + +## 5. (Optional) Verify the installation + +You can confirm that Redis has been built and installed successfully by checking the version: + +```bash +redis-server --version +redis-cli --version +``` + +## 6. Starting Redis with modules + +To start Redis with modules like RediSearch, RedisJSON, RedisTimeSeries, and RedisBloom, use the `--loadmodule` option for each module: + +```bash +redis-server \ + --loadmodule /usr/local/lib/redis/modules/redisearch.so \ + --loadmodule /usr/local/lib/redis/modules/rejson.so \ + --loadmodule /usr/local/lib/redis/modules/redistimeseries.so \ + --loadmodule /usr/local/lib/redis/modules/redisbloom.so +``` diff --git a/content/operate/oss_and_stack/install/build-stack/debian-bullseye.md b/content/operate/oss_and_stack/install/build-stack/debian-bullseye.md new file mode 100644 index 0000000000..fb4410caf9 --- /dev/null +++ b/content/operate/oss_and_stack/install/build-stack/debian-bullseye.md @@ -0,0 +1,102 @@ +--- +categories: +- docs +- operate +- stack +- oss +linkTitle: Debian 11 (Bullseye) +title: Build Redis Community Edition from source on Debian +weight: 5 +--- + +Follow the steps below to build Redis from source on a system running Debian 11 ("bullseye"): + +## 1. Install required dependencies + +First, update your package lists and install the development tools and libraries needed to build Redis: + +```bash +sudo apt-get update +sudo apt-get install -y --no-install-recommends \ + ca-certificates \ + wget \ + dpkg-dev \ + gcc \ + g++ \ + libc6-dev \ + libssl-dev \ + make \ + git \ + cmake \ + python3 \ + python3-pip \ + python3-venv \ + python3-dev \ + unzip \ + rsync \ + clang \ + automake \ + autoconf \ + libtool +``` + +## 2. Download the Redis source code + +Download the Redis source code archive from GitHub. For example, to download version `8.0-m04`: + +```bash +wget -O redis.tar.gz https://github.com/redis/redis/archive/refs/tags/8.0-m04.tar.gz +``` + +Verify the SHA-256 checksum of the archive to ensure integrity: + +```bash +echo "6902a938c629a33f14d49881b1b60e6621c29e445554f882ce7ec48f2743d516 *redis.tar.gz" | sha256sum -c - +``` + +## 3. Extract the source archive + +Create a directory for the source code and extract the contents into it: + +```bash +mkdir -p /usr/src/redis +tar -xzf redis.tar.gz -C /usr/src/redis --strip-components=1 +rm redis.tar.gz +``` + +## 4. Build Redis + +Set the appropriate environment variables to enable TLS, modules, and other build options, then compile and install Redis: + +```bash +export BUILD_TLS=yes +export BUILD_WITH_MODULES=yes +export INSTALL_RUST_TOOLCHAIN=yes +export DISABLE_WERRORS=yes + +make -C /usr/src/redis -j "$(nproc)" all +sudo make -C /usr/src/redis install +``` + +This builds the Redis server, CLI, and any included modules. + +## 5. (Optional) Verify the installation + +You can confirm that Redis has been built and installed successfully by checking the version: + +```bash +redis-server --version +redis-cli --version +``` + +## 6. Starting Redis with modules + +To start Redis with modules like RediSearch, RedisJSON, RedisTimeSeries, and RedisBloom, use the `--loadmodule` option for each module: + +```bash +redis-server \ + --loadmodule /usr/local/lib/redis/modules/redisearch.so \ + --loadmodule /usr/local/lib/redis/modules/rejson.so \ + --loadmodule /usr/local/lib/redis/modules/redistimeseries.so \ + --loadmodule /usr/local/lib/redis/modules/redisbloom.so +``` diff --git a/content/operate/oss_and_stack/install/build-stack/rocky-8.md b/content/operate/oss_and_stack/install/build-stack/rocky-8.md new file mode 100644 index 0000000000..1279840279 --- /dev/null +++ b/content/operate/oss_and_stack/install/build-stack/rocky-8.md @@ -0,0 +1,148 @@ +--- +categories: +- docs +- operate +- stack +- oss +linkTitle: Rocky Linux 8 +title: Build Redis Community Edition from source on Rocky Linux +weight: 5 +--- + +Follow the steps below to build Redis from source on a system running Rocky Linux 8: + +## 1. Prepare the system + +Clean the package metadata, enable required repositories, and install development tools: + +```bash +sudo dnf clean all + +# Add GoReleaser repo +sudo tee /etc/yum.repos.d/goreleaser.repo > /dev/null < /dev/null <}}). bannerChildren: true --- From 56c516d8e8d8960b8de1bb51340f6a93dd3ea578 Mon Sep 17 00:00:00 2001 From: "David W. Dougherty" Date: Wed, 26 Mar 2025 08:39:42 -0700 Subject: [PATCH 2/9] Apply review comments; added AlmaLinux and Ubuntu (Focal) pages --- .../install/build-stack/_index.md | 2 +- .../install/build-stack/almalinux-8.md | 153 ++++++++++++++++++ .../install/build-stack/almalinux-9.md | 151 +++++++++++++++++ ...{debian-bookwarm.md => debian-bookworm.md} | 33 ++-- .../install/build-stack/debian-bullseye.md | 30 ++-- .../install/build-stack/rocky-8.md | 37 +++-- .../install/build-stack/rocky-9.md | 39 ++--- .../install/build-stack/ubuntu-focal.md | 128 +++++++++++++++ .../install/build-stack/ubuntu-jammy.md | 29 ++-- .../install/build-stack/ubuntu-noble.md | 29 ++-- 10 files changed, 542 insertions(+), 89 deletions(-) create mode 100644 content/operate/oss_and_stack/install/build-stack/almalinux-8.md create mode 100644 content/operate/oss_and_stack/install/build-stack/almalinux-9.md rename content/operate/oss_and_stack/install/build-stack/{debian-bookwarm.md => debian-bookworm.md} (64%) create mode 100644 content/operate/oss_and_stack/install/build-stack/ubuntu-focal.md diff --git a/content/operate/oss_and_stack/install/build-stack/_index.md b/content/operate/oss_and_stack/install/build-stack/_index.md index d1342b529f..1857512b57 100644 --- a/content/operate/oss_and_stack/install/build-stack/_index.md +++ b/content/operate/oss_and_stack/install/build-stack/_index.md @@ -13,4 +13,4 @@ bannerText: These build instructions are not yet complete for Redis CE 8.0 GA. F bannerChildren: true --- -Build instruction are provided for the following platforms: +Build instructions are provided for the following platforms: diff --git a/content/operate/oss_and_stack/install/build-stack/almalinux-8.md b/content/operate/oss_and_stack/install/build-stack/almalinux-8.md new file mode 100644 index 0000000000..f64f2bf7e7 --- /dev/null +++ b/content/operate/oss_and_stack/install/build-stack/almalinux-8.md @@ -0,0 +1,153 @@ +--- +categories: +- docs +- operate +- stack +- oss +linkTitle: AlmaLinux 8.10 +title: Build Redis Community Edition from source on AlmaLinux 8.10 +weight: 5 +--- + +Follow the steps below to build Redis from source on a system running AlmaLinux 8.10. + +{{< note >}} +Docker was used to produce these build notes. The tested “pulls” are: +- almalinux:8.10 +- almalinux:8.10-minimal +{{< /note >}} + +## 1. Prepare the system + +Clean the package metadata, enable required repositories, and install development tools: + +```bash +sudo dnf clean all + +# Add GoReleaser repo +sudo tee /etc/yum.repos.d/goreleaser.repo > /dev/null <}} +Docker was used to produce these build notes. The tested “pulls” are: +- almalinux:9.5 +- almalinux:9.5-minimal +{{< /note >}} + +## 1. Prepare the system + +Enable the GoReleaser repository and install required packages: + +```bash +sudo tee /etc/yum.repos.d/goreleaser.repo > /dev/null <}} +Docker was used to produce these build notes. The tested "pulls" are: +- Debian:bookworm +- Debian:bookworm-slim +{{< /note >}} ## 1. Install required dependencies First, update your package lists and install the development tools and libraries needed to build Redis: ```bash -sudo apt-get update +apt-get update +apt-get install -y sudo sudo apt-get install -y --no-install-recommends \ ca-certificates \ wget \ @@ -42,16 +49,18 @@ sudo apt-get install -y --no-install-recommends \ ## 2. Download the Redis source code -Download the Redis source code archive from GitHub. For example, to download version `8.0-m04`: +The Redis source code is available from the [Download](https://redis.io/downloads) page. You can verify the integrity of these downloads by checking them against the digests in the [redis-hashes git repository](https://github.com/redis/redis-hashes). + +Download a specific version of the Redis source code zip archive from GitHub. For example, to download version `8.0`: ```bash -wget -O redis.tar.gz https://github.com/redis/redis/archive/refs/tags/8.0-m04.tar.gz +wget -O redis.tar.gz https://github.com/redis/redis/archive/refs/tags/8.0.tar.gz ``` -Verify the SHA-256 checksum of the archive to ensure integrity: +To download the latest stable Redis release, run the following: ```bash -echo "6902a938c629a33f14d49881b1b60e6621c29e445554f882ce7ec48f2743d516 *redis.tar.gz" | sha256sum -c - +wget -O redis.tar.gz https://download.redis.io/redis-stable.tar.gz ``` ## 3. Extract the source archive @@ -89,14 +98,10 @@ redis-server --version redis-cli --version ``` -## 6. Starting Redis with modules +## 6. Start Redis -To start Redis with modules like RediSearch, RedisJSON, RedisTimeSeries, and RedisBloom, use the `--loadmodule` option for each module: +To start Redis, use the following command: ```bash -redis-server \ - --loadmodule /usr/local/lib/redis/modules/redisearch.so \ - --loadmodule /usr/local/lib/redis/modules/rejson.so \ - --loadmodule /usr/local/lib/redis/modules/redistimeseries.so \ - --loadmodule /usr/local/lib/redis/modules/redisbloom.so +redis-server /path/to/redis.conf ``` diff --git a/content/operate/oss_and_stack/install/build-stack/debian-bullseye.md b/content/operate/oss_and_stack/install/build-stack/debian-bullseye.md index fb4410caf9..3e17ae6963 100644 --- a/content/operate/oss_and_stack/install/build-stack/debian-bullseye.md +++ b/content/operate/oss_and_stack/install/build-stack/debian-bullseye.md @@ -5,11 +5,17 @@ categories: - stack - oss linkTitle: Debian 11 (Bullseye) -title: Build Redis Community Edition from source on Debian +title: Build Redis Community Edition from source on Debian 11 (Bullseye) weight: 5 --- -Follow the steps below to build Redis from source on a system running Debian 11 ("bullseye"): +Follow the steps below to build Redis from source on a system running Debian 11 (Bullseye). + +{{< note >}} +Docker was used to produce these build notes. The tested "pulls" are: +- Debian:bullseye +- Debian:bullseye-slim +{{< /note >}} ## 1. Install required dependencies @@ -42,16 +48,18 @@ sudo apt-get install -y --no-install-recommends \ ## 2. Download the Redis source code -Download the Redis source code archive from GitHub. For example, to download version `8.0-m04`: +The Redis source code is available from the [Download](https://redis.io/downloads) page. You can verify the integrity of these downloads by checking them against the digests in the [redis-hashes git repository](https://github.com/redis/redis-hashes). + +Download a specific version of the Redis source code zip archive from GitHub. For example, to download version `8.0`: ```bash -wget -O redis.tar.gz https://github.com/redis/redis/archive/refs/tags/8.0-m04.tar.gz +wget -O redis.tar.gz https://github.com/redis/redis/archive/refs/tags/8.0.tar.gz ``` -Verify the SHA-256 checksum of the archive to ensure integrity: +To download the latest stable Redis release, run the following: ```bash -echo "6902a938c629a33f14d49881b1b60e6621c29e445554f882ce7ec48f2743d516 *redis.tar.gz" | sha256sum -c - +wget -O redis.tar.gz https://download.redis.io/redis-stable.tar.gz ``` ## 3. Extract the source archive @@ -89,14 +97,10 @@ redis-server --version redis-cli --version ``` -## 6. Starting Redis with modules +## 6. Start Redis -To start Redis with modules like RediSearch, RedisJSON, RedisTimeSeries, and RedisBloom, use the `--loadmodule` option for each module: +To start Redis, use the following command: ```bash -redis-server \ - --loadmodule /usr/local/lib/redis/modules/redisearch.so \ - --loadmodule /usr/local/lib/redis/modules/rejson.so \ - --loadmodule /usr/local/lib/redis/modules/redistimeseries.so \ - --loadmodule /usr/local/lib/redis/modules/redisbloom.so +redis-server /path/to/redis.conf ``` diff --git a/content/operate/oss_and_stack/install/build-stack/rocky-8.md b/content/operate/oss_and_stack/install/build-stack/rocky-8.md index 1279840279..a7332f0f6c 100644 --- a/content/operate/oss_and_stack/install/build-stack/rocky-8.md +++ b/content/operate/oss_and_stack/install/build-stack/rocky-8.md @@ -4,12 +4,18 @@ categories: - operate - stack - oss -linkTitle: Rocky Linux 8 -title: Build Redis Community Edition from source on Rocky Linux +linkTitle: Rocky Linux 8.10 +title: Build Redis Community Edition from source on Rocky Linux 8.10 weight: 5 --- -Follow the steps below to build Redis from source on a system running Rocky Linux 8: +Follow the steps below to build Redis from source on a system running Rocky Linux 8.10. + +{{< note >}} +Docker was used to produce these build notes. The tested “pulls” are: +- rockylinux/rockylinux:8.10 +- rockylinux/rockylinux:8.10-minimal +{{< /note >}} ## 1. Prepare the system @@ -98,15 +104,18 @@ cmake --version ## 4. Download and extract the Redis source -Download Redis 8.0-m04 and verify its checksum: +The Redis source code is available from the [Download](https://redis.io/downloads) page. You can verify the integrity of these downloads by checking them against the digests in the [redis-hashes git repository](https://github.com/redis/redis-hashes). + +Download a specific version of the Redis source code zip archive from GitHub. For example, to download version `8.0`: ```bash -wget -O redis.tar.gz https://github.com/redis/redis/archive/refs/tags/8.0-m04.tar.gz -echo "6902a938c629a33f14d49881b1b60e6621c29e445554f882ce7ec48f2743d516 *redis.tar.gz" | sha256sum -c - +wget -O redis.tar.gz https://github.com/redis/redis/archive/refs/tags/8.0.tar.gz +``` -mkdir -p /usr/src/redis -tar -xzf redis.tar.gz -C /usr/src/redis --strip-components=1 -rm redis.tar.gz +To download the latest stable Redis release, run the following: + +```bash +wget -O redis.tar.gz https://download.redis.io/redis-stable.tar.gz ``` ## 5. Build Redis @@ -135,14 +144,10 @@ redis-server --version redis-cli --version ``` -## 7. Starting Redis with modules +## 7. Start Redis -To start Redis with RediSearch, RedisJSON, RedisTimeSeries, and RedisBloom modules, use the following command: +To start Redis, use the following command: ```bash -redis-server \ - --loadmodule /usr/local/lib/redis/modules/redisearch.so \ - --loadmodule /usr/local/lib/redis/modules/rejson.so \ - --loadmodule /usr/local/lib/redis/modules/redistimeseries.so \ - --loadmodule /usr/local/lib/redis/modules/redisbloom.so +redis-server /path/to/redis.conf ``` diff --git a/content/operate/oss_and_stack/install/build-stack/rocky-9.md b/content/operate/oss_and_stack/install/build-stack/rocky-9.md index fad819d7f7..703d34d765 100644 --- a/content/operate/oss_and_stack/install/build-stack/rocky-9.md +++ b/content/operate/oss_and_stack/install/build-stack/rocky-9.md @@ -4,12 +4,18 @@ categories: - operate - stack - oss -linkTitle: Rocky Linux 9 -title: Build Redis Community Edition from source on Rocky Linux +linkTitle: Rocky Linux 9.5 +title: Build Redis Community Edition from source on Rocky Linux 9.5 weight: 5 --- -Follow the steps below to build Redis from source on a system running Rocky Linux 9: +Follow the steps below to build Redis from source on a system running Rocky Linux 9.5. + +{{< note >}} +Docker was used to produce these build notes. The tested “pulls” are: +- rockylinux/rockylinux:9.5 +- rockylinux/rockylinux:9.5-minimal +{{< /note >}} ## 1. Prepare the system @@ -96,18 +102,18 @@ cmake --version ## 4. Download and extract the Redis source -Download Redis 8.0-m04 and verify its SHA-256 checksum: +The Redis source code is available from the [Download](https://redis.io/downloads) page. You can verify the integrity of these downloads by checking them against the digests in the [redis-hashes git repository](https://github.com/redis/redis-hashes). -```bash -wget -O redis.tar.gz https://github.com/redis/redis/archive/refs/tags/8.0-m04.tar.gz -echo "6902a938c629a33f14d49881b1b60e6621c29e445554f882ce7ec48f2743d516 *redis.tar.gz" | sha256sum -c - +Download a specific version of the Redis source code zip archive from GitHub. For example, to download version `8.0`: -mkdir -p /usr/src/redis +```bash +wget -O redis.tar.gz https://github.com/redis/redis/archive/refs/tags/8.0.tar.gz +``` -# Extract and remove the archive +To download the latest stable Redis release, run the following: -tar -xzf redis.tar.gz -C /usr/src/redis --strip-components=1 -rm redis.tar.gz +```bash +wget -O redis.tar.gz https://download.redis.io/redis-stable.tar.gz ``` ## 5. Build Redis @@ -136,15 +142,10 @@ redis-server --version redis-cli --version ``` -## 7. Starting Redis with modules +## 7. Start Redis -To start Redis with RediSearch, RedisJSON, RedisTimeSeries, and RedisBloom modules, use the following command: +To start Redis, use the following command: ```bash -redis-server \ - --loadmodule /usr/local/lib/redis/modules/redisearch.so \ - --loadmodule /usr/local/lib/redis/modules/rejson.so \ - --loadmodule /usr/local/lib/redis/modules/redistimeseries.so \ - --loadmodule /usr/local/lib/redis/modules/redisbloom.so +redis-server /path/to/redis.conf ``` - diff --git a/content/operate/oss_and_stack/install/build-stack/ubuntu-focal.md b/content/operate/oss_and_stack/install/build-stack/ubuntu-focal.md new file mode 100644 index 0000000000..132c913891 --- /dev/null +++ b/content/operate/oss_and_stack/install/build-stack/ubuntu-focal.md @@ -0,0 +1,128 @@ +--- +categories: +- docs +- operate +- stack +- oss +linkTitle: Ubuntu 20.04 (Focal) +title: Build Redis Community Edition from source on Ubuntu 20.04 (Focal) +weight: 5 +--- + +Follow the steps below to build Redis from source on a system running Ubuntu 20.04 (Focal). + +{{< note >}} +Docker was used to produce these build notes. The tested “pulls” are: +- ubuntu:20.04 +{{< /note >}} + +## 1. Install required dependencies + +Update your package lists and install the necessary development tools and libraries: + +```bash +sudo apt-get update +sudo apt-get install -y --no-install-recommends \ + ca-certificates \ + wget \ + dpkg-dev \ + gcc \ + g++ \ + libc6-dev \ + libssl-dev \ + make \ + git \ + python3 \ + python3-pip \ + python3-venv \ + python3-dev \ + unzip \ + rsync \ + clang \ + automake \ + autoconf \ + gcc-10 \ + g++-10 \ + libtool +``` + +## 2. Use GCC 10 as the default compiler + +Update the system's default compiler to GCC 10: + +```bash +sudo update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-10 100 --slave /usr/bin/g++ g++ /usr/bin/g++-10 +``` + +## 3. Install CMake + +Install CMake using `pip3` and link it for system-wide access: + +```bash +pip3 install cmake +sudo ln -sf /usr/local/bin/cmake /usr/bin/cmake +cmake --version +``` + +## 4. Download the Redis source + +The Redis source code is available from the [Download](https://redis.io/downloads) page. You can verify the integrity of these downloads by checking them against the digests in the [redis-hashes git repository](https://github.com/redis/redis-hashes). + +Download a specific version of the Redis source code zip archive from GitHub. For example, to download version `8.0`: + +```bash +wget -O redis.tar.gz https://github.com/redis/redis/archive/refs/tags/8.0.tar.gz +``` + +To download the latest stable Redis release, run the following: + +```bash +wget -O redis.tar.gz https://download.redis.io/redis-stable.tar.gz +``` + +## 5. Extract the source archive + +Create a directory for the source code and extract the contents into it: + +```bash +mkdir -p /usr/src/redis +tar -xzf redis.tar.gz -C /usr/src/redis --strip-components=1 +rm redis.tar.gz +``` + +## 6. Build Redis + +Set the necessary environment variables and compile Redis: + +```bash +export BUILD_TLS=yes +export BUILD_WITH_MODULES=yes +export INSTALL_RUST_TOOLCHAIN=yes +export DISABLE_WERRORS=yes + +make -C /usr/src/redis -j "$(nproc)" all +sudo make -C /usr/src/redis install +``` + +Create the module directory: + +```bash +sudo mkdir -p /usr/local/lib/redis/modules/ +``` + +## 7. (Optional) Verify the installation + +Confirm the Redis installation: + +```bash +redis-server --version +redis-cli --version +``` + +## 8. Start Redis + +To start Redis, use the following command: + +```bash +redis-server /path/to/redis.conf +``` diff --git a/content/operate/oss_and_stack/install/build-stack/ubuntu-jammy.md b/content/operate/oss_and_stack/install/build-stack/ubuntu-jammy.md index 1ffa6ee1a0..cba5231ab7 100644 --- a/content/operate/oss_and_stack/install/build-stack/ubuntu-jammy.md +++ b/content/operate/oss_and_stack/install/build-stack/ubuntu-jammy.md @@ -5,11 +5,16 @@ categories: - stack - oss linkTitle: Ubuntu 22.04 (Jammy) -title: Build Redis Community Edition from source on Ubuntu +title: Build Redis Community Edition from source on Ubuntu 22.04 (Jammy) weight: 5 --- -Follow the steps below to build Redis from source on a system running Ubuntu 22.04 ("jammy"): +Follow the steps below to build Redis from source on a system running Ubuntu 22.04 (Jammy). + +{{< note >}} +Docker was used to produce these build notes. The tested “pulls” are: +- ubuntu:22.04 +{{< /note >}} ## 1. Install required dependencies @@ -42,16 +47,18 @@ sudo apt-get install -y --no-install-recommends \ ## 2. Download the Redis source code -Download the Redis source code archive from GitHub. For example, to download version `8.0-m04`: +The Redis source code is available from the [Download](https://redis.io/downloads) page. You can verify the integrity of these downloads by checking them against the digests in the [redis-hashes git repository](https://github.com/redis/redis-hashes). + +Download a specific version of the Redis source code zip archive from GitHub. For example, to download version `8.0`: ```bash -wget -O redis.tar.gz https://github.com/redis/redis/archive/refs/tags/8.0-m04.tar.gz +wget -O redis.tar.gz https://github.com/redis/redis/archive/refs/tags/8.0.tar.gz ``` -Verify the SHA-256 checksum of the archive to ensure integrity: +To download the latest stable Redis release, run the following: ```bash -echo "6902a938c629a33f14d49881b1b60e6621c29e445554f882ce7ec48f2743d516 *redis.tar.gz" | sha256sum -c - +wget -O redis.tar.gz https://download.redis.io/redis-stable.tar.gz ``` ## 3. Extract the source archive @@ -89,14 +96,10 @@ redis-server --version redis-cli --version ``` -## 6. Starting Redis with modules +## 6. Start Redis -To start Redis with modules like RediSearch, RedisJSON, RedisTimeSeries, and RedisBloom, use the `--loadmodule` option for each module: +To start Redis, use the following command: ```bash -redis-server \ - --loadmodule /usr/local/lib/redis/modules/redisearch.so \ - --loadmodule /usr/local/lib/redis/modules/rejson.so \ - --loadmodule /usr/local/lib/redis/modules/redistimeseries.so \ - --loadmodule /usr/local/lib/redis/modules/redisbloom.so +redis-server /path/to/redis.conf ``` diff --git a/content/operate/oss_and_stack/install/build-stack/ubuntu-noble.md b/content/operate/oss_and_stack/install/build-stack/ubuntu-noble.md index d67470f11c..d002b979ca 100644 --- a/content/operate/oss_and_stack/install/build-stack/ubuntu-noble.md +++ b/content/operate/oss_and_stack/install/build-stack/ubuntu-noble.md @@ -5,11 +5,16 @@ categories: - stack - oss linkTitle: Ubuntu 24.04 (Noble) -title: Build Redis Community Edition from source on Ubuntu +title: Build Redis Community Edition from source on Ubuntu 24.04 (Noble) weight: 5 --- -Follow the steps below to build Redis from source on a system running Ubuntu 24.04 ("noble"): +Follow the steps below to build Redis from source on a system running Ubuntu 24.04 (Noble). + +{{< note >}} +Docker was used to produce these build notes. The tested “pulls” are: +- ubuntu:24.04 +{{< /note >}} ## 1. Install required dependencies @@ -42,16 +47,18 @@ sudo apt-get install -y --no-install-recommends \ ## 2. Download the Redis source code -Download the Redis source code archive from GitHub. For example, to download version `8.0-m04`: +The Redis source code is available from the [Download](https://redis.io/downloads) page. You can verify the integrity of these downloads by checking them against the digests in the [redis-hashes git repository](https://github.com/redis/redis-hashes). + +Download a specific version of the Redis source code zip archive from GitHub. For example, to download version `8.0`: ```bash -wget -O redis.tar.gz https://github.com/redis/redis/archive/refs/tags/8.0-m04.tar.gz +wget -O redis.tar.gz https://github.com/redis/redis/archive/refs/tags/8.0.tar.gz ``` -Verify the SHA-256 checksum of the archive to ensure integrity: +To download the latest stable Redis release, run the following: ```bash -echo "6902a938c629a33f14d49881b1b60e6621c29e445554f882ce7ec48f2743d516 *redis.tar.gz" | sha256sum -c - +wget -O redis.tar.gz https://download.redis.io/redis-stable.tar.gz ``` ## 3. Extract the source archive @@ -89,14 +96,10 @@ redis-server --version redis-cli --version ``` -## 6. Starting Redis with modules +## 6. Start Redis -To start Redis with modules like RediSearch, RedisJSON, RedisTimeSeries, and RedisBloom, use the `--loadmodule` option for each module: +To start Redis, use the following command: ```bash -redis-server \ - --loadmodule /usr/local/lib/redis/modules/redisearch.so \ - --loadmodule /usr/local/lib/redis/modules/rejson.so \ - --loadmodule /usr/local/lib/redis/modules/redistimeseries.so \ - --loadmodule /usr/local/lib/redis/modules/redisbloom.so +redis-server /path/to/redis.conf ``` From 7888116450518e9d4d83cc3de7b70cb53d02575d Mon Sep 17 00:00:00 2001 From: "David W. Dougherty" Date: Thu, 27 Mar 2025 06:50:36 -0700 Subject: [PATCH 3/9] Apply review comments; merged alma/rocky pages; added stubs for macOS --- .../install/build-stack/almalinux-8.md | 16 +- .../install/build-stack/almalinux-9.md | 18 ++- .../install/build-stack/debian-bookworm.md | 4 +- .../install/build-stack/debian-bullseye.md | 4 +- .../install/build-stack/macos-13.md | 14 ++ .../install/build-stack/macos-14.md | 14 ++ .../install/build-stack/macos-15.md | 14 ++ .../install/build-stack/rocky-8.md | 153 ------------------ .../install/build-stack/rocky-9.md | 151 ----------------- .../install/build-stack/ubuntu-focal.md | 4 +- .../install/build-stack/ubuntu-jammy.md | 4 +- .../install/build-stack/ubuntu-noble.md | 4 +- 12 files changed, 73 insertions(+), 327 deletions(-) create mode 100644 content/operate/oss_and_stack/install/build-stack/macos-13.md create mode 100644 content/operate/oss_and_stack/install/build-stack/macos-14.md create mode 100644 content/operate/oss_and_stack/install/build-stack/macos-15.md delete mode 100644 content/operate/oss_and_stack/install/build-stack/rocky-8.md delete mode 100644 content/operate/oss_and_stack/install/build-stack/rocky-9.md diff --git a/content/operate/oss_and_stack/install/build-stack/almalinux-8.md b/content/operate/oss_and_stack/install/build-stack/almalinux-8.md index f64f2bf7e7..77914d48ba 100644 --- a/content/operate/oss_and_stack/install/build-stack/almalinux-8.md +++ b/content/operate/oss_and_stack/install/build-stack/almalinux-8.md @@ -4,17 +4,21 @@ categories: - operate - stack - oss -linkTitle: AlmaLinux 8.10 -title: Build Redis Community Edition from source on AlmaLinux 8.10 +linkTitle: AlmaLinux/Rocky 8.10 +title: Build Redis Community Edition from source on AlmaLinux/Rocky Linux 8.10 weight: 5 --- -Follow the steps below to build Redis from source on a system running AlmaLinux 8.10. +Follow the steps below to build Redis from source on a system running AlmaLinux and Rocky Linux 8.10. {{< note >}} -Docker was used to produce these build notes. The tested “pulls” are: -- almalinux:8.10 -- almalinux:8.10-minimal +Docker images used to produce these build notes: +- AlmaLinux: + - almalinux:8.10 + - almalinux:8.10-minimal +- Rocky Linux: + - rockylinux/rockylinux:8.10 + - rockylinux/rockylinux:8.10-minimal {{< /note >}} ## 1. Prepare the system diff --git a/content/operate/oss_and_stack/install/build-stack/almalinux-9.md b/content/operate/oss_and_stack/install/build-stack/almalinux-9.md index 4ed4e8bfa5..4bb2f1d80a 100644 --- a/content/operate/oss_and_stack/install/build-stack/almalinux-9.md +++ b/content/operate/oss_and_stack/install/build-stack/almalinux-9.md @@ -4,17 +4,21 @@ categories: - operate - stack - oss -linkTitle: AlmaLinux 9.5 -title: Build Redis Community Edition from source on AlmaLinux 9.5 -weight: 5 +linkTitle: AlmaLinux/Rocky 9.5 +title: Build Redis Community Edition from source on AlmaLinux/Rocky Linux 9.5 +weight: 10 --- -Follow the steps below to build Redis from source on a system running AlmaLinux 9.5. +Follow the steps below to build Redis from source on a system running AlmaLinux and Rocky Linux 9.5. {{< note >}} -Docker was used to produce these build notes. The tested “pulls” are: -- almalinux:9.5 -- almalinux:9.5-minimal +Docker images used to produce these build notes: +- AlmaLinux: + - almalinux:9.5 + - almalinux:9.5-minimal +- Rocky Linux: + - rockylinux/rockylinux:9.5 + - rockylinux/rockylinux:9.5-minimal {{< /note >}} ## 1. Prepare the system diff --git a/content/operate/oss_and_stack/install/build-stack/debian-bookworm.md b/content/operate/oss_and_stack/install/build-stack/debian-bookworm.md index 99c06afb0e..f2e29be345 100644 --- a/content/operate/oss_and_stack/install/build-stack/debian-bookworm.md +++ b/content/operate/oss_and_stack/install/build-stack/debian-bookworm.md @@ -6,13 +6,13 @@ categories: - oss linkTitle: Debian 12 (Bookworm) title: Build Redis Community Edition from source on Debian 12 (Bookworm) -weight: 5 +weight: 15 --- Follow the steps below to build Redis from source on a system running Debian 12 (Bookworm). {{< note >}} -Docker was used to produce these build notes. The tested "pulls" are: +Docker images used to produce these build notes: - Debian:bookworm - Debian:bookworm-slim {{< /note >}} diff --git a/content/operate/oss_and_stack/install/build-stack/debian-bullseye.md b/content/operate/oss_and_stack/install/build-stack/debian-bullseye.md index 3e17ae6963..e6e6712749 100644 --- a/content/operate/oss_and_stack/install/build-stack/debian-bullseye.md +++ b/content/operate/oss_and_stack/install/build-stack/debian-bullseye.md @@ -6,13 +6,13 @@ categories: - oss linkTitle: Debian 11 (Bullseye) title: Build Redis Community Edition from source on Debian 11 (Bullseye) -weight: 5 +weight: 20 --- Follow the steps below to build Redis from source on a system running Debian 11 (Bullseye). {{< note >}} -Docker was used to produce these build notes. The tested "pulls" are: +Docker images used to produce these build notes: - Debian:bullseye - Debian:bullseye-slim {{< /note >}} diff --git a/content/operate/oss_and_stack/install/build-stack/macos-13.md b/content/operate/oss_and_stack/install/build-stack/macos-13.md new file mode 100644 index 0000000000..7da460b9de --- /dev/null +++ b/content/operate/oss_and_stack/install/build-stack/macos-13.md @@ -0,0 +1,14 @@ +--- +categories: +- docs +- operate +- stack +- oss +linkTitle: macOS 13 (Ventura) +title: Build Redis Community Edition from source on macOS 13 (Ventura) +weight: 50 +--- + +Follow the steps below to build Redis from source on a system running macOS 13 (Ventura). + +Steps TBP. \ No newline at end of file diff --git a/content/operate/oss_and_stack/install/build-stack/macos-14.md b/content/operate/oss_and_stack/install/build-stack/macos-14.md new file mode 100644 index 0000000000..483d0da17e --- /dev/null +++ b/content/operate/oss_and_stack/install/build-stack/macos-14.md @@ -0,0 +1,14 @@ +--- +categories: +- docs +- operate +- stack +- oss +linkTitle: macOS 14 (Sonoma) +title: Build Redis Community Edition from source on macOS 14 (Sonoma) +weight: 45 +--- + +Follow the steps below to build Redis from source on a system running macOS 14 (Sonoma). + +Steps TBP. \ No newline at end of file diff --git a/content/operate/oss_and_stack/install/build-stack/macos-15.md b/content/operate/oss_and_stack/install/build-stack/macos-15.md new file mode 100644 index 0000000000..08c9d744a0 --- /dev/null +++ b/content/operate/oss_and_stack/install/build-stack/macos-15.md @@ -0,0 +1,14 @@ +--- +categories: +- docs +- operate +- stack +- oss +linkTitle: macOS 15 (Sequoia) +title: Build Redis Community Edition from source on macOS 15 (Sequoia) +weight: 40 +--- + +Follow the steps below to build Redis from source on a system running macOS 15 (Sequoia). + +Steps TBP. \ No newline at end of file diff --git a/content/operate/oss_and_stack/install/build-stack/rocky-8.md b/content/operate/oss_and_stack/install/build-stack/rocky-8.md deleted file mode 100644 index a7332f0f6c..0000000000 --- a/content/operate/oss_and_stack/install/build-stack/rocky-8.md +++ /dev/null @@ -1,153 +0,0 @@ ---- -categories: -- docs -- operate -- stack -- oss -linkTitle: Rocky Linux 8.10 -title: Build Redis Community Edition from source on Rocky Linux 8.10 -weight: 5 ---- - -Follow the steps below to build Redis from source on a system running Rocky Linux 8.10. - -{{< note >}} -Docker was used to produce these build notes. The tested “pulls” are: -- rockylinux/rockylinux:8.10 -- rockylinux/rockylinux:8.10-minimal -{{< /note >}} - -## 1. Prepare the system - -Clean the package metadata, enable required repositories, and install development tools: - -```bash -sudo dnf clean all - -# Add GoReleaser repo -sudo tee /etc/yum.repos.d/goreleaser.repo > /dev/null <}} -Docker was used to produce these build notes. The tested “pulls” are: -- rockylinux/rockylinux:9.5 -- rockylinux/rockylinux:9.5-minimal -{{< /note >}} - -## 1. Prepare the system - -Enable the GoReleaser repository and install required packages: - -```bash -sudo tee /etc/yum.repos.d/goreleaser.repo > /dev/null <}} -Docker was used to produce these build notes. The tested “pulls” are: +Docker images used to produce these build notes: - ubuntu:20.04 {{< /note >}} diff --git a/content/operate/oss_and_stack/install/build-stack/ubuntu-jammy.md b/content/operate/oss_and_stack/install/build-stack/ubuntu-jammy.md index cba5231ab7..c3afa057f2 100644 --- a/content/operate/oss_and_stack/install/build-stack/ubuntu-jammy.md +++ b/content/operate/oss_and_stack/install/build-stack/ubuntu-jammy.md @@ -6,13 +6,13 @@ categories: - oss linkTitle: Ubuntu 22.04 (Jammy) title: Build Redis Community Edition from source on Ubuntu 22.04 (Jammy) -weight: 5 +weight: 30 --- Follow the steps below to build Redis from source on a system running Ubuntu 22.04 (Jammy). {{< note >}} -Docker was used to produce these build notes. The tested “pulls” are: +Docker images used to produce these build notes: - ubuntu:22.04 {{< /note >}} diff --git a/content/operate/oss_and_stack/install/build-stack/ubuntu-noble.md b/content/operate/oss_and_stack/install/build-stack/ubuntu-noble.md index d002b979ca..1dff3ff52b 100644 --- a/content/operate/oss_and_stack/install/build-stack/ubuntu-noble.md +++ b/content/operate/oss_and_stack/install/build-stack/ubuntu-noble.md @@ -6,13 +6,13 @@ categories: - oss linkTitle: Ubuntu 24.04 (Noble) title: Build Redis Community Edition from source on Ubuntu 24.04 (Noble) -weight: 5 +weight: 35 --- Follow the steps below to build Redis from source on a system running Ubuntu 24.04 (Noble). {{< note >}} -Docker was used to produce these build notes. The tested “pulls” are: +Docker images used to produce these build notes: - ubuntu:24.04 {{< /note >}} From 29b55ac977b740025740184831ce4b9065bd53e9 Mon Sep 17 00:00:00 2001 From: "David W. Dougherty" Date: Thu, 27 Mar 2025 12:26:32 -0700 Subject: [PATCH 4/9] Added macOS 13/14 page --- .../oss_and_stack/install/archive/_index.md | 4 +- .../{almalinux-8.md => almalinux-rocky-8.md} | 6 ++ .../{almalinux-9.md => almalinux-rocky-9.md} | 6 ++ .../install/build-stack/macos-13-14.md | 100 ++++++++++++++++++ .../install/build-stack/macos-13.md | 14 --- .../install/build-stack/macos-14.md | 14 --- .../install/build-stack/macos-15.md | 2 +- 7 files changed, 115 insertions(+), 31 deletions(-) rename content/operate/oss_and_stack/install/build-stack/{almalinux-8.md => almalinux-rocky-8.md} (98%) rename content/operate/oss_and_stack/install/build-stack/{almalinux-9.md => almalinux-rocky-9.md} (98%) create mode 100644 content/operate/oss_and_stack/install/build-stack/macos-13-14.md delete mode 100644 content/operate/oss_and_stack/install/build-stack/macos-13.md delete mode 100644 content/operate/oss_and_stack/install/build-stack/macos-14.md diff --git a/content/operate/oss_and_stack/install/archive/_index.md b/content/operate/oss_and_stack/install/archive/_index.md index fb45c3a516..b8c76ce808 100644 --- a/content/operate/oss_and_stack/install/archive/_index.md +++ b/content/operate/oss_and_stack/install/archive/_index.md @@ -17,7 +17,7 @@ You can install [Redis](https://redis.io/about/) or [Redis Stack](https://redis. Here are the installation instructions: -* [Install Redis]({{< relref "/operate/oss_and_stack/install/install-redis" >}}) -* [Install Redis Stack]({{< relref "/operate/oss_and_stack/install/install-stack" >}}) +* [Install Redis]({{< relref "/operate/oss_and_stack/install/archive/install-redis" >}}) +* [Install Redis Stack]({{< relref "/operate/oss_and_stack/install/archive/install-stack" >}}) While you can install Redis or Redis Stack 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). diff --git a/content/operate/oss_and_stack/install/build-stack/almalinux-8.md b/content/operate/oss_and_stack/install/build-stack/almalinux-rocky-8.md similarity index 98% rename from content/operate/oss_and_stack/install/build-stack/almalinux-8.md rename to content/operate/oss_and_stack/install/build-stack/almalinux-rocky-8.md index 77914d48ba..96536f1ba1 100644 --- a/content/operate/oss_and_stack/install/build-stack/almalinux-8.md +++ b/content/operate/oss_and_stack/install/build-stack/almalinux-rocky-8.md @@ -122,6 +122,12 @@ To download the latest stable Redis release, run the following: wget -O redis.tar.gz https://download.redis.io/redis-stable.tar.gz ``` +Extract the source: + +```bash +tar xvf redis.tar.gz +``` + ## 5. Build Redis Enable the GCC toolset and build Redis with support for TLS and modules: diff --git a/content/operate/oss_and_stack/install/build-stack/almalinux-9.md b/content/operate/oss_and_stack/install/build-stack/almalinux-rocky-9.md similarity index 98% rename from content/operate/oss_and_stack/install/build-stack/almalinux-9.md rename to content/operate/oss_and_stack/install/build-stack/almalinux-rocky-9.md index 4bb2f1d80a..e9f40397d9 100644 --- a/content/operate/oss_and_stack/install/build-stack/almalinux-9.md +++ b/content/operate/oss_and_stack/install/build-stack/almalinux-rocky-9.md @@ -120,6 +120,12 @@ To download the latest stable Redis release, run the following: wget -O redis.tar.gz https://download.redis.io/redis-stable.tar.gz ``` +Extract the source: + +```bash +tar xvf redis.tar.gz +``` + ## 5. Build Redis Enable the GCC toolset and compile Redis with TLS and module support: diff --git a/content/operate/oss_and_stack/install/build-stack/macos-13-14.md b/content/operate/oss_and_stack/install/build-stack/macos-13-14.md new file mode 100644 index 0000000000..85090cb4db --- /dev/null +++ b/content/operate/oss_and_stack/install/build-stack/macos-13-14.md @@ -0,0 +1,100 @@ +--- +categories: +- docs +- operate +- stack +- oss +linkTitle: macOS 13 / macOS 14 +title: Build Redis Community Edition from source on macOS 13 (Ventura) and macOS 14 (Sonoma) +weight: 50 +--- + +Follow the steps below to build Redis from source on a system running macOS 13 (Ventura) and macOS 14 (Sonoma). + +## 1. Install homebrew + +If Homebrew isn't already installed, follow the installation instructions on the [Homebrew home page](https://brew.sh). + +## 2. Install required packages + +``` +export HOMEBREW_NO_AUTO_UPDATE=1 +brew update +brew install coreutils +brew install make +brew install openssl +brew install llvm@18 +brew install cmake +brew install gnu-sed +brew install automake +brew install libtool +brew install wget +``` + +## 3. Install Rust + +Rust is required to build the JSON package. + +``` +RUST_INSTALLER=rust-1.80.1-$(if [ "$(uname -m)" = "arm64" ]; then echo "aarch64"; else echo "x86_64"; fi)-apple-darwin +wget --quiet -O ${RUST_INSTALLER}.tar.xz https://static.rust-lang.org/dist/${RUST_INSTALLER}.tar.xz +tar -xf ${RUST_INSTALLER}.tar.xz +(cd ${RUST_INSTALLER} && sudo ./install.sh) +``` + +## 4. Download and extract the Redis source + +The Redis source code is available from the [Download](https://redis.io/downloads) page. You can verify the integrity of these downloads by checking them against the digests in the [redis-hashes git repository](https://github.com/redis/redis-hashes). + +Download a specific version of the Redis source code from GitHub. For example, to download version `8.0`: + +```bash +wget -O redis.tar.gz https://github.com/redis/redis/archive/refs/tags/8.0.tar.gz +``` + +To download the latest stable Redis release, run the following: + +```bash +wget -O redis.tar.gz https://download.redis.io/redis-stable.tar.gz +``` + +Extract the source: + +```bash +tar xvf redis.tar.gz +``` + +## 5. Build Redis + +``` +export HOMEBREW_PREFIX="$(brew --prefix)" +export BUILD_WITH_MODULES=yes +export BUILD_TLS=yes +export DISABLE_WERRORS=yes +PATH="$HOMEBREW_PREFIX/opt/libtool/libexec/gnubin:$HOMEBREW_PREFIX/opt/llvm@18/bin:$HOMEBREW_PREFIX/opt/make/libexec/gnubin:$HOMEBREW_PREFIX/opt/gnu-sed/libexec/gnubin:$HOMEBREW_PREFIX/opt/coreutils/libexec/gnubin:$PATH" +export LDFLAGS="-L$HOMEBREW_PREFIX/opt/llvm@18/lib" +export CPPFLAGS="-I$HOMEBREW_PREFIX/opt/llvm@18/include" + +mkdir -p build_dir/etc +make -C redis-8.0 -j "$(nproc)" all OS=macos +make -C redis-8.0 install PREFIX=$(pwd)/build_dir OS=macos +``` + +## 6. (Optional) Verify the installation + +Check the installed Redis server and CLI versions: + +```bash +build_dir/bin/redis-server --version +build_dir/bin/redis-cli --version +``` + +## 7. Start Redis + +To start Redis, use the following command: + +```bash +export LC_ALL=en_US.UTF-8 +export LANG=en_US.UTF-8 +build_dir/bin/redis-server /path/to/redis.conf +``` diff --git a/content/operate/oss_and_stack/install/build-stack/macos-13.md b/content/operate/oss_and_stack/install/build-stack/macos-13.md deleted file mode 100644 index 7da460b9de..0000000000 --- a/content/operate/oss_and_stack/install/build-stack/macos-13.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -categories: -- docs -- operate -- stack -- oss -linkTitle: macOS 13 (Ventura) -title: Build Redis Community Edition from source on macOS 13 (Ventura) -weight: 50 ---- - -Follow the steps below to build Redis from source on a system running macOS 13 (Ventura). - -Steps TBP. \ No newline at end of file diff --git a/content/operate/oss_and_stack/install/build-stack/macos-14.md b/content/operate/oss_and_stack/install/build-stack/macos-14.md deleted file mode 100644 index 483d0da17e..0000000000 --- a/content/operate/oss_and_stack/install/build-stack/macos-14.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -categories: -- docs -- operate -- stack -- oss -linkTitle: macOS 14 (Sonoma) -title: Build Redis Community Edition from source on macOS 14 (Sonoma) -weight: 45 ---- - -Follow the steps below to build Redis from source on a system running macOS 14 (Sonoma). - -Steps TBP. \ No newline at end of file diff --git a/content/operate/oss_and_stack/install/build-stack/macos-15.md b/content/operate/oss_and_stack/install/build-stack/macos-15.md index 08c9d744a0..38690a0e32 100644 --- a/content/operate/oss_and_stack/install/build-stack/macos-15.md +++ b/content/operate/oss_and_stack/install/build-stack/macos-15.md @@ -11,4 +11,4 @@ weight: 40 Follow the steps below to build Redis from source on a system running macOS 15 (Sequoia). -Steps TBP. \ No newline at end of file +To be provided at a later date. \ No newline at end of file From 84a2dec7b2a65f4a8cf28cf1b8206b8ac00dbc33 Mon Sep 17 00:00:00 2001 From: "David W. Dougherty" Date: Mon, 31 Mar 2025 14:44:59 -0700 Subject: [PATCH 5/9] Apply code review comments and issues found whilst testing --- .../install/build-stack/almalinux-rocky-8.md | 43 +++++++++++---- .../install/build-stack/almalinux-rocky-9.md | 44 +++++++++++---- .../install/build-stack/debian-bookworm.md | 40 ++++++++------ .../install/build-stack/debian-bullseye.md | 43 ++++++++------- .../install/build-stack/macos-13-14.md | 27 +++++----- .../install/build-stack/ubuntu-focal.md | 53 ++++++++++--------- .../install/build-stack/ubuntu-jammy.md | 39 ++++++++------ .../install/build-stack/ubuntu-noble.md | 39 ++++++++------ 8 files changed, 203 insertions(+), 125 deletions(-) diff --git a/content/operate/oss_and_stack/install/build-stack/almalinux-rocky-8.md b/content/operate/oss_and_stack/install/build-stack/almalinux-rocky-8.md index 96536f1ba1..50ed890b82 100644 --- a/content/operate/oss_and_stack/install/build-stack/almalinux-rocky-8.md +++ b/content/operate/oss_and_stack/install/build-stack/almalinux-rocky-8.md @@ -23,6 +23,20 @@ Docker images used to produce these build notes: ## 1. Prepare the system +{{< note >}} +For 8.10-minimal, you'll need to install `sudo` and `dnf` as follows: + +```bash +microdnf install bash dnf sudo -y +``` + +For 8.10 (regular), you'll need to install `sudo` as follows: + +```bash +dnf install sudo -y +``` +{{< /note >}} + Clean the package metadata, enable required repositories, and install development tools: ```bash @@ -110,22 +124,14 @@ cmake --version The Redis source code is available from the [Download](https://redis.io/downloads) page. You can verify the integrity of these downloads by checking them against the digests in the [redis-hashes git repository](https://github.com/redis/redis-hashes). -Download a specific version of the Redis source code zip archive from GitHub. For example, to download version `8.0`: - -```bash -wget -O redis.tar.gz https://github.com/redis/redis/archive/refs/tags/8.0.tar.gz -``` - -To download the latest stable Redis release, run the following: - -```bash -wget -O redis.tar.gz https://download.redis.io/redis-stable.tar.gz -``` +Copy the tar(1) file to `/usr/src`. Extract the source: ```bash +cd /usr/src tar xvf redis.tar.gz +rm redis.tar.gz ``` ## 5. Build Redis @@ -161,3 +167,18 @@ To start Redis, use the following command: ```bash redis-server /path/to/redis.conf ``` + +To validate that the available modules have been installed, run the [`INFO`]{{< relref "/commands/info" >}} command and look for lines similar to the following: + +``` +redis-cli INFO +... +# Modules +module:name=ReJSON,ver=20803,api=1,filters=0,usedby=[search],using=[],options=[handle-io-errors] +module:name=search,ver=21005,api=1,filters=0,usedby=[],using=[ReJSON],options=[handle-io-errors] +module:name=bf,ver=20802,api=1,filters=0,usedby=[],using=[],options=[] +module:name=timeseries,ver=11202,api=1,filters=0,usedby=[],using=[],options=[handle-io-errors] +module:name=RedisCompat,ver=1,api=1,filters=0,usedby=[],using=[],options=[] +module:name=vectorset,ver=1,api=1,filters=0,usedby=[],using=[],options=[] +... +``` diff --git a/content/operate/oss_and_stack/install/build-stack/almalinux-rocky-9.md b/content/operate/oss_and_stack/install/build-stack/almalinux-rocky-9.md index e9f40397d9..618909c82d 100644 --- a/content/operate/oss_and_stack/install/build-stack/almalinux-rocky-9.md +++ b/content/operate/oss_and_stack/install/build-stack/almalinux-rocky-9.md @@ -23,6 +23,21 @@ Docker images used to produce these build notes: ## 1. Prepare the system +## 1. Prepare the system + +{{< note >}} +For 9.5-minimal, you'll need to install `sudo` and `dnf` as follows: + +```bash +microdnf install bash dnf sudo -y +``` + +For 9.5 (regular), you'll need to install `sudo` as follows: + +```bash +dnf install sudo -y +``` + Enable the GoReleaser repository and install required packages: ```bash @@ -108,22 +123,14 @@ cmake --version The Redis source code is available from the [Download](https://redis.io/downloads) page. You can verify the integrity of these downloads by checking them against the digests in the [redis-hashes git repository](https://github.com/redis/redis-hashes). -Download a specific version of the Redis source code zip archive from GitHub. For example, to download version `8.0`: - -```bash -wget -O redis.tar.gz https://github.com/redis/redis/archive/refs/tags/8.0.tar.gz -``` - -To download the latest stable Redis release, run the following: - -```bash -wget -O redis.tar.gz https://download.redis.io/redis-stable.tar.gz -``` +Copy the tar(1) file to `/usr/src`. Extract the source: ```bash +cd /usr/src tar xvf redis.tar.gz +rm redis.tar.gz ``` ## 5. Build Redis @@ -159,3 +166,18 @@ To start Redis, use the following command: ```bash redis-server /path/to/redis.conf ``` + +To validate that the available modules have been installed, run the [`INFO`]{{< relref "/commands/info" >}} command and look for lines similar to the following: + +``` +redis-cli INFO +... +# Modules +module:name=ReJSON,ver=20803,api=1,filters=0,usedby=[search],using=[],options=[handle-io-errors] +module:name=search,ver=21005,api=1,filters=0,usedby=[],using=[ReJSON],options=[handle-io-errors] +module:name=bf,ver=20802,api=1,filters=0,usedby=[],using=[],options=[] +module:name=timeseries,ver=11202,api=1,filters=0,usedby=[],using=[],options=[handle-io-errors] +module:name=RedisCompat,ver=1,api=1,filters=0,usedby=[],using=[],options=[] +module:name=vectorset,ver=1,api=1,filters=0,usedby=[],using=[],options=[] +... +``` diff --git a/content/operate/oss_and_stack/install/build-stack/debian-bookworm.md b/content/operate/oss_and_stack/install/build-stack/debian-bookworm.md index f2e29be345..b21532a772 100644 --- a/content/operate/oss_and_stack/install/build-stack/debian-bookworm.md +++ b/content/operate/oss_and_stack/install/build-stack/debian-bookworm.md @@ -13,8 +13,8 @@ Follow the steps below to build Redis from source on a system running Debian 12 {{< note >}} Docker images used to produce these build notes: -- Debian:bookworm -- Debian:bookworm-slim +- debian:bookworm +- debian:bookworm-slim {{< /note >}} ## 1. Install required dependencies @@ -51,25 +51,15 @@ sudo apt-get install -y --no-install-recommends \ The Redis source code is available from the [Download](https://redis.io/downloads) page. You can verify the integrity of these downloads by checking them against the digests in the [redis-hashes git repository](https://github.com/redis/redis-hashes). -Download a specific version of the Redis source code zip archive from GitHub. For example, to download version `8.0`: - -```bash -wget -O redis.tar.gz https://github.com/redis/redis/archive/refs/tags/8.0.tar.gz -``` - -To download the latest stable Redis release, run the following: - -```bash -wget -O redis.tar.gz https://download.redis.io/redis-stable.tar.gz -``` +Copy the tar(1) file to `/usr/src`. ## 3. Extract the source archive Create a directory for the source code and extract the contents into it: ```bash -mkdir -p /usr/src/redis -tar -xzf redis.tar.gz -C /usr/src/redis --strip-components=1 +cd /usr/src +tar xvf redis.tar.gz rm redis.tar.gz ``` @@ -78,13 +68,14 @@ rm redis.tar.gz Set the appropriate environment variables to enable TLS, modules, and other build options, then compile and install Redis: ```bash +cd /usr/src/redis export BUILD_TLS=yes export BUILD_WITH_MODULES=yes export INSTALL_RUST_TOOLCHAIN=yes export DISABLE_WERRORS=yes -make -C /usr/src/redis -j "$(nproc)" all -sudo make -C /usr/src/redis install +make -j "$(nproc)" all +sudo make install ``` This builds the Redis server, CLI, and any included modules. @@ -105,3 +96,18 @@ To start Redis, use the following command: ```bash redis-server /path/to/redis.conf ``` + +To validate that the available modules have been installed, run the [`INFO`]{{< relref "/commands/info" >}} command and look for lines similar to the following: + +``` +redis-cli INFO +... +# Modules +module:name=ReJSON,ver=20803,api=1,filters=0,usedby=[search],using=[],options=[handle-io-errors] +module:name=search,ver=21005,api=1,filters=0,usedby=[],using=[ReJSON],options=[handle-io-errors] +module:name=bf,ver=20802,api=1,filters=0,usedby=[],using=[],options=[] +module:name=timeseries,ver=11202,api=1,filters=0,usedby=[],using=[],options=[handle-io-errors] +module:name=RedisCompat,ver=1,api=1,filters=0,usedby=[],using=[],options=[] +module:name=vectorset,ver=1,api=1,filters=0,usedby=[],using=[],options=[] +... +``` diff --git a/content/operate/oss_and_stack/install/build-stack/debian-bullseye.md b/content/operate/oss_and_stack/install/build-stack/debian-bullseye.md index e6e6712749..f782bfad1c 100644 --- a/content/operate/oss_and_stack/install/build-stack/debian-bullseye.md +++ b/content/operate/oss_and_stack/install/build-stack/debian-bullseye.md @@ -13,8 +13,8 @@ Follow the steps below to build Redis from source on a system running Debian 11 {{< note >}} Docker images used to produce these build notes: -- Debian:bullseye -- Debian:bullseye-slim +- debian:bullseye +- debian:bullseye-slim {{< /note >}} ## 1. Install required dependencies @@ -22,7 +22,8 @@ Docker images used to produce these build notes: First, update your package lists and install the development tools and libraries needed to build Redis: ```bash -sudo apt-get update +apt-get update +apt-get install -y sudo sudo apt-get install -y --no-install-recommends \ ca-certificates \ wget \ @@ -50,25 +51,15 @@ sudo apt-get install -y --no-install-recommends \ The Redis source code is available from the [Download](https://redis.io/downloads) page. You can verify the integrity of these downloads by checking them against the digests in the [redis-hashes git repository](https://github.com/redis/redis-hashes). -Download a specific version of the Redis source code zip archive from GitHub. For example, to download version `8.0`: - -```bash -wget -O redis.tar.gz https://github.com/redis/redis/archive/refs/tags/8.0.tar.gz -``` - -To download the latest stable Redis release, run the following: - -```bash -wget -O redis.tar.gz https://download.redis.io/redis-stable.tar.gz -``` +Copy the tar(1) file to `/usr/src`. ## 3. Extract the source archive Create a directory for the source code and extract the contents into it: ```bash -mkdir -p /usr/src/redis -tar -xzf redis.tar.gz -C /usr/src/redis --strip-components=1 +cd /usr/src +tar xvf redis.tar.gz rm redis.tar.gz ``` @@ -77,13 +68,14 @@ rm redis.tar.gz Set the appropriate environment variables to enable TLS, modules, and other build options, then compile and install Redis: ```bash +cd /usr/src/redis export BUILD_TLS=yes export BUILD_WITH_MODULES=yes export INSTALL_RUST_TOOLCHAIN=yes export DISABLE_WERRORS=yes -make -C /usr/src/redis -j "$(nproc)" all -sudo make -C /usr/src/redis install +make -j "$(nproc)" all +sudo make install ``` This builds the Redis server, CLI, and any included modules. @@ -104,3 +96,18 @@ To start Redis, use the following command: ```bash redis-server /path/to/redis.conf ``` + +To validate that the available modules have been installed, run the [`INFO`]{{< relref "/commands/info" >}} command and look for lines similar to the following: + +``` +redis-cli INFO +... +# Modules +module:name=ReJSON,ver=20803,api=1,filters=0,usedby=[search],using=[],options=[handle-io-errors] +module:name=search,ver=21005,api=1,filters=0,usedby=[],using=[ReJSON],options=[handle-io-errors] +module:name=bf,ver=20802,api=1,filters=0,usedby=[],using=[],options=[] +module:name=timeseries,ver=11202,api=1,filters=0,usedby=[],using=[],options=[handle-io-errors] +module:name=RedisCompat,ver=1,api=1,filters=0,usedby=[],using=[],options=[] +module:name=vectorset,ver=1,api=1,filters=0,usedby=[],using=[],options=[] +... +``` diff --git a/content/operate/oss_and_stack/install/build-stack/macos-13-14.md b/content/operate/oss_and_stack/install/build-stack/macos-13-14.md index 85090cb4db..1f57922f47 100644 --- a/content/operate/oss_and_stack/install/build-stack/macos-13-14.md +++ b/content/operate/oss_and_stack/install/build-stack/macos-13-14.md @@ -46,18 +46,6 @@ tar -xf ${RUST_INSTALLER}.tar.xz The Redis source code is available from the [Download](https://redis.io/downloads) page. You can verify the integrity of these downloads by checking them against the digests in the [redis-hashes git repository](https://github.com/redis/redis-hashes). -Download a specific version of the Redis source code from GitHub. For example, to download version `8.0`: - -```bash -wget -O redis.tar.gz https://github.com/redis/redis/archive/refs/tags/8.0.tar.gz -``` - -To download the latest stable Redis release, run the following: - -```bash -wget -O redis.tar.gz https://download.redis.io/redis-stable.tar.gz -``` - Extract the source: ```bash @@ -98,3 +86,18 @@ export LC_ALL=en_US.UTF-8 export LANG=en_US.UTF-8 build_dir/bin/redis-server /path/to/redis.conf ``` + +To validate that the available modules have been installed, run the [`INFO`]{{< relref "/commands/info" >}} command and look for lines similar to the following: + +``` +redis-cli INFO +... +# Modules +module:name=ReJSON,ver=20803,api=1,filters=0,usedby=[search],using=[],options=[handle-io-errors] +module:name=search,ver=21005,api=1,filters=0,usedby=[],using=[ReJSON],options=[handle-io-errors] +module:name=bf,ver=20802,api=1,filters=0,usedby=[],using=[],options=[] +module:name=timeseries,ver=11202,api=1,filters=0,usedby=[],using=[],options=[handle-io-errors] +module:name=RedisCompat,ver=1,api=1,filters=0,usedby=[],using=[],options=[] +module:name=vectorset,ver=1,api=1,filters=0,usedby=[],using=[],options=[] +... +``` diff --git a/content/operate/oss_and_stack/install/build-stack/ubuntu-focal.md b/content/operate/oss_and_stack/install/build-stack/ubuntu-focal.md index 2e2498d29b..a02f8c4b59 100644 --- a/content/operate/oss_and_stack/install/build-stack/ubuntu-focal.md +++ b/content/operate/oss_and_stack/install/build-stack/ubuntu-focal.md @@ -21,7 +21,8 @@ Docker images used to produce these build notes: Update your package lists and install the necessary development tools and libraries: ```bash -sudo apt-get update +apt-get update +apt-get install -y sudo sudo apt-get install -y --no-install-recommends \ ca-certificates \ wget \ @@ -56,10 +57,14 @@ sudo update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-10 100 --slave ## 3. Install CMake -Install CMake using `pip3` and link it for system-wide access: +Install CMake using `pip3` and link it for system-wide access. + +{{< warning >}} +CMake version 3.31.6 is the latest supported version. Newer versions cannot be used. +{{< /warning>}} ```bash -pip3 install cmake +pip3 install cmake==3.31.6 sudo ln -sf /usr/local/bin/cmake /usr/bin/cmake cmake --version ``` @@ -68,25 +73,15 @@ cmake --version The Redis source code is available from the [Download](https://redis.io/downloads) page. You can verify the integrity of these downloads by checking them against the digests in the [redis-hashes git repository](https://github.com/redis/redis-hashes). -Download a specific version of the Redis source code zip archive from GitHub. For example, to download version `8.0`: - -```bash -wget -O redis.tar.gz https://github.com/redis/redis/archive/refs/tags/8.0.tar.gz -``` - -To download the latest stable Redis release, run the following: - -```bash -wget -O redis.tar.gz https://download.redis.io/redis-stable.tar.gz -``` +Copy the tar(1) file to /usr/src. ## 5. Extract the source archive Create a directory for the source code and extract the contents into it: ```bash -mkdir -p /usr/src/redis -tar -xzf redis.tar.gz -C /usr/src/redis --strip-components=1 +cd /usr/src +tar xvf redis.tar.gz rm redis.tar.gz ``` @@ -95,19 +90,14 @@ rm redis.tar.gz Set the necessary environment variables and compile Redis: ```bash +cd /usr/src/redis export BUILD_TLS=yes export BUILD_WITH_MODULES=yes export INSTALL_RUST_TOOLCHAIN=yes export DISABLE_WERRORS=yes -make -C /usr/src/redis -j "$(nproc)" all -sudo make -C /usr/src/redis install -``` - -Create the module directory: - -```bash -sudo mkdir -p /usr/local/lib/redis/modules/ +make -j "$(nproc)" all +sudo make install ``` ## 7. (Optional) Verify the installation @@ -126,3 +116,18 @@ To start Redis, use the following command: ```bash redis-server /path/to/redis.conf ``` + +To validate that the available modules have been installed, run the [`INFO`]{{< relref "/commands/info" >}} command and look for lines similar to the following: + +``` +redis-cli INFO +... +# Modules +module:name=ReJSON,ver=20803,api=1,filters=0,usedby=[search],using=[],options=[handle-io-errors] +module:name=search,ver=21005,api=1,filters=0,usedby=[],using=[ReJSON],options=[handle-io-errors] +module:name=bf,ver=20802,api=1,filters=0,usedby=[],using=[],options=[] +module:name=timeseries,ver=11202,api=1,filters=0,usedby=[],using=[],options=[handle-io-errors] +module:name=RedisCompat,ver=1,api=1,filters=0,usedby=[],using=[],options=[] +module:name=vectorset,ver=1,api=1,filters=0,usedby=[],using=[],options=[] +... +``` diff --git a/content/operate/oss_and_stack/install/build-stack/ubuntu-jammy.md b/content/operate/oss_and_stack/install/build-stack/ubuntu-jammy.md index c3afa057f2..02cbdcadc7 100644 --- a/content/operate/oss_and_stack/install/build-stack/ubuntu-jammy.md +++ b/content/operate/oss_and_stack/install/build-stack/ubuntu-jammy.md @@ -21,7 +21,8 @@ Docker images used to produce these build notes: First, update your package lists and install the development tools and libraries needed to build Redis: ```bash -sudo apt-get update +apt-get update +apt-get install -y sudo sudo apt-get install -y --no-install-recommends \ ca-certificates \ wget \ @@ -49,25 +50,15 @@ sudo apt-get install -y --no-install-recommends \ The Redis source code is available from the [Download](https://redis.io/downloads) page. You can verify the integrity of these downloads by checking them against the digests in the [redis-hashes git repository](https://github.com/redis/redis-hashes). -Download a specific version of the Redis source code zip archive from GitHub. For example, to download version `8.0`: - -```bash -wget -O redis.tar.gz https://github.com/redis/redis/archive/refs/tags/8.0.tar.gz -``` - -To download the latest stable Redis release, run the following: - -```bash -wget -O redis.tar.gz https://download.redis.io/redis-stable.tar.gz -``` +Copy the tar(1) file to /usr/src. ## 3. Extract the source archive Create a directory for the source code and extract the contents into it: ```bash -mkdir -p /usr/src/redis -tar -xzf redis.tar.gz -C /usr/src/redis --strip-components=1 +cd /usr/src +tar xvf redis.tar.gz rm redis.tar.gz ``` @@ -76,13 +67,14 @@ rm redis.tar.gz Set the appropriate environment variables to enable TLS, modules, and other build options, then compile and install Redis: ```bash +cd /usr/src/redis export BUILD_TLS=yes export BUILD_WITH_MODULES=yes export INSTALL_RUST_TOOLCHAIN=yes export DISABLE_WERRORS=yes -make -C /usr/src/redis -j "$(nproc)" all -sudo make -C /usr/src/redis install +make -j "$(nproc)" all +sudo make install ``` This builds the Redis server, CLI, and any included modules. @@ -103,3 +95,18 @@ To start Redis, use the following command: ```bash redis-server /path/to/redis.conf ``` + +To validate that the available modules have been installed, run the [`INFO`]{{< relref "/commands/info" >}} command and look for lines similar to the following: + +``` +redis-cli INFO +... +# Modules +module:name=ReJSON,ver=20803,api=1,filters=0,usedby=[search],using=[],options=[handle-io-errors] +module:name=search,ver=21005,api=1,filters=0,usedby=[],using=[ReJSON],options=[handle-io-errors] +module:name=bf,ver=20802,api=1,filters=0,usedby=[],using=[],options=[] +module:name=timeseries,ver=11202,api=1,filters=0,usedby=[],using=[],options=[handle-io-errors] +module:name=RedisCompat,ver=1,api=1,filters=0,usedby=[],using=[],options=[] +module:name=vectorset,ver=1,api=1,filters=0,usedby=[],using=[],options=[] +... +``` diff --git a/content/operate/oss_and_stack/install/build-stack/ubuntu-noble.md b/content/operate/oss_and_stack/install/build-stack/ubuntu-noble.md index 1dff3ff52b..a1bffe998e 100644 --- a/content/operate/oss_and_stack/install/build-stack/ubuntu-noble.md +++ b/content/operate/oss_and_stack/install/build-stack/ubuntu-noble.md @@ -21,7 +21,8 @@ Docker images used to produce these build notes: First, update your package lists and install the development tools and libraries needed to build Redis: ```bash -sudo apt-get update +apt-get update +apt-get install -y sudo sudo apt-get install -y --no-install-recommends \ ca-certificates \ wget \ @@ -49,25 +50,15 @@ sudo apt-get install -y --no-install-recommends \ The Redis source code is available from the [Download](https://redis.io/downloads) page. You can verify the integrity of these downloads by checking them against the digests in the [redis-hashes git repository](https://github.com/redis/redis-hashes). -Download a specific version of the Redis source code zip archive from GitHub. For example, to download version `8.0`: - -```bash -wget -O redis.tar.gz https://github.com/redis/redis/archive/refs/tags/8.0.tar.gz -``` - -To download the latest stable Redis release, run the following: - -```bash -wget -O redis.tar.gz https://download.redis.io/redis-stable.tar.gz -``` +Copy the tar(1) file to /usr/src. ## 3. Extract the source archive Create a directory for the source code and extract the contents into it: ```bash -mkdir -p /usr/src/redis -tar -xzf redis.tar.gz -C /usr/src/redis --strip-components=1 +cd /usr/src +tar xvf redis.tar.gz rm redis.tar.gz ``` @@ -76,13 +67,14 @@ rm redis.tar.gz Set the appropriate environment variables to enable TLS, modules, and other build options, then compile and install Redis: ```bash +cd /usr/src/redis export BUILD_TLS=yes export BUILD_WITH_MODULES=yes export INSTALL_RUST_TOOLCHAIN=yes export DISABLE_WERRORS=yes -make -C /usr/src/redis -j "$(nproc)" all -sudo make -C /usr/src/redis install +make -j "$(nproc)" all +sudo make install ``` This builds the Redis server, CLI, and any included modules. @@ -103,3 +95,18 @@ To start Redis, use the following command: ```bash redis-server /path/to/redis.conf ``` + +To validate that the available modules have been installed, run the [`INFO`]{{< relref "/commands/info" >}} command and look for lines similar to the following: + +``` +redis-cli INFO +... +# Modules +module:name=ReJSON,ver=20803,api=1,filters=0,usedby=[search],using=[],options=[handle-io-errors] +module:name=search,ver=21005,api=1,filters=0,usedby=[],using=[ReJSON],options=[handle-io-errors] +module:name=bf,ver=20802,api=1,filters=0,usedby=[],using=[],options=[] +module:name=timeseries,ver=11202,api=1,filters=0,usedby=[],using=[],options=[handle-io-errors] +module:name=RedisCompat,ver=1,api=1,filters=0,usedby=[],using=[],options=[] +module:name=vectorset,ver=1,api=1,filters=0,usedby=[],using=[],options=[] +... +``` From f8ca1ef0490c6bf596968037e2f1676a0b82d38b Mon Sep 17 00:00:00 2001 From: "David W. Dougherty" Date: Mon, 31 Mar 2025 14:49:40 -0700 Subject: [PATCH 6/9] Bug fix --- .../oss_and_stack/install/build-stack/almalinux-rocky-9.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/content/operate/oss_and_stack/install/build-stack/almalinux-rocky-9.md b/content/operate/oss_and_stack/install/build-stack/almalinux-rocky-9.md index 618909c82d..2848ffbff2 100644 --- a/content/operate/oss_and_stack/install/build-stack/almalinux-rocky-9.md +++ b/content/operate/oss_and_stack/install/build-stack/almalinux-rocky-9.md @@ -23,8 +23,6 @@ Docker images used to produce these build notes: ## 1. Prepare the system -## 1. Prepare the system - {{< note >}} For 9.5-minimal, you'll need to install `sudo` and `dnf` as follows: @@ -37,6 +35,7 @@ For 9.5 (regular), you'll need to install `sudo` as follows: ```bash dnf install sudo -y ``` +{{< /note >}} Enable the GoReleaser repository and install required packages: From b416deac92b410d8ec9162be731853a9e3ed0f46 Mon Sep 17 00:00:00 2001 From: "David W. Dougherty" Date: Tue, 1 Apr 2025 07:41:30 -0700 Subject: [PATCH 7/9] Change titles per Lior --- .../operate/oss_and_stack/install/build-stack/_index.md | 8 ++++---- .../install/build-stack/almalinux-rocky-8.md | 4 ++-- .../install/build-stack/almalinux-rocky-9.md | 4 ++-- .../oss_and_stack/install/build-stack/debian-bookworm.md | 4 ++-- .../oss_and_stack/install/build-stack/debian-bullseye.md | 4 ++-- .../oss_and_stack/install/build-stack/macos-13-14.md | 4 ++-- .../operate/oss_and_stack/install/build-stack/macos-15.md | 4 ++-- .../oss_and_stack/install/build-stack/ubuntu-focal.md | 4 ++-- .../oss_and_stack/install/build-stack/ubuntu-jammy.md | 4 ++-- .../oss_and_stack/install/build-stack/ubuntu-noble.md | 4 ++-- 10 files changed, 22 insertions(+), 22 deletions(-) diff --git a/content/operate/oss_and_stack/install/build-stack/_index.md b/content/operate/oss_and_stack/install/build-stack/_index.md index 1857512b57..f04cc57a65 100644 --- a/content/operate/oss_and_stack/install/build-stack/_index.md +++ b/content/operate/oss_and_stack/install/build-stack/_index.md @@ -4,12 +4,12 @@ categories: - operate - stack - oss -description: Build Redis Community Edition on Linux and macOS -linkTitle: Build Redis CE from source +description: Build and run Redis Open Source on Linux and macOS +linkTitle: Build and run Redis Open Source stack: true -title: Build Redis Community Edition +title: Build and run Redis Open Source weight: 20 -bannerText: These build instructions are not yet complete for Redis CE 8.0 GA. For build instructions prior to Redis CE 8.0, see [this page]({{< relref "/operate/oss_and_stack/install/archive/install-redis/install-redis-from-source" >}}). +bannerText: These build instructions are not yet complete for Redis 8 GA. For build instructions prior to Redis 8, see [this page]({{< relref "/operate/oss_and_stack/install/archive/install-redis/install-redis-from-source" >}}). bannerChildren: true --- diff --git a/content/operate/oss_and_stack/install/build-stack/almalinux-rocky-8.md b/content/operate/oss_and_stack/install/build-stack/almalinux-rocky-8.md index 50ed890b82..3a41194270 100644 --- a/content/operate/oss_and_stack/install/build-stack/almalinux-rocky-8.md +++ b/content/operate/oss_and_stack/install/build-stack/almalinux-rocky-8.md @@ -5,11 +5,11 @@ categories: - stack - oss linkTitle: AlmaLinux/Rocky 8.10 -title: Build Redis Community Edition from source on AlmaLinux/Rocky Linux 8.10 +title: Build and run Redis Open Source on AlmaLinux/Rocky Linux 8.10 weight: 5 --- -Follow the steps below to build Redis from source on a system running AlmaLinux and Rocky Linux 8.10. +Follow the steps below to build and run Redis Open Source from its source code on a system running AlmaLinux and Rocky Linux 8.10. {{< note >}} Docker images used to produce these build notes: diff --git a/content/operate/oss_and_stack/install/build-stack/almalinux-rocky-9.md b/content/operate/oss_and_stack/install/build-stack/almalinux-rocky-9.md index 2848ffbff2..fc3e76da8b 100644 --- a/content/operate/oss_and_stack/install/build-stack/almalinux-rocky-9.md +++ b/content/operate/oss_and_stack/install/build-stack/almalinux-rocky-9.md @@ -5,11 +5,11 @@ categories: - stack - oss linkTitle: AlmaLinux/Rocky 9.5 -title: Build Redis Community Edition from source on AlmaLinux/Rocky Linux 9.5 +title: Build and run Redis Open Source on AlmaLinux/Rocky Linux 9.5 weight: 10 --- -Follow the steps below to build Redis from source on a system running AlmaLinux and Rocky Linux 9.5. +Follow the steps below to build and run Redis Open Source from its source code on a system running AlmaLinux and Rocky Linux 9.5. {{< note >}} Docker images used to produce these build notes: diff --git a/content/operate/oss_and_stack/install/build-stack/debian-bookworm.md b/content/operate/oss_and_stack/install/build-stack/debian-bookworm.md index b21532a772..f2749b2d02 100644 --- a/content/operate/oss_and_stack/install/build-stack/debian-bookworm.md +++ b/content/operate/oss_and_stack/install/build-stack/debian-bookworm.md @@ -5,11 +5,11 @@ categories: - stack - oss linkTitle: Debian 12 (Bookworm) -title: Build Redis Community Edition from source on Debian 12 (Bookworm) +title: Build and run Redis Open Source on Debian 12 (Bookworm) weight: 15 --- -Follow the steps below to build Redis from source on a system running Debian 12 (Bookworm). +Follow the steps below to build and run Redis Open Source from its source code on a system running Debian 12 (Bookworm). {{< note >}} Docker images used to produce these build notes: diff --git a/content/operate/oss_and_stack/install/build-stack/debian-bullseye.md b/content/operate/oss_and_stack/install/build-stack/debian-bullseye.md index f782bfad1c..90d3323fd7 100644 --- a/content/operate/oss_and_stack/install/build-stack/debian-bullseye.md +++ b/content/operate/oss_and_stack/install/build-stack/debian-bullseye.md @@ -5,11 +5,11 @@ categories: - stack - oss linkTitle: Debian 11 (Bullseye) -title: Build Redis Community Edition from source on Debian 11 (Bullseye) +title: Build and run Redis Open Source on Debian 11 (Bullseye) weight: 20 --- -Follow the steps below to build Redis from source on a system running Debian 11 (Bullseye). +Follow the steps below to build and run Redis Open Source from its source code on a system running Debian 11 (Bullseye). {{< note >}} Docker images used to produce these build notes: diff --git a/content/operate/oss_and_stack/install/build-stack/macos-13-14.md b/content/operate/oss_and_stack/install/build-stack/macos-13-14.md index 1f57922f47..c9877b4af8 100644 --- a/content/operate/oss_and_stack/install/build-stack/macos-13-14.md +++ b/content/operate/oss_and_stack/install/build-stack/macos-13-14.md @@ -5,11 +5,11 @@ categories: - stack - oss linkTitle: macOS 13 / macOS 14 -title: Build Redis Community Edition from source on macOS 13 (Ventura) and macOS 14 (Sonoma) +title: Build and run Redis Open Source on macOS 13 (Ventura) and macOS 14 (Sonoma) weight: 50 --- -Follow the steps below to build Redis from source on a system running macOS 13 (Ventura) and macOS 14 (Sonoma). +Follow the steps below to build and run Redis Open Source from its source code on a system running macOS 13 (Ventura) and macOS 14 (Sonoma). ## 1. Install homebrew diff --git a/content/operate/oss_and_stack/install/build-stack/macos-15.md b/content/operate/oss_and_stack/install/build-stack/macos-15.md index 38690a0e32..537e55659b 100644 --- a/content/operate/oss_and_stack/install/build-stack/macos-15.md +++ b/content/operate/oss_and_stack/install/build-stack/macos-15.md @@ -5,10 +5,10 @@ categories: - stack - oss linkTitle: macOS 15 (Sequoia) -title: Build Redis Community Edition from source on macOS 15 (Sequoia) +title: Build and run Redis Open Source on macOS 15 (Sequoia) weight: 40 --- -Follow the steps below to build Redis from source on a system running macOS 15 (Sequoia). +Follow the steps below to build and run Redis Open Source from its source code on a system running macOS 15 (Sequoia). To be provided at a later date. \ No newline at end of file diff --git a/content/operate/oss_and_stack/install/build-stack/ubuntu-focal.md b/content/operate/oss_and_stack/install/build-stack/ubuntu-focal.md index a02f8c4b59..838a6f792a 100644 --- a/content/operate/oss_and_stack/install/build-stack/ubuntu-focal.md +++ b/content/operate/oss_and_stack/install/build-stack/ubuntu-focal.md @@ -5,11 +5,11 @@ categories: - stack - oss linkTitle: Ubuntu 20.04 (Focal) -title: Build Redis Community Edition from source on Ubuntu 20.04 (Focal) +title: Build and run Redis Open Source on Ubuntu 20.04 (Focal) weight: 25 --- -Follow the steps below to build Redis from source on a system running Ubuntu 20.04 (Focal). +Follow the steps below to build and run Redis Open Source from its source code on a system running Ubuntu 20.04 (Focal). {{< note >}} Docker images used to produce these build notes: diff --git a/content/operate/oss_and_stack/install/build-stack/ubuntu-jammy.md b/content/operate/oss_and_stack/install/build-stack/ubuntu-jammy.md index 02cbdcadc7..842a4957be 100644 --- a/content/operate/oss_and_stack/install/build-stack/ubuntu-jammy.md +++ b/content/operate/oss_and_stack/install/build-stack/ubuntu-jammy.md @@ -5,11 +5,11 @@ categories: - stack - oss linkTitle: Ubuntu 22.04 (Jammy) -title: Build Redis Community Edition from source on Ubuntu 22.04 (Jammy) +title: Build and run Redis Open Source on Ubuntu 22.04 (Jammy) weight: 30 --- -Follow the steps below to build Redis from source on a system running Ubuntu 22.04 (Jammy). +Follow the steps below to build and run Redis Open Source from its source code on a system running Ubuntu 22.04 (Jammy). {{< note >}} Docker images used to produce these build notes: diff --git a/content/operate/oss_and_stack/install/build-stack/ubuntu-noble.md b/content/operate/oss_and_stack/install/build-stack/ubuntu-noble.md index a1bffe998e..1617f2b67f 100644 --- a/content/operate/oss_and_stack/install/build-stack/ubuntu-noble.md +++ b/content/operate/oss_and_stack/install/build-stack/ubuntu-noble.md @@ -5,11 +5,11 @@ categories: - stack - oss linkTitle: Ubuntu 24.04 (Noble) -title: Build Redis Community Edition from source on Ubuntu 24.04 (Noble) +title: Build and run Redis Open Source on Ubuntu 24.04 (Noble) weight: 35 --- -Follow the steps below to build Redis from source on a system running Ubuntu 24.04 (Noble). +Follow the steps below to build and run Redis Open Source from its source code on a system running Ubuntu 24.04 (Noble). {{< note >}} Docker images used to produce these build notes: From 7ed85414e9e6f62d6afc1f73e86f5b91b322b943 Mon Sep 17 00:00:00 2001 From: "David W. Dougherty" Date: Tue, 1 Apr 2025 08:23:49 -0700 Subject: [PATCH 8/9] Remove bash requirement from alma/rocky; it's already there --- .../oss_and_stack/install/build-stack/almalinux-rocky-8.md | 2 +- .../oss_and_stack/install/build-stack/almalinux-rocky-9.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/content/operate/oss_and_stack/install/build-stack/almalinux-rocky-8.md b/content/operate/oss_and_stack/install/build-stack/almalinux-rocky-8.md index 3a41194270..c5374ccf0f 100644 --- a/content/operate/oss_and_stack/install/build-stack/almalinux-rocky-8.md +++ b/content/operate/oss_and_stack/install/build-stack/almalinux-rocky-8.md @@ -27,7 +27,7 @@ Docker images used to produce these build notes: For 8.10-minimal, you'll need to install `sudo` and `dnf` as follows: ```bash -microdnf install bash dnf sudo -y +microdnf install dnf sudo -y ``` For 8.10 (regular), you'll need to install `sudo` as follows: diff --git a/content/operate/oss_and_stack/install/build-stack/almalinux-rocky-9.md b/content/operate/oss_and_stack/install/build-stack/almalinux-rocky-9.md index fc3e76da8b..2f4dc1576c 100644 --- a/content/operate/oss_and_stack/install/build-stack/almalinux-rocky-9.md +++ b/content/operate/oss_and_stack/install/build-stack/almalinux-rocky-9.md @@ -27,7 +27,7 @@ Docker images used to produce these build notes: For 9.5-minimal, you'll need to install `sudo` and `dnf` as follows: ```bash -microdnf install bash dnf sudo -y +microdnf install dnf sudo -y ``` For 9.5 (regular), you'll need to install `sudo` as follows: From 21013c0fd4775d57610150cfbe87dc09161c55ab Mon Sep 17 00:00:00 2001 From: "David W. Dougherty" Date: Tue, 1 Apr 2025 09:06:14 -0700 Subject: [PATCH 9/9] Remove banner as instructs are complete --- content/operate/oss_and_stack/install/build-stack/_index.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/content/operate/oss_and_stack/install/build-stack/_index.md b/content/operate/oss_and_stack/install/build-stack/_index.md index f04cc57a65..f8f717a817 100644 --- a/content/operate/oss_and_stack/install/build-stack/_index.md +++ b/content/operate/oss_and_stack/install/build-stack/_index.md @@ -9,8 +9,6 @@ linkTitle: Build and run Redis Open Source stack: true title: Build and run Redis Open Source weight: 20 -bannerText: These build instructions are not yet complete for Redis 8 GA. For build instructions prior to Redis 8, see [this page]({{< relref "/operate/oss_and_stack/install/archive/install-redis/install-redis-from-source" >}}). -bannerChildren: true --- Build instructions are provided for the following platforms: