跳转到主要内容

​
🚀 简介

  • 在开始之前，请确保你的系统上已安装 Elixir。如果尚未安装，你可以从 Elixir 官方网站 下载。
  • 接下来，你需要在 Square Cloud 上创建一个账户，可以通过登录页面完成。你可以使用邮箱、GitHub 或两者结合来创建账户。
  • 最后，你的账户需要有一个有效的付费计划。你可以在这里查看我们的计划并根据需求购买。

​
⚙️ squarecloud.app 文件配置

如果你通过 Square Cloud 网站上传应用，可以忽略本节内容。网站会自动为你创建 squarecloud.app 配置文件。

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

squarecloud.app 文件是一个配置文件，用于配置你的应用；它用来定义名称、描述、 版本、主文件等内容。

​
📄 必需文件

  • main.ex（主文件示例）。
  • mix.exs（依赖文件）。
  • squarecloud.app（包含 Square Cloud 配置的文件）。

​
▶️ 如何启动你的应用

  • 如果配置文件中未定义 START 字段，Square Cloud 将执行 mix run --no-halt 来启动项目。如果定义了 START 字段，则会直接执行其中的值。有关配置文件参数的更多信息，请访问配置参数。
  • Square Cloud 会在本地安装 hex 和 rebar 工具，并通过 mix deps.get 获取项目依赖。

​
🖥️ 为部署准备你的项目

在将项目托管到 Square Cloud 之前，请先检查项目文件是否已正确配置以便托管。
配置文件（squarecloud.app/.config）必须位于 zip 文件的根目录中。否则，Square Cloud 在部署时将无法找到它。

​
📤 如何托管你的项目

现在你已经为 Elixir 项目准备好了所有文件，下一步就是将它们上传到 Square Cloud 并让你的应用上线。有多种上传方式，但我们将介绍两种：通过 Dashboard 或通过 CLI。

​
通过控制面板

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>

​
联系我们

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