> ## Documentation Index
> Fetch the complete documentation index at: https://docs.squarecloud.app/llms.txt
> Use this file to discover all available pages before exploring further.

# 如何在 Square Cloud 上部署 n8n

> 本教程将指导你在 Square Cloud 上创建和部署你的 n8n 应用。

## 简介

* 本文将指导你在 Square Cloud 上创建和托管一个 n8n 应用。
* 在开始之前，请确保你在 Square Cloud 上拥有一个账户，可以通过注册页面完成。你可以使用你的邮箱来创建账户。
* 最后，你的账户上需要有一个至少 4GB RAM 的有效付费套餐。你可以查看我们的套餐并根据你的需求在[这里](https://squarecloud.app/zh/pricing)购买。

## 创建项目

* 首先我们需要一个 javascript 环境。为此，我们需要一个 package.json。
* package.json 的 dependencies 字段中必须包含 n8n，并且必须有启动它的 scripts。以下是示例：

```json package.json theme={null}
{
  "name": "squarecloud-n8n",
  "version": "1.0.0",
  "main": "index.js",
  "type": "module",
  "scripts": {
    "start": "n8n"
  },
  "author": "Square Cloud Education <squarecloud.app>",
  "license": "ISC",
  "dependencies": {
    "n8n": "latest"
  }
}
```

<Info>
  我们已经在我们的仓库[这里](https://github.com/squarecloud-education/n8n-web/releases)准备好了所有可供部署的内容。你只需下载 `project.zip` 并上传即可。
</Info>

## 📁 必需文件

你的 zip 中需要包含以下文件：

* package.json
* .env（可选）

## ⚙️ 配置文件

* 你需要将运行时环境配置为 `Detect manually` 并将其设置为 `NodeJS`。在 squarecloud.config 或 squarecloud.app 中看起来会是这样：

```systemd squarecloud theme={null}
DISPLAY_NAME=App name
RUNTIME=nodejs
START=npm run start
MEMORY=3072
VERSION=recommended
SUBDOMAIN=my-n8n-subdomain
```

* 接下来，我们需要在 `.env` 文件或上传菜单中的 Square Cloud 环境里设置 2 个环境变量：`N8N_HOST` 和 `N8N_PORT`。它们的值必须为 `0.0.0.0` 和 `80`。

```systemd .env theme={null}
N8N_HOST=0.0.0.0
N8N_PORT=80
```

## 将项目上传到 Square Cloud

准备好项目文件后，你现在可以将它们上传到 Square Cloud 并托管你的项目。

<Tabs>
  <Tab title="通过 Dashboard 上传">
    访问 [Square Cloud Dashboard](https://squarecloud.app/zh/dashboard/new) 并上传你的项目文件。

    <Frame>
      <img src="https://cdn.squarecloud.app/docs/articles/dashboard/uploading.gif" alt="正在上传应用到 Square Cloud" style={{ borderRadius: "0.2rem" }} />
    </Frame>
  </Tab>

  <Tab title="通过 CLI 上传">
    <Steps>
      <Step title="第一步">
        首先，你需要在环境中安装 CLI。如果你还没有安装，请在终端中运行以下命令：

        ```
        npm install -g @squarecloud/cli
        ```

        如果你已经安装了，我们建议更新它。为此，请在终端中运行以下命令：

        <Tabs>
          <Tab title="Windows">
            ```bash theme={null}
            squarecloud update
            ```
          </Tab>

          <Tab title="Linux、macOS 和 WSL">
            ```bash theme={null}
            curl -fsSL https://cli.squarecloud.app/install | bash
            ```
          </Tab>
        </Tabs>
      </Step>

      <Step title="第二步">
        现在，要进行身份验证并使用其他 CLI 命令，你可以在[这里](https://squarecloud.app/zh/account/security)点击 "Request API Key" 找到你的授权密钥。获取授权密钥后，运行以下命令：

        ```bash theme={null}
        squarecloud auth login
        ```
      </Step>

      <Step title="第三步">
        最后，要使用 CLI 将你的应用部署到 Square Cloud，你需要运行以下命令，并传入你的 zip 文件路径：

        ```bash theme={null}
        squarecloud upload zip
        ```
      </Step>
    </Steps>
  </Tab>
</Tabs>