Passer au contenu principal

​
Qu’est-ce que le fichier de configuration ?

Le fichier de configuration est un fichier qui contient les paramètres de votre application, tels que le fichier principal, la mémoire, la version et d’autres réglages. Ce fichier est utilisé pour configurer et déployer votre application sur la plateforme Square Cloud.
squarecloud.app
MAIN=main_file.js
DISPLAY_NAME=I am the configuration file
MEMORY=512
VERSION=recommended

​
Créer le fichier de configuration

Créer le fichier de configuration est très simple : il suffit de créer un fichier nommé squarecloud.app ou squarecloud.config et d’y ajouter les paramètres de configuration.
1

Choisir l'extension

Le fichier de configuration peut avoir deux extensions : .app ou .config. Vous pouvez utiliser squarecloud.app ou squarecloud.config, selon votre préférence. Astuce : utilisez .app pour aider à promouvoir Square Cloud. 🥰😂
Sur macOS, nous recommandons d’utiliser l’extension .config.
Remarque : .app ou .config fait référence à l’extension du fichier, et non à son nom.
2

Créer le fichier

Créez un fichier avec l’extension sélectionnée et ajoutez-y les paramètres de configuration.

​
Paramètres de configuration

Ci-dessous, vous pouvez voir tous les paramètres de configuration disponibles pour votre fichier de configuration.
ParamètreTypeModifiableLimiteUtilisation
MAIN*String❌32 car.Définit le fichier principal de l’application. Ex. : index.js, main.py, etc.
VERSION*String❌-Version du langage (Ex. : recommended).
MEMORY*Integer✅-Quantité de mémoire en mégaoctets.
DISPLAY_NAME*String✅32 car.Nom d’affichage de l’application.
RUNTIMEString❌-L’environnement d’exécution. Ex. : typescript, nodejs, go.
DESCRIPTIONString✅280 car.Description/métadonnées de l’application.
AUTORESTARTBoolean✅-Redémarrage automatique (true ou false).
STARTString✅256 car.Commande de démarrage personnalisée.
SUBDOMAINString✅63 car.Sous-domaine du site web (le cas échéant).
Les paramètres modifiables (✅) peuvent être modifiés dans le tableau de bord après le déploiement. Les paramètres non modifiables (❌) nécessitent un réenvoi complet de l’application pour être modifiés.

​
Détail des paramètres de configuration

Ci-dessous, vous pouvez voir les paramètres de configuration que vous pouvez utiliser dans votre fichier de configuration.

MAIN [*]

Type : String | Modifiable : ❌ | Limite : 32 car.Définit le fichier principal de l’application.
MAIN=index.js

MAIN=src/loaders/index.js
Lorsque ce paramètre est défini, l’environnement d’exécution sera déduit à partir de l’extension du fichier principal
Ce réglage est IGNORÉ si vous utilisez le paramètre START.

MEMORY [*]

Type : Integer | Modifiable : ✅ | Limite : Minimum 256 Mo (bot), 512 Mo (site)Définit la quantité de mémoire que votre application utilisera.
MEMORY=256
La valeur doit être spécifiée en mégaoctets (Mo).

VERSION [*]

Type : String | Modifiable : ❌ | Valeurs : recommended, latest ou une version spécifique
Nous recommandons d’utiliser recommended pour une stabilité optimale.
Définit la version du langage pour votre application.
VERSION=recommended
Langagerecommendedlatest
Node.js [JS & TS]24.15.026.1.0
Python3.13.133.14.5
JavaJDK 25JDK 25
Elixir1.19.51.19.5
Rust1.95.01.95.0
Ruby4.0.44.0.4
PHP8.5.68.5.6
Go1.26.31.26.3
.NET/C#10.0.810.0.8

DISPLAY_NAME [*]

Type : String | Modifiable : ✅ | Limite : 32 car.Définit le nom d’affichage de votre application.
DISPLAY_NAME=Admin BOT

DESCRIPTION

Type : String | Modifiable : ✅ | Limite : 280 car.Définit la description de votre application.
DESCRIPTION=This bot is designed to help you with your daily tasks.

AUTORESTART

Type : Boolean | Modifiable : ✅ | Valeurs : true, false | Défaut : falseDéfinit si l’application doit redémarrer automatiquement en cas d’échec.
AUTORESTART=true

SUBDOMAIN

Type : String | Modifiable : ✅ | Limite : 63 car. | Défaut : undefinedDéfinit le sous-domaine de votre site (applications web uniquement).
SUBDOMAIN=mysite
L’URL finale sera : mysite.squareweb.app

RUNTIME

Type : String | Modifiable : ❌Définit manuellement un environnement d’exécution.
RUNTIME=nodejs
Consultez les valeurs et environnements acceptés ci-dessous.
EnvironnementRUNTIME
Nodejsnodejs, javascript
TypeScripttypescript
Pythonpython
C#/Dotnetc#, dotnet, csharp
Elixirelixir
Javajava
Rustrust
Rubyruby, rb
PHPphp
Golanggo, golang
HTML/CSSstatic, html
Si vous définissez ce paramètre, vous n’avez pas besoin de définir MAIN ; à la place, définissez une commande START personnalisée.

START

Type : String | Modifiable : ✅ | Limite : 256 car. | Défaut : undefinedDéfinit une commande de démarrage personnalisée.
START=npm run start
Ce paramètre remplace le comportement par défaut de MAIN.

​
Exemples de configuration pour les bots

Voici quelques exemples de configuration pour les 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

​
Exemples de configuration pour les sites

Voici quelques exemples de configuration pour les sites web :
L’URL du site sera : 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 en tant que MAIN sert uniquement à ce que le système reconnaisse le projet comme un projet JavaScript ou TypeScript (un autre fichier .ts/.tsx)
# 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