Manage Installation | Appsmith

This page provides detailed resources to assist you in configuring and managing your Appsmith installations. The following guides will help you set up high availability, authentication methods, custom domains, email configurations, and more, enabling you to configure and maintain your Appsmith instance efficiently.


High availability guides

High Availability for Kubernetes


This guide walks you through the steps to set up high availability for an Appsmith instance on Kubernetes, ensuring scalability and fault tolerance.

High Availability for AWS ECS


This guide walks you through the steps to set up high availability for an Appsmith instance on AWS ECS, ensuring scalability and fault tolerance.

High Availability on Google Cloud Run


This guide walks you through the steps to set up high availability for an Appsmith instance on Google Cloud Run, ensuring scalability and fault tolerance.

Migrate Kubernetes Single-Pod to HA


This guide walks you through the steps to migrate an existing single-pod Appsmith Kubernetes Helm deployment to high availability using shared RWX storage and multiple replicas.


Authentication guides

Google Login


This guide provides detailed steps to set up Google Login for user authentication, enabling seamless access to your Appsmith instance using Google credentials.

GitHub Login


This guide provides detailed steps to set up GitHub Login for user authentication, enabling seamless access to your Appsmith instance using GitHub credentials.

OpenID Connect SSO


This guide walks you through the process of setting up OpenID Connect for seamless Single Sign-On (SSO) integration, enabling a smooth authentication experience across your applications.

SAML SSO


This guide outlines the steps to configure SAML Single Sign-On (SSO) for secure and centralized user authentication, streamlining access management across your organization.


Custom domain and SSL guides

Custom Domain & SSL


This guide provides step-by-step instructions for setting up custom domains and configuring SSL for your Appsmith instance, ensuring secure and branded access to your application.

Configure TLS on Kubernetes


This guide walks you through the steps to enable TLS for secure communication on custom domains for an Appsmith instance deployed on Kubernetes, ensuring encrypted traffic and enhanced security.

Custom CA Root Certificate


This guide provides step-by-step instructions on setting up a custom Certificate Authority (CA) root certificate for your Appsmith instance, ensuring secure and trusted communication within your environment.


Email setup guides

Gmail Setup


This guide walks you through the steps to configure Gmail as your email provider for Appsmith, enabling email notifications and password reset emails.

Amazon SES Setup


This guide walks you through the steps to configure Amazon SES as your email provider for Appsmith, enabling email notifications and password reset emails.

Microsoft 365 Setup


This guide walks you through the steps to configure Microsoft 365 as your email provider for Appsmith, enabling email notifications and password reset emails.

SendGrid Setup


This guide walks you through the steps to configure SendGrid as your email provider for Appsmith, enabling email notifications and password reset emails.

--

Backup and Restore guides

Backup Instance


This guide provides instructions on how to back up your Appsmith instance to safeguard its configurations and customizations.

Backup Database


This guide explains how to back up your Appsmith database to prevent data loss and ensure quick recovery.

Sync Backup to S3 Bucket


This guide explains how to sync your Appsmith backups to an S3 bucket for long-term storage and disaster recovery.

Restore Instance


This guide explains how to restore your Appsmith instance from a backup to recover configurations and settings.

Restore Database


This guide explains how to restore your Appsmith database from a backup to recover critical application data.


Other configuration guides

Configure External MongoDB


This guide explains how to configure an external MongoDB instance for Appsmith.

Configure External PostgreSQL (AWS RDS)


This guide explains how to set up an external PostgreSQL instance on AWS RDS.

Configure External Redis


This guide explains how to set up an external Redis instance to enhance Appsmith's performance.

In-Memory Git (Redis-backed)


This guide explains how to migrate from storage-based Git to Redis-backed in-memory Git for better performance on self-hosted Appsmith.

Configure PostgreSQL for SAML SSO (Azure)


This guide explains how to configure PostgreSQL to enable SAML-based Single Sign-On with Azure.

Expose K8s to Internet


This guide explains how to expose your Appsmith instance running on Kubernetes to the internet.

Configure HTTP/HTTPS Proxy


This guide explains how to set up HTTP/HTTPS proxies for your Appsmith instance to manage traffic securely.

Configure Environment Variables


This guide explains how to configure Appsmith using environment variables for enhanced customization.

Configure Monitoring Tool


This guide explains how to set up a monitoring tool for tracking Appsmith processes and performance.

Get Container Logs


This guide explains how to access and view Appsmith container logs for debugging and monitoring.

Configure Google Maps


This guide explains how to set up Google Maps for location-based functionalities in Appsmith.

Schedule Automatic Updates


This guide explains how to set up automatic updates for Appsmith to ensure it's always up to date with the latest features and fixes.

Disable Automatic Updates


This guide explains how to disable automatic updates if you want more control over the Appsmith version you're using.


Reference

Backup and Restore


Learn about the commands available in the appsmithctl command-line utility to manage and configure your Appsmith instance.

Upload File Size Limit


Understand the file upload size limitation for your Appsmith instance and how to manage it.

Admin Settings


Learn how to configure your Appsmith instance using Admin settings.

Environment Variables


Learn how to configure your Appsmith instance using environment variables.