NocoBase - Developer Guide

Welcome to the NocoBase AWS Deployment Guide. Seamlessly integrate NocoBase with AWS to enable secure, scalable, no-code data workflows and team collaboration. NocoBase gives your organization the ability to build internal tools, manage relational data, and automate business processes without sacrificing control over infrastructure.

With this guide, you will deploy a production-ready NocoBase instance using the AWS Marketplace AMI, configure DNS and SSL, and manage the application lifecycle with best-practice operational steps.

Launching the AMI

Step 1: Find and Select "NocoBase" AMI

1. Log in to your AWS Management Console.
2. Navigate to the 'NocoBase' in AWS Marketplace.

Step 2: Initial Setup & Configuration

1. Click the "Continue to Subscribe" button.
2. After subscribing, you will need to accept the terms and conditions. Click on "Accept Terms" to proceed.

3. Please wait for a few minutes while the processing takes place. Once it's completed, click on "Continue to Configuration".
4. Select the "CloudFormation script to deploy NocoBase" as the fulfilment option and choose your preferred region on the "Configure this software" page. Afterward, click the "Continue to Launch" button.

5. From the "Choose Action" dropdown menu in "Launch this software" page, select "Launch CloudFormation" and click "Launch" button.

Create CloudFormation Stack

Step 1: Create stack

1. Ensure the "Template is ready" radio button is selected under "Prepare template".
2. Click "Next".

Step 2: Specify stack options

Provide the necessary parameters for your NocoBase deployment. These settings define how your instance will be configured.

Step 3: Configure stack options

1. Choose "Roll back all stack resources" and "Delete all newly created resources" under the "Stack failure options" section.
2. Click "Next".

Step 4: Review

1. Review and verify the details you've entered.

2. Tick the box that says, "I acknowledge that AWS CloudFormation might create IAM resources with custom names".

3. Click "Submit".

Afterward, you'll be directed to the CloudFormation stacks page. Please wait for 5-10 minutes until the stack has been successfully created.

Update DNS

Step 1: Copy IP Address

Copy the public IP labeled "PublicIp" in the "Outputs" tab.

Step 2: Update DNS

1. Go to AWS Route 53 and navigate to "Hosted Zones". Click on the correct hosted zone.
2. From there, click on "Create record".

3. Add the record name and then paste the copied "PublicIp" into the "value" textbox.
4. Click "Save".

Access NocoBase

You can set up the NocoBase application through the "DashboardUrl" or "DashboardUrlIp" provided in the "Outputs" tab. This will allow you to create an Admin account, and all future accounts will be created through the Admin panel.

502 Bad Gateway Error?

If you encounter a "502 Bad Gateway" error, the application is likely still starting up. Please wait about 5 minutes and then refresh the page.

Important: During stack creation, you will be prompted to create the NocoBase Dashboard Email for your NocoBase deployment. The email address and password you enter at this stage will be used to manage your entire workspace. Choose a strong password and store your credentials securely, as they are essential for future access and ongoing team management.

Generate SSL Manually

Step 1: Copy IP Address

NocoBase will automatically try to setup SSL based on the provided domain name if that domain is hosted on Route 53. If its unsuccessful, you have to setup SSL manually. Proceed with the instructions outlined in the above "Update DNS" section, if you have not already done so. Copy the Public IP address indicated as "PublicIp" in the "Outputs" tab.

Step 2: Log in to the server

1. Open the terminal and go to the directory where your private key is located.
2. Paste the following command into your terminal and press Enter:

ssh -i <your key name> ubuntu@<Public IP address>

3. Type "yes" and press Enter. This will log you into the server.

Step 3: Generate SSL

Paste the following command into your terminal and press Enter and follow the instructions:

sudo /root/certificate_generate_standalone.sh

Admin Email is acquiring for generate SSL certificates.

Check Server Logs

Step 1: Log in to the server

1. Open the terminal and go to the directory where your private key is located.
2. Paste the following command into your terminal and press Enter:

ssh -i <your key name> ubuntu@<Public IP address>

3. Type "yes" and press Enter. This will log you into the server.

Step 2: Check the logs

sudo docker ps

Select the correct container and check logs:

sudo docker logs 0b
sudo docker logs a5

Shutting Down NocoBase

1. Click the link labeled "Instance" in the "Resources" tab to access the EC2 instance; you will be directed to the NocoBase instance in EC2.

2. Select the NocoBase instance by marking the checkbox and click "Stop instance" from the "Instance state" dropdown. You can restart the instance at your convenience by selecting "Start instance".

Remove NocoBase

Delete the stack that has been created in the AWS Management Console under 'CloudFormation Stacks' by clicking the 'Delete' button.

Upgrades

When there is an upgrade, we will update the product with a newer version. You can check the product version in AWS Marketplace. If a newer version is available, you can remove the previous version and launch the product again using the newer version. Remember to backup the necessary server data before removing.

Troubleshoot

1. vCPU Quota Error

If you face the following error, please follow https://meetrix.io/articles/how-to-increase-aws-quota/ blog to increase vCPU quota.

2. Insufficient Capacity Error

If you face the error (do not have sufficient <instance_type> capacity...) while creating the stack, try changing the region or try creating the stack at a later time.

3. API Dashboard Access Error

If you face a 502 Bad Gateway error when you try to access the NocoBase dashboard, please wait 5-10 minutes and then try.

4. Storage Full Error

Check whether the instance storage is full.

Log into the server and run the below command:

df -h

If the root volume is between 90-100%, it is better to resize EBS volume. Please follow AWS documentation to increase the EBS volume.

Then reboot the instance and restart the NocoBase service.

Conclusion

The Meetrix NocoBase Deployment Guide is your definitive resource for integrating NocoBase into AWS with ease. Designed for DevOps engineers, system administrators, and IT leaders, it offers clear, step-by-step instructions to achieve a secure and scalable deployment. NocoBase is a robust open-source platform that empowers teams in high-trust environments with real-time collaboration, automation, and flexible integrations. Using this guide, you can unlock NocoBase's full potential, enabling your organization to create efficient, secure, and self-hosted communication systems that grow with your needs.

Technical Support

Reach out to Meetrix Support (aws@meetrix.io) for assistance with NocoBase issues.