Getting Started
How to create your squarecloud.app configuration file
Learn how to create your Square Cloud configuration file
Introduction
The configuration file is a file that will be used to configure your application, it will be used to define the name, description, version, among other things.
Creating the configuration file
Note: .app or .config is the file extension, not the name.
It’s very simple to create the configuration file, just create a file with the name squarecloud.app or squarecloud.config and put the configuration parameters inside it.
Configuration parameters
Minimum memory for bot is 100mb and for website 512mb
| Required parameters | Description | Example |
|---|---|---|
| MAIN | Main file of your application | MAIN=index.js |
| MEMORY | Amount of memory ram | MEMORY=128 |
| VERSION | Version of your application | VERSION=recommended |
| DISPLAY_NAME | Name of application | DISPLAY_NAME=My app! |
| SUBDOMAIN | If you are sending a website | SUBDOMAIN=mysite |
| Optional parameters | Description |
|---|---|
| DESCRIPTION | Description of your application |
| AUTORESTART | Restart your application if it crashes |
| AVATAR | Avatar of your application |
| START | *Custom startup command |
AVATAR: Only Discord and Imgur CDN have their images uploaded to our site.
AUTORESTART is a PAID feature, if you want to use it, you need to buy a plan.
AUTORESTART is a PAID feature, if you want to use it, you need to buy a plan.
Examples of configuration
.
This example just use required parameters. (minimum configuration)
MAIN=index.js
MEMORY=128
VERSION=recommended
DISPLAY_NAME=My app!
This example use all parameters.
MAIN=index.js
MEMORY=128
VERSION=recommended
DISPLAY_NAME=My app!
DESCRIPTION=My app is very cool!
AVATAR=https://cdn.discordapp.com/avatars/.../...png
Website url will be: mysite.squareweb.app
This example use all parameters and custom startup command in a website.
MAIN=index.js
MEMORY=512
VERSION=recommended
DISPLAY_NAME=My website!
DESCRIPTION=My website is very cool!
AVATAR=https://cdn.discordapp.com/avatars/.../...png
SUBDOMAIN=mysite
START=npm run start-build
AUTORESTART=true
Versions
For each language there is a different VERSION parameter, below you can see the available versions for each language. Updated on 07/29/2023.
| Language | Version recommended | Version latest | Old version |
|---|---|---|---|
| JavaScript [Node.js] | 18.17.0 (LTS - 2023) | 20.5.0 | |
| Python | 3.10.12 | 3.11.4 | |
| Java | JDK 17 | JDK 18 | |
| Elixir | 1.15.4 | 1.15.4 | |
| Rust | 1.71.1 | 1.71.1 | |
| PHP | 8.2.10 | 8.2.10 | |
| Go | 1.20.7 | 1.20.7 | |
| HTML/CSS | Build 07-29-23 | Build 07-29-23 |
Technical limits
For security and performance reasons, there are limits on the configuration parameters, below you can see the limits of each parameter.
| Parameter | Limit |
|---|---|
| MAIN | 32 characters |
| DISPLAY_NAME | 32 characters |
| DESCRIPTION | 280 characters |
| AVATAR | 128 characters |
| START | 128 characters |
| SUBDOMAIN | 383 characters |