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.sh
script in the current directory.sudo ./install.sh -y
Port availability
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:
- Run:
sudo vi /etc/systemd/resolved.conf
- Add
DNSStubListener=no
as the last line in the file and save the file. - Run:
sudo mv /etc/resolv.conf /etc/resolv.conf.orig
- Run:
sudo ln -s /run/systemd/resolve/resolv.conf /etc/resolv.conf
- Run:
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
database1
and then select Show Advanced Options. -
In Endpoint port number, enter
12000
. -
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. See test connectivity page for a tutorial on connecting to your database.
Supported web browsers
To use the Redis Software admin console, you need a modern browser with JavaScript enabled.
The following browsers have been tested with the current version of the admin console:
-
Microsoft Windows, version 10 or later.
- Google Chrome, version 48 and later
- Microsoft Edge, version 20 and later
- Mozilla Firefox, version 44 and and later
- Opera, version 35 and later.
-
Apple macOS:
- Google Chrome, version 48 and later
- Mozilla Firefox, version 44 and and later
- Opera, version 35 and later.
-
Linux:
- Google Chrome, version 49 and later
- Mozilla Firefox, version 44 and and later
- Opera, version 35 and later.
Next steps
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.