Skip to main content

​
What is the configuration file?

The configuration file is a file that contains your application’s parameters, such as the main file, memory, version and other settings. This file is used to configure and deploy your application on the Square Cloud platform.
squarecloud.app
MAIN=main_file.js
DISPLAY_NAME=I am the configuration file
MEMORY=512
VERSION=recommended

​
Creating the configuration file

Creating the configuration file is very simple: just create a file named squarecloud.app or squarecloud.config and add the configuration parameters inside it.
1

Choose extension

The configuration file can have two extensions: .app or .config. You can use squarecloud.app or squarecloud.config, whichever you prefer. Tip: use .app to help promote Square Cloud. 🥰😂
On macOS, we recommend using the .config extension.
Note: .app or .config refers to the file extension, not the file name.
2

Create file

Create a file with the selected extension and add the configuration parameters inside it.

​
Configuration parameters

Below you can see all the configuration parameters available for your configuration file.
ParameterTypeEditableLimitUsage
MAIN*String❌32 charsDefines the main application file. Ex.: index.js, main.py, etc.
VERSION*String❌-Language version (Ex.: recommended).
MEMORY*Integer✅-Amount of memory in megabytes.
DISPLAY_NAME*String✅32 charsDisplay name of the application.
RUNTIMEString❌-The runtime environment. Ex.: typescript, nodejs, go.
DESCRIPTIONString✅280 charsDescription/metadata of the application.
AUTORESTARTBoolean✅-Auto-restart (true or false).
STARTString✅256 charsCustom start command.
SUBDOMAINString✅63 charsWebsite subdomain (if applicable).
Editable parameters (✅) can be modified in the dashboard after deployment. Non-editable (❌) parameters require a full reupload of the application to make changes.

​
Detailing the configuration parameters

Below you can see the configuration parameters you can use in your configuration file.

MAIN [*]

Type: String | Editable: ❌ | Limit: 32 charsDefines the main application file.
MAIN=index.js

MAIN=src/loaders/index.js
When this parameter is set, the runtime environment will be inferred based on the main file extension
This setting is IGNORED if you use the START parameter.

MEMORY [*]

Type: Integer | Editable: ✅ | Limit: Minimum 256MB (bot), 512MB (site)Defines the amount of memory your application will use.
MEMORY=256
The value must be specified in megabytes (MB).

VERSION [*]

Type: String | Editable: ❌ | Values: recommended, latest or specific version
We recommend using recommended for optimal stability.
Defines the language version for your application.
VERSION=recommended
Languagerecommendedlatest
Node.js [JS & TS]24.11.025.1.0
Python3.13.93.14.0
JavaJDK 25JDK 25
Elixir1.19.21.19.2
Rust1.91.01.91.0
Ruby3.4.73.4.7
PHP8.4.148.4.14
Go1.25.41.25.4
C#9.0.109.0.10

DISPLAY_NAME [*]

Type: String | Editable: ✅ | Limit: 32 charsDefines the display name of your application.
DISPLAY_NAME=Admin BOT

DESCRIPTION

Type: String | Editable: ✅ | Limit: 280 charsDefines the description of your application.
DESCRIPTION=This bot is designed to help you with your daily tasks.

AUTORESTART

Type: Boolean | Editable: ✅ | Values: true, false | Default: falseDefines whether the application should automatically restart on failure.
AUTORESTART=true

SUBDOMAIN

Type: String | Editable: ✅ | Limit: 63 chars | Default: undefinedDefines the subdomain for your site (web applications only).
SUBDOMAIN=mysite
The final URL will be: mysite.squareweb.app

RUNTIME

Type: String | Editable: ❌Defines a runtime environment manually.
RUNTIME=nodejs
Check the accepted values and environments below.
EnvironmentRUNTIME
Nodejsnodejs, javascript
TypeScripttypescript
Pythonpython
C#/Dotnetc#, dotnet, csharp
ElixirElixir
Javajava
RustRust
PHPphp
Golanggo, golang
HTML/CSSstatic, html
If you set this parameter, you’ll don’t need to set the MAIN, instead, you’ll need to set a custom START command.

START

Type: String | Editable: ✅ | Limit: 256 chars | Default: undefinedDefines a custom start command.
START=npm run start
This parameter overrides the default MAIN behavior.

​
Configuration examples for bots

Here are some examples of configuration for bots: 
# Required parameters.
MAIN=index.js
MEMORY=512
VERSION=recommended
DISPLAY_NAME=Robin bot

# Example with all parameters.
MAIN=index.js
MEMORY=512
VERSION=recommended
DISPLAY_NAME=Robin bot
DESCRIPTION=This bot was created to help with your daily tasks.
START=npm run start
AUTORESTART=true

​
Configuration examples for sites

Here are some examples of configuration for websites:
The site URL will be: mysite.squareweb.app
# Example with all parameters.
MAIN=index.js
MEMORY=1024
VERSION=recommended
DISPLAY_NAME=My site
DESCRIPTION=My site is really cool!
SUBDOMAIN=mysite
START=npm run build && npm run start
AUTORESTART=true
next.config.js as MAIN is only used to let the system recognize the project as a JavaScript or TypeScript project (another .ts/.tsx file)
# Example for a Next.js site.
MAIN=next.config.js
MEMORY=2048
VERSION=recommended
DISPLAY_NAME=Next.js site
DESCRIPTION=This site was built with Next.js.
SUBDOMAIN=nextjs
START=npm run build && npm run start
AUTORESTART=true