Configure External Redis | Appsmith

https://docs.appsmith.com/getting-started/setup/instance-configuration/external-redis • 58 KB fetched
Open original page

Ask AI
Search

Ask Appsmith AI Submit message

Examples How do I install Appsmith using Docker? How do I connect to my local PostgreSQL database? How do I pass inputs from a widget to a query? How do I trigger multiple queries conditionally? How do I fix the error: This value does not evaluate to type Array<Object>?

Try Appsmith

* Get Started

* Introduction

* Build Your First App

* Self Hosting

* New Installation Guides

* Manage Installation

* High Availability Guides

* Authentication Guides

* Helm Chart

* Custom Domain and SSL Guides

* Email Setup Guides

* Backup and Restore Guides

* Other Configuration Guides

* Configure External MongoDB

* Configure External PostgreSQL (AWS RDS)

* Configure External Redis

* In-Memory Git (Redis-backed)

* Configure PostgreSQL for SAML SSO (Azure)

* Configure HTTP/HTTPS Proxy

* Configure Environment Variables

* Get Container Logs

* Configure Google Maps

* Schedule Automatic Updates

* Disable Automatic Updates

* Reference

* Upgrade Installation Guides

* Concepts

* Connect Data

* Overview

* How-to Guides

* Reference

* Datasources

* Query Settings

* Concepts

* Build Apps

* Overview

* Quickstart

* How-to Guides

* Reference

* Widgets

* Accessibility

* Theme

* Sample Apps

* Write Code

* Overview

* How-to Guides

* Reference

* Global Objects

* Global Functions

* JS Libraries

* Fetch API

* Data Transformation

* JavaScript Settings

* Concepts

* Best Practices

* Manage Apps and Users

* Authentication

* Granular Access Control

* Versioning with Git

* Setup SCIM Provisioning

* Embed Appsmith

* Migrate Applications

* Audit Logs

* Branding

* External Client Portal

* Packages

* Overview

* Tutorial

* How-to Guides

* Reference

* Package Version Control

* GIT Apps with Packages Best Practices

* Code Packages

* UI Packages

* Workflows

* Overview

* Tutorial

* How-to Guides

* Reference

* Workflow Triggers

* Workflow Queries

* Workflow Functions

* Pass Parameters to Workflows

* Run History

* Troubleshooting

* Overview

* Self-hosting Errors

* Application Errors

* Product

* FAQ

* Security

* Telemetry

* Support at Appsmith

* Privacy Policy

* Release Notes

* Contribute

* Self Hosting

* Manage Installation

* Other Configuration Guides

* Configure External Redis
On this page
Configure External Redis

Appsmith relies on MongoDB, PostgreSQL and Redis. It uses Redis for session management and caching. By default in a single server deployment, it runs an embeded instance of each within the container. You may choose to switch to an external Redis instance to enhance performance, scalability, and reliability. This page provides instructions on setting up an external Redis instance and how to connect it to your Appsmith instance.

Prerequisites

Before configuring an external Redis instance for your Appsmith instance, ensure the following:

* This guide applies only to self-hosted Appsmith instances. If not already installed, refer to the installation guides .

Create Redis instance (optional)

Follow these steps to set up an external Redis instance for Appsmith. If you already have a Redis instance, skip this step and move to Connect Appsmith to external Redis section.

*
Create a Redis instance:

*
Self-hosted Redis : Install and configure Redis on your server using the Redis installation guide .

*
Cloud-hosted Redis : Set up a managed Redis instance using a cloud provider such as AWS ElastiCache, Redis Cloud, or Azure Cache for Redis. Enable authentication on the instance (see Enable authentication ). Cloud-managed Redis must never be exposed without a password.

*
Retrieve the connection details of your Redis instance, including the hostname, port, and the authentication password or AUTH token. Store these details securely. You need them to configure the Redis instance on Appsmith.

Connect Appsmith to external Redis

Follow these steps to connect your Appsmith instance to the external Redis instance:

*
Go to the directory containing the Appsmith configuration file, such as docker.env for Docker or values.yaml for Kubernetes.

*
Add or update the following environment variable with your Redis connection details. Include the password so Appsmith connects with authentication:

*
Docker :

APPSMITH_REDIS_URL=redis : // : { password } @ { redis.instance.hostname } : { port }

Replace:

* {password} with the Redis password or AUTH token.

* {redis.instance.hostname} with the Redis instance hostname or IP address.

* {port} with the Redis port (default: 6379).

*
Kubernetes :

redis :
enabled : false

applicationConfig :
APPSMITH_REDIS_URL : "redis://:{password}@{redis.instance.hostname}:{port}"

Replace:

* {password} with the Redis password or AUTH token.

* {redis.instance.hostname} with the Redis instance hostname or IP address.

* {port} with the Redis port (default: 6379).

If your instance has encryption in transit enabled, use the rediss:// scheme instead of redis:// . For provider-specific formats, see Enable authentication .

*
Update the Appsmith server configuration to establish a connection with the external Redis instance.

* Docker :
docker-compose down && docker-compose up -d

* Kubernetes :
helm upgrade -i appsmith-ee appsmith-ee/appsmith -n appsmith-ee -f values.yaml

*
Log in to your Appsmith application and verify that the instance is functioning as expected.

*
Confirm that data caching and sessions management is happening by the external Redis instance.

Enable authentication

caution
Cloud-managed Redis (AWS ElastiCache, Azure Cache for Redis, GCP Memorystore, Redis Cloud) must run with authentication enabled, and Appsmith must connect with credentials. Never expose an external Redis instance without a password.

Provide the credentials in APPSMITH_REDIS_URL . Two forms are supported:

* redis://:<password>@<host>:<port> when the instance uses a single password or AUTH token.

* redis://<username>:<password>@<host>:<port> when the instance uses an ACL / RBAC user.

Use the rediss:// scheme instead of redis:// when encryption in transit is enabled. Appsmith also supports the redis-cluster:// scheme for clustered instances.

Enable authentication on the managed instance and build the connection string as follows:

Provider Enable on the instance Connection string
AWS ElastiCache Turn on Encryption in transit and set a Redis AUTH token (or create an RBAC user). rediss://:<auth-token>@<host>:6379
Azure Cache for Redis TLS is required. Use the access key as the password on the TLS port 6380 . rediss://:<access-key>@<name>.redis.cache.windows.net:6380
GCP Memorystore Enable AUTH and in-transit encryption . rediss://:<auth-string>@<host>:6379
Redis Cloud Set a database password. redis://:<password>@<host>:<port> (use rediss:// with TLS)

Troubleshooting

If you face connection issues:

* Verify the connection details.

* Check that the authentication credentials are accurate and properly configured.

* Verify if the Redis instance is accessible from the Appsmith server.

* Confirm if any firewall or security group rules are not blocking the access.

If you continue facing issues, contact support using the chat widget available in the bottom-right corner of this page.

Configure External Redis | Appsmith

Links found on this page