开始之前
- 一个用于编写 HTML 和 CSS 文件的文本编辑器,例如 Visual Studio Code。
- 一个 Square Cloud 账户:使用邮箱或 GitHub 注册。
- 一个有效的计划。查看计划并选择适合你项目的计划。
静态站点与服务端渲染应用
静态站点是一组对每位访问者都相同的文件:纯 HTML 页面,或 Vite、React、Vue、Angular、Astro、Gatsby 等框架的构建输出。静态运行时会原样提供这些文件。 服务端渲染应用会在每次请求时用服务器代码生成页面,例如 Next.js、Nuxt、React Router 或 API。它需要一个持续运行的进程,因此运行在语言运行时上,例如带有MAIN 文件或 START 命令的 Node.js 运行时。
如果你的框架两者都支持,静态构建是更轻量的选择。每个框架指南都会说明它支持哪些方案。
配置 Square Cloud
如果你通过控制面板上传应用,可以跳过本节:控制面板会自动为你创建
squarecloud.app 配置文件。配置文件参考
squarecloud.app 文件告诉 Square Cloud 如何运行你的应用:主文件、内存、运行时版本、名称,以及网站所用的子域名。MAIN 会选择静态运行时:
squarecloud.app
静态运行时如何提供文件
- ZIP 的根目录就是站点的根目录:
about.html在/about.html提供,blog/index.html在/blog/提供。 - 如果存在
vite.html,/会提供它,否则提供index.html。 - 当路径不匹配任何文件时,如果存在
vite.html,运行时会提供它。无论使用什么框架,这都能让单页应用的客户端路由在刷新后继续正常工作:只需将构建产物中的index.html重命名为vite.html。 - 没有
vite.html时,未知路径会返回你的404.html;如果你没有该文件,则返回默认的 404 页面。 - 文件会被实时压缩,而你的
squarecloud.app文件永远不会被提供。
准备项目
将文件放在 ZIP 的根目录,与squarecloud.app 并列:
index.html,单页应用则使用vite.html。- 你的 CSS、JavaScript、图片和字体,可以使用任意文件夹结构。
404.html(可选):不存在的路径所显示的页面。
框架指南
每个指南都介绍了构建命令、输出文件夹以及如何在静态运行时上发布。Vite
React
Vue
Angular
Astro
Gatsby
Preact
Qwik
SolidJS
Nuxt
故障排除
出现 Square Shield 默认页面
出现 Square Shield 默认页面
页面显示 “Hi, I’m Square Shield”:运行时在 ZIP 的根目录找不到
index.html 或 vite.html。你可能压缩的是构建文件夹本身,而不是其中的内容:请压缩文件夹里的文件。刷新某个路由时返回 404
刷新某个路由时返回 404
你的单页应用在浏览器中处理路由。请将其
index.html 重命名为 vite.html,让未知路径加载应用,并同时更新 MAIN。部署
通过控制面板
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,你应该能看到应用正常响应。如果你部署的是机器人,发送一条命令确认它已上线。
后续步骤
环境变量
将密钥和设置放在代码之外,并在运行时读取。
自定义域名
在 Standard 及以上计划中,用你自己的域名提供应用。
故障排除
修复无法启动的应用或没有响应的站点。

