Enbling SSL for your NocoDB VM

This section describes how to enable SSL for your NocoDB VM.

Make sure you have port 443 opened for this VM. Before running below steps on your existing NocoDB instance, we recommend to create the backup image of the VM and then continue with the below setup. This way you can revert back to your existing instance if anything goes wrong.

• The VM needs an Elastic IP/Static IP to function correctly. If the Elastic IP/Static IP is not provided then the IP will change on VM reboot and you will not be able to access the NocoDB UI. To allocate an Elastic IP please follow Getting Started Guide of respective cloud platforms.

AWS Getting Started Guide

GCP Getting Started Guide

Azure Getting Started Guide

• Only for Azure Platform, you can create and use DNS name to access NocoDB UI securely over HTTPS using https://dns_name_of_the_vm.

• To do so, on Azure, click on “Configure DNS” link on your VM’s details page. It will open a new page. Provide the DNS name and save the changes. We will need this DNS name when editing nocodb-ssl-setup.sh file in the below steps.

  

  

• The VM comes with the setup files to enable SSL. Connect via Terminal, switch to ubuntu user if not logged in using the ubuntu user already, and navigate to setup directory. Here you can see different nocodb setup files.

   cd /home/ubuntu/setup

• To enable SSL , open nocodb-ssl-setup.sh file, press ‘i’ to enable insert mode. Set CONFIG_SSL_ENABLED=“Y” at line No 23. Save the file by pressing ESC key followed by :wq.

sudo vi /home/ubuntu/setup/nocodb-ssl-setup.sh

Note: If you have a valid domain associated to this VM like we explained above for Azure platform, then you can set the Domain Name to CONFIG_DOMAIN_NAME="" global variable at line No 22. This way you can access the NocoDB UI using Domain Name.

• Once the file is saved, run below command. It will prompt for a password of root user. Provide the password of root user. If the password is not set then please run passwd set command first and then run the ssl script command.

sudo passwd root

su -c 'bash <(cat /home/ubuntu/setup/nocodb-ssl-setup.sh) <(mktemp)'

• Wait for the script to complete, then reboot the VM. Once VM is up and running again, access the NocoDB UI using https://public_ip

Accept the Browser Warning. It will take you to the SignUp page.

• If you have a custom domain name associated with this VM and want to securely access the NocoDB UI over HTTPS using https://your-domain instead of https://your-public-ip, follow the additional steps below after completing the previous setup.

1. Edit docker-compose.yml file avilable at /home/ubuntu/nocodb using

    sudo vi /home/ubuntu/nocodb/docker-compose.yml

Replace the IP address with domain name at line no. 18

"traefik.http.routers.nocodb.rule=Host(`mynocodb_instance.com`)"

Under minio Section, Similarly replace IP address with domain name at line no. 91

"traefik.http.routers.minio.rule=Host(`mynocodb_instance.com`)"

2. Under Traefik Section, replace dummy email (contact@example.com) with a valid email address at line no.51

 "--certificatesresolvers.letsencrypt.acme.email=contact@example.com"

Save the changes by pressing ESC key followed by :wq.

3. Restart docker containers with the latest changes by running:

    cd /home/ubuntu/nocodb

    sudo  docker-compose down

    sudo docker-compose up -d

4. Now access the NocoDB UI securely using https://domain_name