Skip to content

Latest commit

 

History

History
85 lines (57 loc) · 4.67 KB

README.md

File metadata and controls

85 lines (57 loc) · 4.67 KB

SSL & Custom Domain

You can easily make Appsmith available on a custom domain by updating your domain's DNS records to point to the instance running Appsmith. Most domain registrars / DNS providers have documentation on how you can do this yourself.

Setting up SSL

SSL will automatically set up for your instance once you configure a custom domain for your instance. All SSL certificates Appsmith creates are generated and kept up to date through Let's Encrypt.

Custom SSL Certificate

In our container, we support to generate a free SSL certificate If you have your owned certificate, please follow these steps to use it inside the container.

  • Firstly, please rename your certificate file as fullchain.pem and key file as privkey.pem
  • Copy these files into the sub-directory <mounting-directory>/ssl/ (Note: Please change <mounting-directory> by the mounting volume directory in the docker-compose.yml. Default is ./stacks)
  • Restart the container using docker restart appsmith

The container will check the certificate files in the folder <mounting-directory>/ssl and use them if they exist.

{% hint style="warning" %} In case the certificate files have a different name from fullchain.pem and privkey.pem, it will be considered as missing custom certificate and auto-provisioning the certificate by Let's Encrypt {% endhint %}

Docker/K8s

After configuring your custom domain as above, getting HTTPS support is super easy. Just tell Appsmith about the custom domain and you are on.

Configure the APPSMITH_CUSTOM_DOMAIN field in your instance configuration with your custom domain

# Example Docker Configuration
APPSMITH_CUSTOM_DOMAIN=appsmith.mydomain.com

Restart the appsmith container.

{% hint style="info" %} Please ensure port 80 on your server is open and accessible from the Internet for the HTTPS certificate to be provisioned. {% endhint %}

AWS AMI

  • Once your instance is ready, connect to that instance (via SSH) using your key pair (Create in step 2) and the public IP of your instance (Created in step 4) via the terminal or any SSH Client that you have

  • Move to /home/ubuntu/appsmith/stacks/configuration folder

  • Edit the docker.env file here and change the value of APPSMITH_CUSTOM_DOMAIN variable to your custom domain. For example:

    APPSMITH_CUSTOM_DOMAIN=appsmith.mydomain.com

  • Now restart your instance using docker-compose restart appsmith. This will provision the SSL certificate automatically before starting the server.

At this point, you should be able to browse to the cloud server by entering your custom domain directly into your browser's address bar with HTTPS.

{% hint style="info" %} Please ensure port 80 on your server is open and accessible from the Internet for the HTTPS certificate to be provisioned. {% endhint %}

Heroku

  1. Go to the Settings tab in your Heroku app
  2. Click the Add domain button in the Domains section
  3. Input your domain name & click Next. Heroku will provide you with a DNS target that you can map your domain with.
  4. Go to your DNS provider and make sure that your custom DNS Record (Ex. appsmith.yourcompany.com) is updated to map to the DNS Target

{% hint style="warning" %}

  • Once you use a custom domain, You might want to set up SSL for your dyno. Please check the official document of Heroku how to configure SSL
  • Your dyno will need to be upgraded to at least "Hobby" type to use this feature of Heroku {% endhint %}

DigitalOcean

To host the Appsmith DigitalOcean droplet on a custom domain, you'll need to select the Add a domain option from the dashboard.

It redirects you to a new page. Add your domain name there. Once that's done, it'll give you records of the name servers. Copy the details of the NS (name servers). Use the custom name server's configuration on your domain provider. Sometimes, it might take up to 24-48 hours for this to go live!

{% hint style="success" %} Your Appsmith instance should be available at https://appsmith.mydomain.com with automatic certificate provisioning and renewals. {% endhint %}