Skip to main content

​
简介

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

​
前置条件

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

​
创建项目

你的电脑上需要安装 Ruby 和 Bundler。如果尚未安装 Ruby，可以从 Ruby 官方网站 下载。安装 Rails 并创建项目：
新的 Rails 项目使用存储在 storage/ 文件夹中的 SQLite，因此无需外部数据库即可运行。启动开发服务器：
在开发环境中，Rails 监听 http://localhost:3000。在你的电脑上保留默认端口即可：本地不需要使用 80 端口。

​
构建生产版本

Square Cloud 会在应用启动时准备它：先运行 bundle install 安装 Gemfile 中的 gem，然后由你的 START 命令预编译资源并准备数据库。Ruby 运行时会设置 RACK_ENV=production，因此 Rails 以生产模式运行。

​
端口和主机

无需任何修改：rails server 会读取 PORT 环境变量（Square Cloud 将其设为 80），并且在生产环境中监听所有网络接口。

​
环境变量

在控制面板中或使用 squarecloud app env set 设置以下环境变量：

​
配置 Square Cloud

在项目根目录创建 squarecloud.app 文件：
squarecloud.app
每次启动时，该命令会：
  • 删除上一次运行遗留的服务器 PID 文件，否则 Rails 无法启动；
  • rails assets:precompile 将你的 CSS 和 JavaScript 构建到 public/assets；
  • rails db:prepare 创建数据库或执行待处理的迁移；
  • rails server 启动 Puma。
RUNTIME=ruby 会选择 Ruby 运行时而无需 MAIN 文件。这些命令使用 bundle exec rails 而不是 bin/rails，因为在 Windows 上制作的 ZIP 可能会丢失 bin/rails 的执行权限。

​
ZIP 中包含哪些文件

  • 整个项目：app/、bin/、config/、db/、lib/、public/、Gemfile、Gemfile.lock 和 config.ru。
  • squarecloud.app。
不要包含 config/master.key（密钥放在 RAILS_MASTER_KEY 中）、log/、tmp/ 以及 storage/ 中的本地数据库。

​
部署并验证

​
通过控制面板

1

访问上传页面

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

配置你的环境

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

部署你的项目

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

确认你的应用已上线

首次部署通常在一分钟内完成。在控制面板中，等待你的应用状态显示为运行中，并检查日志中是否有启动错误。
如果你部署的是网站或 API，请在浏览器中打开 https://<your-subdomain>.squareweb.app，你应该能看到应用正常响应。如果你部署的是机器人，发送一条命令确认它已上线。
应用无法启动？请参见故障排除指南，了解最常见的原因和解决方法。

​
通过 CLI

要使用此方法，你的项目根目录中需要有一个名为 squarecloud.app 的配置文件。它告诉 Square Cloud 如何运行你的应用。

配置文件指南

了解如何创建定义你应用环境的 squarecloud.app 配置文件。
1

安装 CLI

安装 Square Cloud CLI。如果你已经安装，运行同一条命令即可更新：
2

登录

运行下面的命令。它会打开你的浏览器：在浏览器中批准登录后，CLI 即可使用。无需复制任何 API 密钥。如需在脚本和 CI 中使用，请参阅 CLI 身份验证。
3

上传你的项目

在项目文件夹中运行下面的命令。CLI 会将当前文件夹打包为 zip（排除 squarecloud.ignore 中列出的内容）并上传：
要上传你自己创建的 zip，请通过 --file 传入：
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 的服务器永远收不到请求。

​
Missing secret_key_base or ActiveSupport::MessageEncryptor::InvalidMessage

RAILS_MASTER_KEY 缺失，或与 config/credentials.yml.enc 不匹配。请复制创建这些凭据时所用的 config/master.key 的内容，然后重启应用。

​
后续步骤

环境变量

将密钥和设置放在代码之外，并在运行时读取。

自定义域名

在 Standard 及以上计划中，用你自己的域名提供应用。

故障排除

修复无法启动的应用或没有响应的站点。
有关 Rails 的更多信息，请参阅 Rails 官方指南。

​
联系我们

如果你仍然遇到技术问题，我们的专业支持团队可以为你提供帮助。联系我们，我们很乐意协助你解决任何问题，支持质量正是开发者给予 Square Cloud 4.9/5 评分（共 402 条评价）（Google 与 Trustpilot）的重要原因之一。