package.json und startet deine App mit Node.js.
Bevor du beginnst
- Node.js und npm auf deinem Rechner. Falls du sie noch nicht hast, lade sie von der offiziellen Node.js-Website herunter.
- Ein Square Cloud-Konto: Registriere dich mit deiner E-Mail-Adresse oder mit GitHub.
- Ein aktiver Plan. Sieh dir die Pläne an und wähle den, der zu deinem Projekt passt.
Square Cloud konfigurieren
Wenn du deine Anwendung über das Dashboard hochlädst, kannst du diesen Abschnitt überspringen: Das Dashboard erstellt die Konfigurationsdatei
squarecloud.app für dich.Referenz zur Konfigurationsdatei
Die Datei
squarecloud.app sagt Square Cloud, wie deine Anwendung ausgeführt wird: ihre Hauptdatei, ihr Arbeitsspeicher, ihre Runtime-Version, ihr Name und, bei einer Website, ihre Subdomain.- Bot oder Worker
- Website oder API
squarecloud.app
VERSION=recommended nutzt die aktuelle LTS-Linie von Node.js, VERSION=latest die neueste Version.
Was Square Cloud ausführt
- JavaScript
- TypeScript
- Wenn das Feld
STARTin der Konfigurationsdatei nicht definiert ist, führt Square Cloudnode MAINaus. Hat die App 1024 MB Arbeitsspeicher oder mehr, fügt es--max_old_space_size=<MEMORY>hinzu (das Heap-Limit von Node.js, in MB). Ist das FeldSTARTdefiniert, wird der darin enthaltene Wert direkt ausgeführt. Weitere Informationen zu den Parametern der Konfigurationsdatei findest du unter Konfigurationsparameter.
- Hat die App keinen Ordner
node_modules, führt Square Cloud vor dem Startnpm install --no-audit --no-fundaus. Pakete indevDependencieswerden nicht installiert, weil die RuntimeNODE_ENV=productionsetzt. Existiertnode_modulesbereits, wird der Installationsschritt übersprungen.
Port und Host für Websites und APIs
Square Cloud setzt die UmgebungsvariablePORT auf 80 und HOST auf 0.0.0.0. Dein Server muss auf diesem Port und auf allen Netzwerkschnittstellen lauschen, zum Beispiel mit Express:
PORT selbst: Ihre Framework-Leitfäden sagen dir, wann es nichts zu ändern gibt.
Projekt vorbereiten
Erforderliche Dateien
squarecloud.app, im Stammverzeichnis der ZIP-Datei.- Deine Hauptdatei, zum Beispiel
index.jsodersrc/index.ts. package.jsonmit deinen Abhängigkeiten. Ein Upload ohne sie schlägt mitINVALID_DEPENDENCYfehl.
Square Cloud führt TypeScript nativ mit
tsx aus (npx tsx MAIN), für die Produktion wird das Kompilieren zu JavaScript aber weiterhin empfohlen: Baue das Projekt auf deinem Rechner und lass MAIN auf die kompilierte Datei zeigen.Was du weglassen solltest
node_modules: Square Cloud entfernt diesen Ordner aus deinem Upload und installiert beim ersten Start die Abhängigkeiten auspackage.json. So bleibt der Upload klein, und die Abhängigkeiten werden für das System des Servers gebaut.- Lockfiles (
package-lock.json,yarn.lock,pnpm-lock.yaml): Die CLI und die VS Code-Erweiterung lassen sie standardmäßig weg, sodass npm die neuesten Versionen installiert, die die Bereiche inpackage.jsonerlauben. Wenn du genau die Versionen aus deinem Lockfile brauchst, nimm es mit!package-lock.jsonin deinersquarecloud.ignorewieder auf.
Framework-Leitfäden
Express
Fastify
NestJS
Next.js
Nuxt
React Router
Angular
Astro
SolidJS
Qwik
React
Vue
Fehlerbehebung
Die Hauptdatei ist ungültig oder beschädigt
Die Hauptdatei ist ungültig oder beschädigt
Dieser Fehler tritt auf, wenn die als „main” für deine Anwendung in der
Konfigurationsdatei definierte Datei nicht existiert, falsch geschrieben ist oder der Pfad
falsch ist. Wenn sich deine Hauptdatei zum Beispiel in einem Ordner befindet,
musst du
folder/file.js angeben.Unzureichender Arbeitsspeicher
Unzureichender Arbeitsspeicher
Die minimale Menge an RAM, die zum Hosten eines Bots erforderlich ist, beträgt 256 MB und für
eine Website/API 512 MB. Abhängig von Größe und Komplexität
deiner Anwendung kann es jedoch ratsam sein, eine größere Menge RAM zuzuweisen, um
zu vermeiden, dass deiner Anwendung der Speicher ausgeht und sie abstürzt.
Deployen
Über das Dashboard
1
Upload-Seite aufrufen
Rufe die Upload-Seite auf und lade die ZIP-Datei deines Projekts hoch.
2
Umgebung konfigurieren
Nachdem du deine ZIP-Datei hochgeladen hast, musst du den Namen, die Hauptdatei oder Runtime-Umgebung und weitere Einstellungen für dein Projekt konfigurieren.
Wenn du ein Web-Projekt hochlädst, achte darauf, “Web Publication” auszuwählen und deinem Projekt eine Subdomain zuzuweisen.
Wenn du ein Web-Projekt hochlädst, achte darauf, “Web Publication” auszuwählen und deinem Projekt eine Subdomain zuzuweisen.
3
Projekt bereitstellen
Klicke abschließend auf die Schaltfläche “Deploy”, um dein Projekt auf Square Cloud zu hosten.
Nach dem Deploy kannst du den Status und die Logs deines Projekts über das Dashboard überwachen.
Nach dem Deploy kannst du den Status und die Logs deines Projekts über das Dashboard überwachen.

4
Bestätige, dass deine App live ist
Dein erstes Deploy dauert in der Regel weniger als eine Minute. Warte im Dashboard, bis der Status deiner Anwendung als “running” angezeigt wird, und prüfe die Logs auf Startfehler.
Wenn du eine Website oder API bereitgestellt hast, öffne
Wenn du eine Website oder API bereitgestellt hast, öffne
https://<deine-subdomain>.squareweb.app in deinem Browser: du solltest sehen, dass deine Anwendung reagiert. Wenn du einen Bot bereitgestellt hast, sende ihm einen Befehl, um zu bestätigen, dass er online ist.
Über die CLI
Um diese Methode zu nutzen, braucht dein Projekt eine Konfigurationsdatei mit dem Namensquarecloud.app im Stammverzeichnis. Sie teilt Square Cloud mit, wie deine Anwendung ausgeführt wird.
Leitfaden zur Konfigurationsdatei
Erfahre, wie du die Konfigurationsdatei
squarecloud.app erstellst, die die Umgebung deiner Anwendung definiert.1
CLI installieren
Installiere die Square Cloud CLI. Falls du sie bereits hast, führe denselben Befehl aus, um sie zu aktualisieren:
2
Anmelden
Führe den folgenden Befehl aus. Er öffnet deinen Browser: Bestätige dort die Anmeldung, und die CLI ist einsatzbereit. Es gibt keinen API-Schlüssel zu kopieren. Für Skripte und CI siehe CLI-Authentifizierung.
3
Projekt hochladen
Führe in deinem Projektordner den folgenden Befehl aus. Die CLI packt den aktuellen Ordner als ZIP, lässt dabei weg, was in der Um eine selbst erstellte ZIP-Datei hochzuladen, übergib sie mit
squarecloud.ignore steht, und lädt ihn hoch:--file:4
Bestätige, dass deine App live ist
Dein erstes Deploy dauert in der Regel weniger als eine Minute. Prüfe den Status und die Logs deiner Anwendung direkt im Terminal:Wenn du eine Website oder API bereitgestellt hast, öffne
https://<deine-subdomain>.squareweb.app in deinem Browser: du solltest sehen, dass deine Anwendung reagiert. Wenn du einen Bot bereitgestellt hast, sende ihm einen Befehl, um zu bestätigen, dass er online ist.
Nächste Schritte
Umgebungsvariablen
Halte Geheimnisse und Einstellungen aus deinem Code heraus und lies sie zur Laufzeit.
Eigene Domain
Stelle deine App unter deiner eigenen Domain bereit, ab dem Standard-Plan.
Fehlerbehebung
Behebe Probleme mit einer App, die nicht startet, oder einer Website, die nicht antwortet.

