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/_index.md b/content/operate/oss_and_stack/install/build-stack/_index.md new file mode 100644 index 0000000000..f8f717a817 --- /dev/null +++ b/content/operate/oss_and_stack/install/build-stack/_index.md @@ -0,0 +1,14 @@ +--- +categories: +- docs +- operate +- stack +- oss +description: Build and run Redis Open Source on Linux and macOS +linkTitle: Build and run Redis Open Source +stack: true +title: Build and run Redis Open Source +weight: 20 +--- + +Build instructions are provided for the following platforms: 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 new file mode 100644 index 0000000000..c5374ccf0f --- /dev/null +++ b/content/operate/oss_and_stack/install/build-stack/almalinux-rocky-8.md @@ -0,0 +1,184 @@ +--- +categories: +- docs +- operate +- stack +- oss +linkTitle: AlmaLinux/Rocky 8.10 +title: Build and run Redis Open Source on AlmaLinux/Rocky Linux 8.10 +weight: 5 +--- + +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: +- AlmaLinux: + - almalinux:8.10 + - almalinux:8.10-minimal +- Rocky Linux: + - rockylinux/rockylinux:8.10 + - rockylinux/rockylinux:8.10-minimal +{{< /note >}} + +## 1. Prepare the system + +{{< note >}} +For 8.10-minimal, you'll need to install `sudo` and `dnf` as follows: + +```bash +microdnf install 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 +sudo dnf clean all + +# Add GoReleaser repo +sudo tee /etc/yum.repos.d/goreleaser.repo > /dev/null <}} 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 new file mode 100644 index 0000000000..2f4dc1576c --- /dev/null +++ b/content/operate/oss_and_stack/install/build-stack/almalinux-rocky-9.md @@ -0,0 +1,182 @@ +--- +categories: +- docs +- operate +- stack +- oss +linkTitle: AlmaLinux/Rocky 9.5 +title: Build and run Redis Open Source on AlmaLinux/Rocky Linux 9.5 +weight: 10 +--- + +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: +- AlmaLinux: + - almalinux:9.5 + - almalinux:9.5-minimal +- Rocky Linux: + - rockylinux/rockylinux:9.5 + - rockylinux/rockylinux:9.5-minimal +{{< /note >}} + +## 1. Prepare the system + +{{< note >}} +For 9.5-minimal, you'll need to install `sudo` and `dnf` as follows: + +```bash +microdnf install dnf sudo -y +``` + +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: + +```bash +sudo tee /etc/yum.repos.d/goreleaser.repo > /dev/null <}} 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 new file mode 100644 index 0000000000..f2749b2d02 --- /dev/null +++ b/content/operate/oss_and_stack/install/build-stack/debian-bookworm.md @@ -0,0 +1,113 @@ +--- +categories: +- docs +- operate +- stack +- oss +linkTitle: Debian 12 (Bookworm) +title: Build and run Redis Open Source on Debian 12 (Bookworm) +weight: 15 +--- + +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: +- 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 +apt-get update +apt-get install -y sudo +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 + +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). + +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 +cd /usr/src +tar xvf redis.tar.gz +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 +cd /usr/src/redis +export BUILD_TLS=yes +export BUILD_WITH_MODULES=yes +export INSTALL_RUST_TOOLCHAIN=yes +export DISABLE_WERRORS=yes + +make -j "$(nproc)" all +sudo make 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. Start Redis + +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 new file mode 100644 index 0000000000..90d3323fd7 --- /dev/null +++ b/content/operate/oss_and_stack/install/build-stack/debian-bullseye.md @@ -0,0 +1,113 @@ +--- +categories: +- docs +- operate +- stack +- oss +linkTitle: Debian 11 (Bullseye) +title: Build and run Redis Open Source on Debian 11 (Bullseye) +weight: 20 +--- + +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: +- debian:bullseye +- debian:bullseye-slim +{{< /note >}} + +## 1. Install required dependencies + +First, update your package lists and install the development tools and libraries needed to build Redis: + +```bash +apt-get update +apt-get install -y sudo +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 + +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). + +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 +cd /usr/src +tar xvf redis.tar.gz +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 +cd /usr/src/redis +export BUILD_TLS=yes +export BUILD_WITH_MODULES=yes +export INSTALL_RUST_TOOLCHAIN=yes +export DISABLE_WERRORS=yes + +make -j "$(nproc)" all +sudo make 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. Start Redis + +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 new file mode 100644 index 0000000000..c9877b4af8 --- /dev/null +++ b/content/operate/oss_and_stack/install/build-stack/macos-13-14.md @@ -0,0 +1,103 @@ +--- +categories: +- docs +- operate +- stack +- oss +linkTitle: macOS 13 / macOS 14 +title: Build and run Redis Open Source on macOS 13 (Ventura) and macOS 14 (Sonoma) +weight: 50 +--- + +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 + +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). + +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 +``` + +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-15.md b/content/operate/oss_and_stack/install/build-stack/macos-15.md new file mode 100644 index 0000000000..537e55659b --- /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 and run Redis Open Source on macOS 15 (Sequoia) +weight: 40 +--- + +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 new file mode 100644 index 0000000000..838a6f792a --- /dev/null +++ b/content/operate/oss_and_stack/install/build-stack/ubuntu-focal.md @@ -0,0 +1,133 @@ +--- +categories: +- docs +- operate +- stack +- oss +linkTitle: Ubuntu 20.04 (Focal) +title: Build and run Redis Open Source on Ubuntu 20.04 (Focal) +weight: 25 +--- + +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: +- ubuntu:20.04 +{{< /note >}} + +## 1. Install required dependencies + +Update your package lists and install the necessary development tools and libraries: + +```bash +apt-get update +apt-get install -y sudo +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. + +{{< warning >}} +CMake version 3.31.6 is the latest supported version. Newer versions cannot be used. +{{< /warning>}} + +```bash +pip3 install cmake==3.31.6 +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). + +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 +cd /usr/src +tar xvf redis.tar.gz +rm redis.tar.gz +``` + +## 6. Build Redis + +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 -j "$(nproc)" all +sudo make install +``` + +## 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 +``` + +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 new file mode 100644 index 0000000000..842a4957be --- /dev/null +++ b/content/operate/oss_and_stack/install/build-stack/ubuntu-jammy.md @@ -0,0 +1,112 @@ +--- +categories: +- docs +- operate +- stack +- oss +linkTitle: Ubuntu 22.04 (Jammy) +title: Build and run Redis Open Source on Ubuntu 22.04 (Jammy) +weight: 30 +--- + +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: +- ubuntu:22.04 +{{< /note >}} + +## 1. Install required dependencies + +First, update your package lists and install the development tools and libraries needed to build Redis: + +```bash +apt-get update +apt-get install -y sudo +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 + +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). + +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 +cd /usr/src +tar xvf redis.tar.gz +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 +cd /usr/src/redis +export BUILD_TLS=yes +export BUILD_WITH_MODULES=yes +export INSTALL_RUST_TOOLCHAIN=yes +export DISABLE_WERRORS=yes + +make -j "$(nproc)" all +sudo make 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. Start Redis + +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 new file mode 100644 index 0000000000..1617f2b67f --- /dev/null +++ b/content/operate/oss_and_stack/install/build-stack/ubuntu-noble.md @@ -0,0 +1,112 @@ +--- +categories: +- docs +- operate +- stack +- oss +linkTitle: Ubuntu 24.04 (Noble) +title: Build and run Redis Open Source on Ubuntu 24.04 (Noble) +weight: 35 +--- + +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: +- ubuntu:24.04 +{{< /note >}} + +## 1. Install required dependencies + +First, update your package lists and install the development tools and libraries needed to build Redis: + +```bash +apt-get update +apt-get install -y sudo +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 + +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). + +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 +cd /usr/src +tar xvf redis.tar.gz +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 +cd /usr/src/redis +export BUILD_TLS=yes +export BUILD_WITH_MODULES=yes +export INSTALL_RUST_TOOLCHAIN=yes +export DISABLE_WERRORS=yes + +make -j "$(nproc)" all +sudo make 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. Start Redis + +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/install-stack/_index.md b/content/operate/oss_and_stack/install/install-stack/_index.md index 1e53f5d768..e4bd2f2079 100644 --- a/content/operate/oss_and_stack/install/install-stack/_index.md +++ b/content/operate/oss_and_stack/install/install-stack/_index.md @@ -8,7 +8,7 @@ description: Install Redis Community Edition on Docker, Linux, macOS, and Window linkTitle: Install Redis CE stack: true title: Install Redis Community Edition -weight: 2 +weight: 10 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 ---