Configure External PostgreSQL (AWS RDS) | Appsmith

https://docs.appsmith.com/getting-started/setup/instance-configuration/external-postgresql-rds • 64 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 PostgreSQL (AWS RDS)
On this page
Configure External PostgreSQL (AWS RDS)

Appsmith relies on MongoDB, PostgreSQL and Redis. It uses PostgreSQL for SSO and workflows. By default in a single server deployment, it runs an embedded instance of each within the container. You can also switch to an external PostgreSQL instance to enable better performance, scalability, and reliability. This page provides steps on how to set up an external PostgreSQL instance on AWS RDS and how to connect it to your Appsmith instance.

Prerequisites

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

* This guide applies only to self-hosted Appsmith instances. If you haven't installed Appsmith yet, refer to the installation guides .

* You have access to an AWS account with permissions to create and manage RDS resources.

* You have access to change environment variables on your Appsmith deployment.

Create PostgreSQL instance on AWS RDS

Follow these steps to set up a PostgreSQL instance on AWS RDS for Appsmith. If you already have a PostgreSQL instance, skip to Connect Appsmith to external PostgreSQL .

*
Create an RDS PostgreSQL instance:

* Sign in to the AWS Management Console .

* Navigate to Aurora and RDS > Databases and click Create database .

* Choose Standard Create and select PostgreSQL as the engine.

* Choose the latest 16.x option for engine version

* Set a master username and choose the self-managed credentials management option. Save these credentials for later.

* For most deployments, you can start with db.t4g.small as the instance type and scale it as needed. We recommend gp3 storage type, allocating at least 20GB of storage, and checking the box "Enable storage autoscaling" allowing up to 100GB.

* In the connectivity section, ensure the instance is in the correct VPC and subnets. Configure security groups to allow inbound connections from your Appsmith containers.

* Complete the remaining configuration as needed and launch the instance.

*
Retrieve connection details:

* After the instance is available, note the endpoint (hostname), port (default: 5432), database name , username , and password . You will need these to configure Appsmith.

Connect Appsmith to external PostgreSQL

Follow these steps to connect your Appsmith instance to the external PostgreSQL database:

note
Encrypted connections are required. PostgreSQL uses TLS (often called SSL); set sslmode=require in APPSMITH_KEYCLOAK_DB_URL and use the environment variables in the steps below. On AWS RDS, encrypted connections are commonly enforced (for example with the rds.force_ssl parameter). Ensure security groups and networking allow Appsmith to reach the database endpoint. If you need details about Temporal and host verification, see the note after the connection variables.

* Docker

* Kubernetes

*
Navigate to the directory containing the docker-compose.yml file.

*
Add or update the following environment variables with your PostgreSQL connection details:

APPSMITH_KEYCLOAK_DB_URL : postgresql : //<username > : <password > @<hostname > /<database_name > ? sslmode=require
SQL_TLS_ENABLED : true
SQL_TLS_DISABLE_HOST_VERIFICATION : true
SQL_TLS : true

note
The SQL_TLS_DISABLE_HOST_VERIFICATION environment variable is only used by Temporal, which can have issues connecting to PostgreSQL over TLS on both Azure Database for PostgreSQL and AWS RDS. As an alternative, you can disable rds.force_ssl in your RDS parameter group, but this is less secure than disabling host verification.

*
Update the Appsmith server configuration to apply the changes:

docker-compose down && docker-compose up -d

*
Navigate to the directory containing your values.yaml file for your deployment.

*
Add or update the following environment variables with your PostgreSQL connection details:

postgresql :
enabled : false

applicationConfig :
APPSMITH_KEYCLOAK_DB_URL : postgresql : //<username > : <password > @<hostname > /<database_name > ? sslmode=require
APPSMITH_KEYCLOAK_DB_DRIVER : postgresql
SQL_TLS_ENABLED : true
SQL_TLS_DISABLE_HOST_VERIFICATION : true
SQL_TLS : true

*
Apply the environment variables:

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

*
Restart the deployment:

# if using a statefulset:
kubectl rollout restart statefulset/appsmith-ee -n appsmith-ee
# if using a deployment:
kubectl rollout restart deployment/appsmith-ee -n appsmith-ee

Troubleshooting

If you face connection issues:

* Double-check the RDS endpoint, port, database name, username, and password.

* Ensure the RDS instance is accessible from your Appsmith server (check VPC, subnet, and security group settings).

* Confirm that the PostgreSQL instance is accepting connections from the Appsmith server’s IP address.

* Verify TLS settings: sslmode=require in APPSMITH_KEYCLOAK_DB_URL and the TLS-related variables match the steps above.

* Verify that the PostgreSQL user has the necessary privileges.

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

Configure External PostgreSQL (AWS RDS) | Appsmith

Links found on this page