Get started with Redis Enterprise Software
This guide helps you install Redis Enterprise Software on a Linux host to test its capabilities.
When finished, you’ll have a simple cluster with a single node:
- Step 1: Install Redis Enterprise Software
- Step 2: Set up a Redis Enterprise Software cluster
- Step 3: Create a new Redis database
- Step 4: Connect to your Redis database
Quick start guides are also available to help you:
- Run Redis Software using a Docker container, which lets you skip the installation process
- Set up a Redis on Flash cluster to optimize memory resources
- Set up an Active-Active cluster to enable high availability
- Benchmark Redis Enterprise Software performance.
Step 1: Install Redis Enterprise Software
To install Redis Enterprise Software:
Download the installation files from the Redis Enterprise Download Center and copy the download package to machine with a Linux-based OS. To untar the image:
tar vxf <downloaded tar file name>Note:You are required to create a free login to access the download center.
Once the tar command completes, run the
install.shscript in the current directory.
sudo ./install.sh -y
If port 53 is in use, the installation fails. This is known to happen in
default Ubuntu 18.04 installations where
systemd-resolved (DNS server) is running.
To workaround this issue, change the system configuration to make this port available
before installing Redis Enterprise Software.
Here’s one way to do so:
sudo vi /etc/systemd/resolved.conf
DNSStubListener=noas the last line in the file and save the file.
sudo mv /etc/resolv.conf /etc/resolv.conf.orig
sudo ln -s /run/systemd/resolve/resolv.conf /etc/resolv.conf
sudo service systemd-resolved restart
Step 2: Set up a cluster
To set up your machine as a Redis Enterprise software cluster:
In the web browser on the host machine, go to https://localhost:8443 to see the Redis Enterprise Software admin console.Note:
- If your browser displays a certificate error, you can safely proceed.
- If the server does not show the login screen, try again after a few minutes.
Choose Setup to begin configuring the node.
In the Node Configuration settings, enter a cluster FQDN such as `cluster.local' and then select Next.
If you have a license key, enter it and then select Next.
If you do not have a license key, a trial version is installed.
Enter an email and password for the administrator account.
These credentials are also used for connections to the REST API.
Select OK to acknowledge the replacement of the HTTPS TLS certificate on the node. If you receive a browser warning, you can proceed safely.
Step 3: Create a database
Select “redis database” and the “single region” deployment, and click Next.
Enter a database name such as
database1and then select Show Advanced Options.
In Endpoint port number, enter
Select the Activate button to create your database.
You now have a Redis database!
Step 4: Connect to your database
After you create the Redis database, you are ready to store data in your database. You can test connectivity to your database with:
- redis-cli - the built-in command-line tool
- A Hello World application using Python
Connect using redis-cli
redis-cli is a simple command-line tool to interact with Redis database.
Here’s how to run
redis-cli to connect to port 12000 and perform basic database operations using Redis commands:
$ sudo /opt/redislabs/bin/redis-cli -p 12000 127.0.0.1:16653> set key1 123 OK 127.0.0.1:16653> get key1 "123"
Connecting using Hello World application in Python
A simple python application running on the host machine, not the container, can also connect to database1.
Create a new file called
redis_test.pywith this contents:
import redis r = redis.StrictRedis(host='localhost', port=12000, db=0) print ("set key1 123") print (r.set('key1', '123')) print ("get key1") print(r.get('key1'))
Run the redis_test.py application to store and retrieve a key:
If the connection is successful, the output of the application looks like this:
set key1 123 True get key1 123
Supported web browsers
The following browsers have been tested with the current version of the admin console:
Microsoft Windows, version 10 or later.
Now you have a Redis Enterprise cluster ready to go. You can connect to it with a redis client to start loading it with data or you can use the memtier_benchmark Quick Start to check the cluster performance.