跳转到主要内容

​
简介

要在 Square Cloud 上开发和托管 ，遵循一套结构化的配置和前置条件流程至关重要。本技术指南将涵盖整个过程，从初始设置到生产环境部署。

​
前置条件

  • Square Cloud 账户：通过注册页面使用你的邮箱进行注册。
  • 有效的付费套餐：为你的应用提供专属资源和优化的性能。查看我们可用的套餐，选择最适合你需求的方案。

​
创建项目

开始之前，请确保你的系统已安装 Node.js (>= 20) 和 npm。 如果尚未安装，请从 Node.js 官方网站下载。

​
安装 Remix CLI

要创建和管理 Remix 应用，请全局安装 Remix CLI： 
npm install -g create-remix

​
开发项目

现在使用以下命令创建一个新的 Remix 项目： 
create-remix myapp
选择你偏好的部署目标。
对于 Square Cloud，推荐使用 Node.js server 选项。 创建完成后，进入你的项目目录并安装依赖： 
cd myapp 
npm install
启动开发服务器： 
npm run dev
这通常会在 http://localhost:5173/ 启动你的应用。

​
基础路由示例

Remix 路由是基于文件的。以下是 app/routes/_index.tsx 中一个简单路由的示例： 
export default function Index() {
  return <h1>Hello World from Remix!</h1>;
}

​
构建项目

上传之前，先构建生产版本输出： 
npm run build

​
选择生产服务器

要在生产环境中提供你的 Remix 应用，你需要一个服务器。你可以创建自己的服务器，也可以使用现有的服务器。

​
Remix serve

你可以使用 remix 网页服务器来提供服务。为此，运行 remix-serve 命令并指定 dist 文件夹即可。 请参考下方示例： 
npx remix-serve remix-serve build/index.js

​
部署

准备好项目文件后，你现在可以将它们上传到 Square Cloud 并托管你的项目。 为此，请创建一个包含所有项目文件的 ZIP 文件。

​
通过控制面板

1

访问上传页面

访问上传页面并上传你的项目 zip 文件。
2

配置你的环境

上传 zip 后，你需要为项目配置名称、主文件或运行时环境以及其他设置。
如果你上传的是 Web 项目，请务必选择 “Web Publication” 并为项目设置子域名。
3

部署你的项目

最后，点击 “Deploy” 按钮，即可将项目托管到 Square Cloud。
部署完成后，你可以在控制面板中监控项目的状态和日志。
正在上传应用到 Square Cloud

​
通过 CLI

要使用此方法，你需要在项目根目录中创建一个名为 squarecloud.app 的配置文件。该文件将包含项目所需的配置。

了解更多：如何为 Square Cloud 创建配置文件。

squarecloud.app 文件是一个配置文件，用于配置你的应用；它将用于定义你的环境。
1

安装 CLI

首先，你的环境中需要已安装 CLI。如果尚未安装，请在终端中运行以下命令：
npm install -g @squarecloud/cli
如果你已经安装，我们建议对其进行更新。为此，请在终端中运行以下命令：
squarecloud update
2

进行身份验证

现在，要进行身份验证并使用其他 CLI 命令，你可以在此处点击 “Request API Key” 找到你的授权密钥。获取授权密钥后，运行以下命令：
squarecloud auth login
3

上传你的项目

最后，要使用 CLI 将应用部署到 Square Cloud，你需要运行以下命令：
squarecloud upload
或者，如果你手动创建了 zip 文件，可以使用：
squarecloud upload --file <path/to/zip>

​
更多资源

有关 Remix 的更多信息，请查阅官方文档此处。它包含全面的指南、教程、API 参考和最佳实践。

​
故障排查

​
自定义域名

若要使用自定义域名（例如 mysite.com）来代替默认 URL mysite.squareweb.app，你需要 Standard 计划或更高等级。子域名由配置文件中的 SUBDOMAIN 字段定义。

​
最低内存要求

简单网站/API 的最低要求为 512MB RAM。对于使用框架的站点（Next.JS、React、Vue、Angular 等），我们始终建议至少 1GB RAM。对于更大型的应用，请分配更多 RAM，以防止应用内存耗尽而崩溃。

​
找不到此站点。

请检查子域名/域名是否与 SUBDOMAIN 字段或自定义域名设置中配置的内容一致。如果你刚上传站点，请等待最多 60 秒，让 Square 启用首次访问。

​
站点响应超时……

请检查你是否在应用中正确配置了端口 80 和主机 0.0.0.0。我们建议使用 Square 强制注入的环境变量：来自 .env 文件的 PORT 和 HOST。

​
联系我们

如果你仍然遇到技术问题，我们的专业支持团队可以为你提供帮助。联系我们，我们很乐意协助你解决任何问题。