简介
要在 Square Cloud 上开发和托管 NestJS 应用,遵循一套结构化的配置和前置条件流程至关重要。本技术指南将涵盖整个过程,从初始设置到生产环境部署。前置条件
本指南运行在 Node.js 运行时上。已于 2026 年 9 月在 Node.js 24 上使用 NestJS 12 测试。创建项目
你的电脑上需要安装 Node.js 和 npm。如果尚未安装,可以从 Node.js 官方网站 下载。全局安装 Nest CLI 并创建项目:nest new 会询问包管理器,并在新的 my-app 文件夹中安装依赖。使用 npm run start:dev 启动开发服务器,它监听 http://localhost:3000。
构建生产版本
NestJS 使用 TypeScript 编写,因此部署前需要将其编译为 JavaScript:build 脚本会运行 nest build,将编译后的文件写入 dist/ 文件夹。入口文件是 dist/main.js,也就是 start:prod 脚本运行的文件。
端口和主机
无需任何修改:生成的src/main.ts 已经会读取 PORT 环境变量(Square Cloud 将其设为 80),并且 Nest 默认监听所有网络接口。在本地,它会回退到 3000 端口:
src/main.ts
./app.module 并以 bootstrap(); 结尾。关键的是 app.listen 这一行。
配置 Square Cloud
在项目根目录创建squarecloud.app 文件:
squarecloud.app
node dist/main.js,与 start:prod 脚本的命令相同。通过控制面板上传时,请将 dist/main.js 设为主文件。
ZIP 中包含哪些文件
dist/,即编译后的应用。package.json。squarecloud.app。
node_modules:Square Cloud 会在首次启动时安装你的 dependencies。
部署并验证
通过控制面板
1
访问上传页面
访问上传页面并上传你的项目 zip 文件。
2
配置你的环境
上传 zip 后,你需要为项目配置名称、主文件或运行时环境以及其他设置。
如果你上传的是 Web 项目,请务必选择 “Web Publication” 并为项目设置子域名。
如果你上传的是 Web 项目,请务必选择 “Web Publication” 并为项目设置子域名。
3
部署你的项目
最后,点击 “Deploy” 按钮,即可将项目托管到 Square Cloud。
部署完成后,你可以在控制面板中监控项目的状态和日志。
部署完成后,你可以在控制面板中监控项目的状态和日志。

4
确认你的应用已上线
首次部署通常在一分钟内完成。在控制面板中,等待你的应用状态显示为运行中,并检查日志中是否有启动错误。
如果你部署的是网站或 API,请在浏览器中打开
如果你部署的是网站或 API,请在浏览器中打开
https://<your-subdomain>.squareweb.app,你应该能看到应用正常响应。如果你部署的是机器人,发送一条命令确认它已上线。
通过 CLI
要使用此方法,你的项目根目录中需要有一个名为squarecloud.app 的配置文件。它告诉 Square Cloud 如何运行你的应用。
配置文件指南
了解如何创建定义你应用环境的
squarecloud.app 配置文件。1
安装 CLI
安装 Square Cloud CLI。如果你已经安装,运行同一条命令即可更新:
2
登录
运行下面的命令。它会打开你的浏览器:在浏览器中批准登录后,CLI 即可使用。无需复制任何 API 密钥。如需在脚本和 CI 中使用,请参阅 CLI 身份验证。
3
上传你的项目
4
确认你的应用已上线
首次部署通常在一分钟内完成。直接在终端中检查你的应用状态和日志:如果你部署的是网站或 API,请在浏览器中打开
https://<your-subdomain>.squareweb.app,你应该能看到应用正常响应。如果你部署的是机器人,发送一条命令确认它已上线。
常见错误
自定义域名
若要使用自定义域名(例如
mysite.com)来代替默认 URL mysite.squareweb.app,你需要 Standard 计划或更高等级。默认 URL 由配置文件中的 SUBDOMAIN 字段决定。要连接你的域名,请参阅如何设置自己的域名。最低内存要求
网站和 API 的最低要求为 512MB RAM,足以在静态运行时上托管静态构建产物。对于在服务器上渲染页面的应用(Next.js、Nuxt、Angular SSR 等),我们建议至少 1GB RAM。对于更大型的应用,请分配更多 RAM,以防止应用内存耗尽而崩溃。
找不到此站点。
请检查子域名/域名是否与 SUBDOMAIN 字段或自定义域名设置中配置的内容一致。如果你刚上传站点,请等待最多 60 秒,让 Square 启用首次访问。
站点响应超时……
你的服务器必须监听端口 80 和主机 0.0.0.0。Square Cloud 会在你的应用中设置 PORT(
80)和 HOST(0.0.0.0)环境变量:请在代码中读取它们,而不要硬编码其他值。只监听 localhost 或 127.0.0.1 的服务器永远收不到请求。The main file is invalid or corrupted
ZIP 中缺少dist/main.js。请运行 npm run build,并检查 dist/ 文件夹是否位于 ZIP 的根目录。
后续步骤
环境变量
将密钥和设置放在代码之外,并在运行时读取。
自定义域名
在 Standard 及以上计划中,用你自己的域名提供应用。
故障排除
修复无法启动的应用或没有响应的站点。

