> For the complete documentation index, see [llms.txt](https://docs.edgegap.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.edgegap.com/zh/docs/sample-projects/ruby-on-rails.md).

# Ruby On Rails

将 Ruby on Rails 应用部署到 Edgegap，并通过全球边缘网络在靠近用户的位置提供服务。

### 安装 Ruby

Edgegap 为您提供一个非常直观的平台，可在您需要的任何地方部署无服务器 Web 应用。对于本教程，我们将介绍部署 Ruby on Rails 的步骤。在检查其他内容之前，请确保您已安装 Ruby。

如果您在 Linux/UNIX 机器上运行，可以使用机器上预装的软件包管理器，并通过终端安装 Ruby。您可以参考 [Ruby 官方文档](https://www.ruby-lang.org/en/documentation/installation/) 以查找与您的 Linux/UNIX 发行版相对应的准确命令。

在 Windows 机器上，您需要下载 [RubyInstaller](https://rubyinstaller.org) 来安装 Ruby。

安装完成后，您可以使用以下命令检查 Ruby 是否已正确安装：

{% code collapsedlinecount="10" %}

```
ruby -v
```

{% endcode %}

现在已经安装了 Ruby，接下来您当然还需要安装 Rails。这相当直接，只需使用以下单条命令即可完成：

{% code collapsedlinecount="10" %}

```
gem install rails
```

{% endcode %}

您可以用与验证 Ruby 安装相同的方式轻松确认 Rails 是否已正确安装。

{% code collapsedlinecount="10" %}

```
rails -v
```

{% endcode %}

### 要求

要跟随本教程，除 Ruby 和 Ruby on Rails 外，您还需要以下内容：

* [Docker Desktop](https://www.docker.com/get-started/)
* [一个 Edgegap 账户](https://app.edgegap.com/auth/login)
* 可访问 [Edgegap 的私有容器仓库](https://docs.edgegap.com/zh/learn/advanced-features/edgegap-container-registry.md) 或其他镜像仓库，例如 [Docker 的容器镜像仓库](https://hub.docker.com/)

### Ruby on Rails 入门

要开始使用 Ruby on Rails，您需要为新项目创建一个文件夹，并在其中运行以下命令：

{% code collapsedlinecount="10" %}

```
rails new edgegap-ruby-rails-demo
```

{% endcode %}

安装过程完成后，您需要修改 routes.rb 文件，该文件位于 config 文件夹中。您的 routes 文件应包含以下内容：

{% code collapsedlinecount="10" %}

```ruby
Rails.application.routes.draw do
  root 'hello_world#index'
end
```

{% endcode %}

您可能会注意到，项目中的 ‘views’ 文件夹里并没有 ‘hello\_world’ 页面。您可以通过相应的控制器轻松生成它。首先，请确保您位于运行 `rails new` 命令时 Rails 为您生成的文件夹中。

如果您使用的是 Linux 发行版，请使用以下命令创建 HelloWorld 控制器：

{% code collapsedlinecount="10" %}

```
rails generate controller HelloWorld index --skip-routes
```

{% endcode %}

skip-routes 选项可确保此命令不会为该控制器生成新路由，这正是我们想要的，因为我们已经手动创建了一个。

对于 Windows，您需要按如下方式向命令中添加一些关键字：

{% code collapsedlinecount="10" %}

```
ruby bin/rails generate controller HelloWorld index –skip-routes
```

{% endcode %}

命令成功执行后，您会在 ‘views’ 文件夹中看到 HelloWorld 页面。在部署之前，您可能需要修正 HTML 语法，以便获得正确的 section 区块。文件应如下所示：

<figure><img src="https://3334189208-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsR0dHSFv9ymoC0DO5G8J%2Fuploads%2Fgit-blob-203bfc13bd043df0ca5bbc9cd9e267e456e53a9e%2Fruby-index-page.png?alt=media" alt=""><figcaption></figcaption></figure>

剩下的最后一步就是在本地部署您的 Ruby on Rails 应用。再次说明，在 Linux 和 Windows 上执行该操作的命令如下：

Linux：

{% code collapsedlinecount="10" %}

```sh
rails server
```

{% endcode %}

Windows：

{% code collapsedlinecount="10" %}

```sh
ruby bin/rails server
```

{% endcode %}

### 将应用容器化

将大多数应用容器化都很直接。您必须创建一个 Dockerfile，然后在 Docker 上运行该文件以创建镜像。Visual Studio Code 是创建 Dockerfile 的不错平台，因为默认情况下，它不会为我们创建的每个新文件都添加扩展名。这正是我们所需要的。只需新建一个文件并命名为 Dockerfile。您会看到旁边出现一个小小的 docker 标志。现在，您可以将此脚本复制并粘贴进去，以获取主要依赖项。此 dockerfile 创建的镜像大约为 700 MB。当然，您可以对其进行优化，但这样大小的容器在 Edgegap 上运行会非常流畅：

{% code collapsedlinecount="10" %}

```dockerfile
FROM ruby:3-alpine
WORKDIR /app
COPY . .
RUN apk add --no-cache build-base tzdata nodejs yarn sqlite-dev postgresql-dev mysql-dev
RUN gem install bundler
RUN bundle install
ENV RAILS_ENV=production
RUN bundle exec rails assets:precompile
EXPOSE 3000
CMD ["rails", "server", "-b", "0.0.0.0"]
```

{% endcode %}

保存 Dockerfile 后，就可以创建镜像了。您可以通过运行以下命令轻松完成：

{% hint style="warning" %}
对于 ARM CPU（Mac M1、M2 等）用户，请添加 `--platform linux/amd64`  选项到你的构建命令中。
{% endhint %}

{% code collapsedlinecount="10" %}

```sh
docker build -t registry.edgegap.com/<YOUR_REPO>/ruby-rails-demo:<YOUR_VERSION_NUMBER> .
```

{% endcode %}

最好按语义化版本规范添加一个版本号，但如果您在首次部署后不打算在 Edgegap 上更新构建，则可以完全省略版本号。但在此之前，您需要将新创建的 docker 镜像推送到您选择的镜像仓库。请记住，我们通过 Edgegap Registry 提供私有仓库，与使用默认 Docker 仓库相比，它能为您带来一系列您不一定能获得的安全优势。要将镜像推送到我们的仓库，您需要先使用以下命令凭据登录：

{% tabs %}
{% tab title="Bash（Linux）" %}

```bash
project='<REGISTRY_PROJECT>';
username='robot$<REGISTRY_ORGANIZATION_ID>+client-push';
token='<REGISTRY_TOKEN>';

echo "$token" | docker login registry.edgegap.com -u "$username" --password-stdin 2>&1
```

{% endtab %}

{% tab title="PowerShell（Windows）" %}

```powershell
$project = '<REGISTRY_PROJECT>'
$username = 'robot$<REGISTRY_ORGANIZATION_ID>+client-push'
$token = '<REGISTRY_TOKEN>'

echo "$token" | docker login registry.edgegap.com -u "$username" --password-stdin 2>&1
```

{% endtab %}
{% endtabs %}

现在，剩下的唯一事情就是像这样推送您的镜像：

{% code collapsedlinecount="10" %}

```sh
docker push registry.edgegap.com/<YOUR_REPO>/ruby-rails-demo:<YOUR_VERSION_NUMBER>
```

{% endcode %}

太好了！现在，您距离在 Edgegap 平台上部署您的 Nuxt 应用只差一步。

### 在 Edgegap 上部署您的应用

在 Edgegap 上部署应用有两种方式。对于这两种方式，您都需要拥有一个我们的账户，您可以点击此处链接免费创建一个。首先，让我们来看看如何通过我们的网站部署容器化应用。

#### 通过 Edgegap 仪表板部署应用

您需要前往 [Edgegap Platform 网站](https://console.edgegap.com/) 并输入您的凭据。完成后，系统会自动将您重定向到仪表板。如果您刚刚创建了账户，您会立即看到启动第一个应用的选项。如果没有，只需前往屏幕左侧菜单中的“Applications & Games”选项卡。您会在右上角看到创建新应用的选项：

<figure><img src="https://3334189208-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsR0dHSFv9ymoC0DO5G8J%2Fuploads%2Fgit-blob-fc4b2486acb434863c2a6fd0e3772e02bfd2e214%2Fcreate-app-nuxt-js.png?alt=media" alt=""><figcaption></figcaption></figure>

点击后，应会出现以下表单：

<figure><img src="https://3334189208-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsR0dHSFv9ymoC0DO5G8J%2Fuploads%2Fgit-blob-488e9bf3f56918ab3e01c15c9364a8fe321a40b5%2Fapp-form-nuxt-js.png?alt=media" alt=""><figcaption></figcaption></figure>

您应填写所有必填字段，完成后，还需要从默认设置中修改几项内容：

* 端口号：此应用需要打开 3000 端口，因此请将其添加到创建表单的“ports”部分。取消勾选验证端口的选项。

填写完表单并提供适当信息后，只需提交即可，您就可以准备部署了。只需选择区域和您希望模拟的玩家数量。

填写完表单并提供适当信息后，只需提交即可，您就可以准备部署了。只需选择区域和您希望模拟的玩家数量。

<figure><img src="https://3334189208-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsR0dHSFv9ymoC0DO5G8J%2Fuploads%2Fgit-blob-810022e4ed498eed59c957e369b76261513c0daa%2Fruby-deployment-edgegap.png?alt=media" alt=""><figcaption></figcaption></figure>

确认您的选择后，您的应用很快就会上线。以下是部署完成后您会看到的内容。您可以通过点击此图中我们圈出的图标自行访问它。

<figure><img src="https://3334189208-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsR0dHSFv9ymoC0DO5G8J%2Fuploads%2Fgit-blob-b407d8a535e2c875804fc36d55999d68b2c82121%2Fruby-deployment-edgegap-2.png?alt=media" alt=""><figcaption></figcaption></figure>

这将打开一个新标签页，您可以在其中找到您的 Nuxt 应用的默认落地页。

#### 通过 Edgegap API 部署应用

虽然我们的网页仪表板是部署应用最友好的方式，但您也可以通过一个非常简单的 API 请求来完成。为此，您可以使用 postman。重要的是，您要访问仪表板以 [创建 API 令牌](broken://pages/63c51b0385ef1748b3681fe05c8bc45ccab89b94) 通过您个人资料中的选项。

拿到 API 令牌后，剩下要做的就是构造一个部署请求，其中包含您的应用名称、版本、IP 地址、您希望部署所在的区域，当然还要把令牌作为授权参数的一部分。您可以在此处的文档中看到完整请求的样子。

发送请求后，您应该会在命令行中看到响应，或者在 Postman 中看到如下内容：

<figure><img src="https://3334189208-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsR0dHSFv9ymoC0DO5G8J%2Fuploads%2Fgit-blob-902356a5acce346433cb04f870f205cc4f161e2d%2Fruby-deployment-api.png?alt=media" alt=""><figcaption></figcaption></figure>

通过 CLI 部署应用所需完成的就只有这些。要确认您的应用已成功部署，您可以再次前往仪表板，并通过点击“Active deployments”选项卡查看正在运行的活动部署。
