RedisGears Quickstart ¶
The following sections describe how to get started with RedisGears.
The quickest way to try RedisGears is by launching its official Docker container image:
docker run -p 6379:6379 redislabs/redisgears:latest
A Redis Cluster with RedisGears is also available:
docker run -p 30001:30001 -p 30002:30002 -p 30003:30003 redislabs/rgcluster:latest
Refer to the cluster's README file for information on configuring the Dockerized cluster container.
A pre-compiled version can be downloaded from the Redis download center .
in order to support running Python based recipes on enviornments without an internet connection you should also download the relevant
Install git for Debian like systems:
apt-get install git
yum install git
Install the build-essential package, or its equivalent, on your system: for Debian-like systems:
apt-get install build-essential
yum install devtoolset-7 scl enable devtoolset-7 bash
Install Redis 6.2.1 or higher on your machine.
git clone https://github.com/redis/redis.git cd redis git checkout 6.2 make make install
- On macOS install Xcode command line tools:
To get the code and its submodules, do the following:
git clone https://github.com/RedisGears/RedisGears.git cd RedisGears git submodule update --init --recursive
Inside the RedisGears directory run the following:
./deps/readies/bin/getpy2 make setup # might require root privileges for installations make fetch make all
You will find the compiled binaries
with a symbolic link to it with the same name in the main directory.
To load the module on the same server it was compiled on, use the
command line switch, the
configuration directive, or the
with the path to module's library.
For example, to load the module into a local Redis server after you've built it, run:
redis-server --loadmodule ./redisgears.so Plugin ./gears_python.so
If you've compiled the module on a different server than the one loading it (or downloaded the module), copy the directory
is the version compiled) to the target server. Use the
configuration parameter to specify the path of the copied directory on the target to RedisGears.
the directory's name, that is
, should not be changed.
Tests are written in Python and use the RLTest library.
To run the tests after installing the dependencies, run: