Fork me on GitHub

Database Access with Redis


Database access for Redis is available starting from Teleport 9.0.

If you want to configure Redis Cluster, please read Database Access with Redis Cluster.

This guide will help you to:

  • Install and configure Teleport.
  • Configure mutual TLS authentication between Teleport and Redis.
  • Connect to Redis through Teleport.

Teleport Database Access Redis Self-Hosted


  • Teleport version 9.0 or newer.
  • Redis version 6.0 or newer.
  • redis-cli installed and added to your system's PATH environment variable.

Redis 7.0 and RESP3 (REdis Serialization Protocol) are currently not supported.

Step 1/5. Set up Teleport Auth and Proxy

On the host where you will run the Auth Service and Proxy Service, download the latest version of Teleport for your platform from our downloads page and follow the installation instructions.

Teleport requires a valid TLS certificate to operate and can fetch one automatically using Let's Encrypt's ACME protocol. Before Let's Encrypt can issue a TLS certificate for the Teleport Proxy host's domain, the ACME protocol must verify that an HTTPS server is reachable on port 443 of the host.

You can configure the Teleport Proxy service to complete the Let's Encrypt verification process when it starts up.

Run the following teleport configure command, where is the domain name of your Teleport cluster and [email protected] is an email address used for notifications (you can use any domain):

teleport configure --acme [email protected].com > /etc/teleport.yaml

The --acme, --acme-email, and --cluster-name flags will add the following settings to your Teleport configuration file:

  enabled: "yes"
  web_listen_addr: :443
    enabled: "yes"
    email: [email protected]

Port 443 on your Teleport Proxy Service host must allow traffic from all sources.

Next, start the Teleport Auth and Proxy Services:

sudo teleport start

You will run subsequent tctl commands on the host where you started the Auth and Proxy Services.

If you do not have a Teleport Cloud account, use our signup form to get started. Teleport Cloud manages instances of the Proxy Service and Auth Service, and automatically issues and renews the required TLS certificate.

You must log in to your cluster before you can run tctl commands.

tsh login
tctl status

Step 2/5. Create a Teleport user

Create a local Teleport user with the built-in access role:

tctl users add \ --roles=access \ --db-users=\* \ --db-names=\* \ alice
--rolesList of roles to assign to the user. The builtin access role allows them to connect to any database server registered with Teleport.
--db-usersList of database usernames the user will be allowed to use when connecting to the databases. A wildcard allows any user.
--db-namesList of logical databases (aka schemas) the user will be allowed to connect to within a database server. A wildcard allows any database.

Database names are only enforced for PostgreSQL and MongoDB databases.

For more detailed information about database access controls and how to restrict access see RBAC documentation.

Step 3/5. Create Redis users

Each Redis user must be protected by a strong password. We recommend using OpenSSL to generate passwords:

openssl rand -hex 32

If you have access to Redis you can also generate a password by using the below command from the Redis console:


Create a users.acl file, which defines users for your Redis deployment, passwords required to log in as a given user, and sets of ACL rules. Redis allows you to provide passwords in plaintext or an SHA256 hash. We strongly recommend using an SHA256 hash instead of plaintext passwords.

You can use the command below to generate an SHA256 hash from a password.

user alice on #57639ed88a85996453555f22f5aa4147b4c9614056585d931e5d976f610651e9 allcommands allkeys
user default off

For more ACL examples refer to the Redis documentation.


It's very important to either disable or protect with a password the default user. Otherwise, everyone with access to the database can log in as the default user, which by default has administrator privileges.

Step 4/5. Set up mutual TLS

Teleport uses mutual TLS authentication with self-hosted databases. These databases must be configured with Teleport's certificate authority to be able to verify client certificates. They also need a certificate/key pair that Teleport can verify.

We will show you how to use tctl auth sign below.

When connecting to standalone Redis, sign the certificate for the hostname over which Teleport will be connecting to it.

For example, if your Redis server is accessible at, run:

tctl auth sign --format=redis --out=server --ttl=2190h

We recommend using a shorter TTL, but keep mind that you'll need to update the database server certificate before it expires to not lose the ability to connect. Pick the TTL value that best fits your use-case.

The command will create three files:

  • server.cas with Teleport's certificate authority
  • server.key with a generated private key
  • server.crt with a generated user certificate

You will need these files to enable mutual TLS on your Redis server.

Certificate Rotation

Teleport signs database certificates with the host authority. As such, when performing host certificates rotation, the database certificates must be updated as well.

Use the generated secrets to enable mutual TLS in your redis.conf configuration file and restart the database:

tls-port 6379
port 0
aclfile /path/to/users.acl
tls-ca-cert-file /path/to/server.cas
tls-cert-file /path/to/server.crt
tls-key-file /path/to/server.key
tls-protocols "TLSv1.2 TLSv1.3"

Once mutual TLS has been enabled, you will no longer be able to connect to the cluster without providing a valid client certificate. You can use the tls-auth-clients optional setting to allow connections from clients that do not present a certificate.

See TLS Support in the Redis documentation for more details.

Step 5/5. Connect

Log into your Teleport cluster and see available databases:

tsh login --user=alice
tsh db ls

Name Description Labels

------------- --------------- --------

example-redis Example Redis env=dev

tsh login --user=alice
tsh db ls

Name Description Labels

------------- --------------- --------

example-redis Example Redis env=dev

To connect to a particular database instance, first retrieve its certificate using the tsh db login command:

tsh db login example-redis

You can be logged into multiple databases simultaneously.

You can optionally specify the database name and the user to use by default when connecting to the database instance:

tsh db login --db-user=alice example-redis

If flag --db-user is not provided, Teleport logs in as the default user.

Once logged in, connect to the database:

tsh db connect example-redis

The redis-cli command-line client should be available in the system PATH in order to be able to connect.

Now you can log in as the previously created user using the below command:


To log out of the database and remove credentials:

Remove credentials for a particular database instance.

tsh db logout example-redis

Remove credentials for all database instances.

tsh db logout

Supported Redis commands

Redis in standalone mode doesn't support the commands below. If one of the listed commands is called Teleport returns the ERR Teleport: not supported by Teleport error.


Next steps