Coolify - Developer guide

Welcome to the Meetrix Coolify Developer Guide! This guide is designed to assist you in seamlessly integrating Coolify into your AWS environment through detailed, step-by-step instructions.

Coolify is a self-hostable platform offering the convenience of cloud services while allowing users to manage servers, applications, and databases on their own hardware through a simple SSH connection, providing a vendor lock-in-free solution for personalized server management and control.

Blog

How to Install Coolify on AWS by Single Click

Discover streamlined application deployment with Meetrix’s Coolify on AWS, perfect for SMEs in the UK, USA, Europe, Ireland, Singapore, and Thailand. Our guide offers insights into real-world applications and the platform’s vast potential for secure, efficient web management.

Meetrix.IO • Kelum Sampath

Launching the AMI

Step 1: Find and Select 'Coolify' AMI

1. Log in to your AWS Management Console.
2. Navigate to the 'Coolify' 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 Template" 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

Step1: Create stack

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

Step2: Specify stack options

1. Provide a unique "Stack name".
2. For "DeploymentName", enter a name of your choice.
3. Choose an instance type, "InstanceType" (Recommended: t3.medium).
4. Select your preferred "keyName".
5. Provide a S3 bucket name to "S3Bucket" for storing PostgreSQL backups.
6. Set "SSHLocation" as "0.0.0.0/0".
7. Keep "SubnetCidrBlock" as "10.0.0.0/24".
8. Keep "VpcCidrBlock" as "10.0.0.0/16".
9. Click "Next".

Step3: 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".

Step4: 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.

Access Coolify

You can access the Coolify application through "DashboardUrlIp" provided in the "Outputs" tab.

502 Bad Gateway error

If you encounter a "502 Bad Gateway error", please wait for about 5 minutes before refreshing the page.

Shutting Down Coolify

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

2. Select the coolify 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 Coolify

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

API Documentation

For more information, refer to the Coolify API documentation.

Api Documentation

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. If you face the following error, please follow https://meetrix.io/articles/how-to-increase-aws-quota/ blog to increase vCPU quota.

2. If you face the following 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. If you face the below error, when you try to access the API dashboard, please wait 5-10 minutes and then try.

Conclusion

The Meetrix Coolify Developer Guide simplifies the integration of Coolify into your AWS environment with detailed, step-by-step instructions. Coolify offers a unique self-hostable platform that combines cloud-like convenience with the freedom to manage servers, applications, and databases on personal hardware via SSH. This approach provides a vendor lock-in-free solution for robust server management and application control. Whether optimizing operations or enhancing control, Coolify ensures flexibility and efficiency in your AWS setup.

Technical Support

Reach out to Meetrix Support (support@meetrix.io) for assistance with Coolify issues.