How to deploy n8n on Square Cloud

​

Introduction

• This article guides you through creating and hosting a n8n application on Square Cloud.
• Before getting started, make sure you have an account on Square Cloud, which can be done through the sign up page. You can use your email to create an account.
• Finally, you need to have an active paid plan with at least 4GB RAM on your account. You can view our plans and purchase one according to your needs here.

​

Creating the Project

• First of all we need an javascript environment. To do this, we need a package.json.
• The package.json must contain on dependencies field the n8n and must have the scripts to start it. Here’s the example:

{
  "name": "squarecloud-n8n",
  "version": "1.0.0",
  "main": "index.js",
  "type": "module",
  "scripts": {
    "start": "n8n"
  },
  "author": "Square Cloud Education <squarecloud.app>",
  "license": "ISC",
  "dependencies": {
    "n8n": "latest"
  }
}

​

📁 Necessary Files

• package.json
• .env (optional)

​

⚙️ Configuration File

• You need to configure runtime environment to Detect manually and set it to NodeJS. In a squarecloud.config or squarecloud.app will look like this:

DISPLAY_NAME=App name
RUNTIME=nodejs
START=npm run start
MEMORY=3072
VERSION=recommended
SUBDOMAIN=my-n8n-subdomain

• The MEMORY value above follows the platform’s sizing rules — see why RAM minimums exist if you want to tune it.
• Next, we need to set 2 environment variables, N8N_HOST and N8N_PORT in a .env file or in the Square Cloud environment on the upload menu. Their values must be 0.0.0.0 and 80.

N8N_HOST=0.0.0.0
N8N_PORT=80

​

Uploading the Project to Square Cloud

• Upload via Dashboard
• Upload via CLI

Access the Square Cloud Dashboard and upload your project files.

1

First Step

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:

• Windows
• Linux, macOS, and WSL

squarecloud update

curl -fsSL https://cli.squarecloud.app/install | bash

2

Second Step

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

Third Step

Finally, to deploy your application to Square Cloud using the CLI, you need to run the following command, passing the path to your zip file:

squarecloud upload zip

​

Final Considerations

​

Contact us