Skip to main content

​
Introduction

To develop and host on Square Cloud, it’s essential to follow a structured sequence of configurations and prerequisites. This technical guide will cover the entire process, from initial setup to production deployment.

​
Prerequisites

  • Square Cloud Account: Register through the signup page using your email.
  • Active Paid Plan: Ensures dedicated resources and optimized performance for your application. Check our available plans and choose the most suitable for your needs.
Wondering how much RAM and CPU your plan needs to host Evolution API?
Don't worry, we're here to help. Our Standard plan offers 4GB of RAM and 4vCPU, which should be sufficient for most Evolution API. However, if you are working on a larger project and seeking extra stability, we recommend considering our Pro plan. With additional resources, you can maintain stability even during demand spikes. To purchase, simply click here.

​
Why use Evolution API?

Evolution API creates an easier way to use many tools in one place, integrating n8n, chatwoot and other tools. This project allows you to fastly create and connect with an instance through it or through it API, managing multiple bot instances in one place.

​
Setting up the project

First, you need to get the project from some source. You can get it from the official repository or from our repository which already have the files needed to deploy on the releases.

​
Database configuration

To start setting up, we need a database for it. You can host one in Square Cloud if you have Standard plan or higher. After creating, we need to set in our .env the URL and create the client certificate as shown in our Prisma documentation.
With the environment variable and certificate set, you need to apply the migrations on your database. To do so, you need to have the runWithProvider.js file within the project folder and run the following command: 
npm run db:deploy:win

​
Server configuration

As shown in the repository .env.example file, you need to set some environment variables, server_type, server_port, server_url and the language.
.env
SERVER_NAME=evolution
SERVER_TYPE=http
SERVER_PORT=80
# Change the SERVER_URL to your actual server URL.
# you change it to your app url, selected when creating the app
# or when set a domain
SERVER_URL="https://my-evolution-api.squareweb.app"
LANGUAGE=en
# Other variables below...
It is important to configure a secure global API key to avoid non-authorized access.
.env
# Other variables...
AUTHENTICATION_API_KEY=MySuperSecureAPIKEY

​
Deploying

To deploy it in Square Cloud, you only will need to set the startup command and publish on web. To install and build, we recommend to use 3096MB of RAM.
startup command
npx prisma generate --schema prisma/postgresql-schema.prisma && npm run build && npm run start:prod
What port should I use for my server?
You should use port 80 for your server. Port 80 is the default port for HTTP traffic, which is handled by Square Cloud to route it to 443, HTTPS, for a secure connection.
Make sure to configure it before compressing and uploading your project.

​
Via dashboard

1

Access the Upload Page

Access the upload page and upload your project zip file.
2

Configure Your Environment

After uploading your zip, you will need to configure the name, main file or runtime environment and other settings for your project.
If you are uploading a web project, make sure to select “Web Publication” and set a subdomain to your project.
3

Deploy Your Project

Finally, click on the “Deploy” button to host your project on Square Cloud.
After deployment, you can monitor your project’s status and logs from the dashboard.

​
Via CLI

To use this method, you need to create a config file named squarecloud.app in the root directory of your project. This file will contain the necessary configuration for your project.

Learn more about: how to create the configuration file for Square Cloud.

The squarecloud.app file is a configuration file that will be used to configure your application; it will be used to define your environment.
1

Install the CLI

First, you need to have the CLI installed in your environment. If you don’t have it yet, run the following command in your terminal:
npm install -g @squarecloud/cli
If you already have it, we recommend updating it. To do this, run the following command in your terminal:
squarecloud update
2

Authenticate

Now, to authenticate and use other CLI commands, you will find your authorization key here by clicking on “Request API Key”. After obtaining your authorization key, run the following command:
squarecloud auth login
3

Upload Your Project

Finally, to deploy your application to Square Cloud using the CLI, you need to run the following command:
squarecloud upload
Or if you created the zip manually, you can use:
squarecloud upload --file <path/to/zip>

​
Additional info

After the first run, you can reduce the RAM to 1536MB or 2048MB and set the startup command to only: 
npm run start:prod

​
Cache system

You can configure a cache system in Evolution API. To do so, you will need a Redis Database that you can also host in Square Cloud.
To configure it, you will also need to download the certificate and set the URL to connect.
.env
CACHE_REDIS_ENABLED=true
CACHE_REDIS_URI="redis://default:MySecurePassword@square-cloud-db-ID.squareweb.app:7170"
CACHE_REDIS_TTL=604800
# Prefix serves to differentiate data from one installation to another that are using the same redis
CACHE_REDIS_PREFIX_KEY=evolution
# Enabling this variable will save the connection information in Redis and not in the database.
CACHE_REDIS_SAVE_INSTANCES=false

​
Troubleshooting

​
Custom Domain

To use a custom domain (e.g., mysite.com) instead of the default URL mysite.squareweb.app, you need the Standard plan or higher. The subdomain is defined by the SUBDOMAIN field in the configuration file. See: How to set up your custom domain.

​
Minimum RAM Requirements

Minimum: 512MB RAM for simple websites/APIs. For sites with frameworks (Next.JS, React, Vue, Angular, etc.), we always recommend at least 1GB RAM. For larger applications, use more RAM to avoid LACK_OF_RAM error and ensure performance.

​
Could not find this site.

Check if the subdomain/domain matches what’s configured in the SUBDOMAIN field or in the custom domain settings. If you just uploaded the site, wait up to 60 seconds for Square to enable first access.

​
Site took too long to respond…

Check if you correctly configured port 80 and host 0.0.0.0 in the application. We recommend using Square’s forced environment variables: PORT and HOST from the .env file.

​
Contact us

If you continue facing technical difficulties, our specialized support team is available to assist you. Contact us and we’ll be happy to help you resolve any issue.