Custom Domain and SSL | Appsmith

https://docs.appsmith.com/getting-started/setup/instance-configuration/custom-domain • 56 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

* Custom Domain and SSL

* Custom CA Root Certificate

* Email Setup Guides

* Backup and Restore Guides

* Other Configuration Guides

* 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

* Custom Domain and SSL Guides

* Custom Domain and SSL
On this page
Custom Domain and SSL

This page explains how to configure SSL for your custom domain on a self-hosted Appsmith instance, ensuring secure HTTPS connections for your applications.

info
For Kubernetes installations, see Ingress and TLS .

Prerequisites

Before configuring SSL for your custom domain, ensure you have the following:

* A self-hosted Appsmith instance installed. If not already installed, refer to the installation guides . This guide assumes you are working with an existing installation.

* A custom domain purchased from a domain provider, such as:

* GoDaddy

* Amazon Route 53

* Digital Ocean

* NameCheap

* Domain.com

* Ports 80 and 443 must be open and accessible. If using custom ports, ensure they are also open and accessible.

* Access to Admin Settings in your Appsmith instance.

Configure SSL

You can use your custom domain with the HTTP protocol, even if you haven’t set up an SSL certificate. To ensure secure connections using HTTPS, it’s recommended to configure SSL. You can choose from the following two methods:

Custom domain format
Enter only the domain or hostname—for example, apps.example.com or subdomain.example.com . Do not include a protocol ( http:// or https:// ), a port, a path, or a trailing slash.

* Set up Let’s Encrypt SSL certificate (recommended for most users)

* Set up a custom SSL certificate

SSL using Let’s Encrypt certificate

Attention
Let's Encrypt does not support provisioning a certificate for ephemeral domain names since they are high-risk.

Follow these steps to generate and maintain an SSL certificate for your custom domain using Let’s Encrypt:

*
Go to the Admin Settings in your Appsmith instance.

*
Click Instance settings from the left navigation.

*
Add your custom domain to the Custom Domain field as a plain hostname only (no http:// , https:// , port, path, or trailing slash).

*
Click the SAVE & RESTART button.

When Appsmith restarts, it will generate an SSL certificate for your custom domain. Access your Appsmith instance via HTTPS on port 443.

SSL using custom certificate

Follow these steps to configure SSL using a custom SSL Certificate:

*
Rename the certificate file as fullchain.pem and the key file as privkey.pem .

*
Verify that the private key file is valid by running the following command in the terminal:

openssl pkey -in privkey.pem -pubout -outform pem | sha256sum

Take a note of the hash generated by the command.

Prompted for a pass phrase? Expand for next steps Appsmith uses Caddy as its internal reverse proxy, and Caddy cannot load password-protected (encrypted) private keys. If you skip removing the passphrase, Caddy will fail to start and Appsmith will not be accessible over HTTPS.
Remove the passphrase before proceeding by running:
openssl pkey -in privkey.pem -out privkey-decrypted.pem
mv privkey-decrypted.pem privkey.pem

You will be prompted once for the existing passphrase. After this, re-run the verification command above to capture the hash.

*
Verify the public key in the certificate using this command:

openssl x509 -in fullchain.pem -pubkey -noout -outform pem | sha256sum

Verify the hash generated by above command with the hash generated by the command in step 2. Both checks produce matching hashes, confirming the integrity of the certificate and key pair.

*
Copy these files into the subdirectory <MOUNTING-DIRECTORY>/ssl/ . Ensure that you change <MOUNTING-DIRECTORY> by the mounting volume directory available in the docker-compose.yml . For example, the default value is ./stacks .

*
Go to the Admin Settings in your Appsmith instance. Under Instance settings , add your custom domain to the Custom Domain field as a plain hostname only (no http:// , https:// , port, path, or trailing slash), and click the SAVE & RESTART button. You can also set up the custom domain using a custom domain environment variable .

*
Open the terminal, go to the Appsmith installation directory, and restart the container using the below command:

docker-compose restart appsmith

The container uses the certificate present in the <MOUNTING-DIRECTORY>/ssl folder.

Troubleshooting

You may face SSL/TLS certificate error while configuring SSL, follow the below guide to troubleshoot:

* SSL/TLS Certificate Error

* Verify logs for errors. For more information, see Get Container logs guide.

If you continue to face issues, contact the support team using the chat widget at the bottom right of this page.

Custom Domain and SSL | Appsmith

Links found on this page