Zum Hauptinhalt springen

​
Was ist die Konfigurationsdatei?

Die Konfigurationsdatei ist eine Datei, die die Parameter deiner Anwendung enthält, etwa die Hauptdatei, den Speicher, die Version und weitere Einstellungen. Diese Datei wird verwendet, um deine Anwendung auf der Square Cloud-Plattform zu konfigurieren und zu deployen.
squarecloud.app
MAIN=main_file.js
DISPLAY_NAME=I am the configuration file
MEMORY=512
VERSION=recommended

​
Die Konfigurationsdatei erstellen

Das Erstellen der Konfigurationsdatei ist sehr einfach: Erstelle einfach eine Datei mit dem Namen squarecloud.app oder squarecloud.config und füge die Konfigurationsparameter darin ein.
1

Erweiterung wählen

Die Konfigurationsdatei kann zwei Erweiterungen haben: .app oder .config. Du kannst squarecloud.app oder squarecloud.config verwenden, je nachdem, was du bevorzugst. Tipp: Verwende .app, um Square Cloud zu unterstützen. 🥰😂
Auf macOS empfehlen wir die Verwendung der Erweiterung .config.
Hinweis: .app oder .config bezieht sich auf die Dateierweiterung, nicht auf den Dateinamen.
2

Datei erstellen

Erstelle eine Datei mit der gewählten Erweiterung und füge die Konfigurationsparameter darin ein.

​
Konfigurationsparameter

Nachfolgend siehst du alle Konfigurationsparameter, die für deine Konfigurationsdatei verfügbar sind.
ParameterTypBearbeitbarLimitVerwendung
MAIN*String❌32 ZeichenLegt die Hauptdatei der Anwendung fest. Bsp.: index.js, main.py, usw.
VERSION*String❌-Sprachversion (Bsp.: recommended).
MEMORY*Integer✅-Speichermenge in Megabyte.
DISPLAY_NAME*String✅32 ZeichenAnzeigename der Anwendung.
RUNTIMEString❌-Die Runtime-Umgebung. Bsp.: typescript, nodejs, go.
DESCRIPTIONString✅280 ZeichenBeschreibung/Metadaten der Anwendung.
AUTORESTARTBoolean✅-Automatischer Neustart (true oder false).
STARTString✅256 ZeichenBenutzerdefinierter Startbefehl.
SUBDOMAINString✅63 ZeichenWebsite-Subdomain (falls zutreffend).
Bearbeitbare Parameter (✅) können nach dem Deployment im Dashboard geändert werden. Nicht bearbeitbare Parameter (❌) erfordern einen vollständigen erneuten Upload der Anwendung, um Änderungen vorzunehmen.

​
Die Konfigurationsparameter im Detail

Nachfolgend siehst du die Konfigurationsparameter, die du in deiner Konfigurationsdatei verwenden kannst.

MAIN [*]

Typ: String | Bearbeitbar: ❌ | Limit: 32 ZeichenLegt die Hauptdatei der Anwendung fest.
MAIN=index.js

MAIN=src/loaders/index.js
Wenn dieser Parameter gesetzt ist, wird die Runtime-Umgebung anhand der Erweiterung der Hauptdatei abgeleitet.
Diese Einstellung wird IGNORIERT, wenn du den START-Parameter verwendest.

MEMORY [*]

Typ: Integer | Bearbeitbar: ✅ | Limit: Minimum 256MB (Bot), 512MB (Site)Legt die Speichermenge fest, die deine Anwendung verwenden wird.
MEMORY=256
Der Wert muss in Megabyte (MB) angegeben werden.

VERSION [*]

Typ: String | Bearbeitbar: ❌ | Werte: recommended, latest oder eine spezifische Version
Wir empfehlen die Verwendung von recommended für optimale Stabilität.
Legt die Sprachversion für deine Anwendung fest.
VERSION=recommended
Spracherecommendedlatest
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 [*]

Typ: String | Bearbeitbar: ✅ | Limit: 32 ZeichenLegt den Anzeigenamen deiner Anwendung fest.
DISPLAY_NAME=Admin BOT

DESCRIPTION

Typ: String | Bearbeitbar: ✅ | Limit: 280 ZeichenLegt die Beschreibung deiner Anwendung fest.
DESCRIPTION=This bot is designed to help you with your daily tasks.

AUTORESTART

Typ: Boolean | Bearbeitbar: ✅ | Werte: true, false | Standard: falseLegt fest, ob die Anwendung bei einem Fehler automatisch neu gestartet werden soll.
AUTORESTART=true

SUBDOMAIN

Typ: String | Bearbeitbar: ✅ | Limit: 63 Zeichen | Standard: undefinedLegt die Subdomain für deine Site fest (nur Webanwendungen).
SUBDOMAIN=mysite
Die endgültige URL lautet: mysite.squareweb.app

RUNTIME

Typ: String | Bearbeitbar: ❌Legt eine Runtime-Umgebung manuell fest.
RUNTIME=nodejs
Sieh dir die akzeptierten Werte und Umgebungen unten an.
UmgebungRUNTIME
Nodejsnodejs, javascript
TypeScripttypescript
Pythonpython
C#/Dotnetc#, dotnet, csharp
Elixirelixir
Javajava
Rustrust
Rubyruby, rb
PHPphp
Golanggo, golang
HTML/CSSstatic, html
Wenn du diesen Parameter setzt, musst du MAIN nicht festlegen; lege stattdessen einen benutzerdefinierten START-Befehl fest.

START

Typ: String | Bearbeitbar: ✅ | Limit: 256 Zeichen | Standard: undefinedLegt einen benutzerdefinierten Startbefehl fest.
START=npm run start
Dieser Parameter überschreibt das Standardverhalten von MAIN.

​
Konfigurationsbeispiele für Bots

Hier sind einige Konfigurationsbeispiele für 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

​
Konfigurationsbeispiele für Sites

Hier sind einige Konfigurationsbeispiele für Websites:
Die Site-URL lautet: 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 als MAIN wird nur verwendet, damit das System das Projekt als JavaScript- oder TypeScript-Projekt erkennt (eine weitere .ts/.tsx-Datei).
# 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