部署 - Vercel

警告

由于 Surgio 违反 Vercel 合理使用条款中「服务不可用于 Proxies and VPNs」的规定，将 Surgio 部署至 Vercel 可能引起账号封禁。

准备

注册一个 Vercel 账号
可以不绑定付款方式

配置

首先，安装工具链。

$ npm i -g vercel

在项目中安装 @surgio/gateway。

$ npm i @surgio/gateway --save

提示

之前已经使用了测试版的朋友请使用下面的命令升级到正式版。

$ npm i @surgio/gateway@latest --save

登录账号。

$ vercel login

新建文件 vercel.json。

{
  "version": 2,
  "public": false,
  "builds": [
    { 
      "src": "/gateway.js",
      "use": "@vercel/node",
      "config": {
        "includeFiles": [
          "provider/**",
          "template/**",
           "node_modules/@surgio/gateway-frontend/**",
          "*.js",
          "*.json"
        ]
      }
    }
  ],
  "routes": [
    {
      "src": "/(.*)",
      "dest": "/gateway.js"
    }
  ]
}

在 package.json 中增加如下字段：

{
  "engines": {
    "node": ">=14"
  }
}

编写云函数

新建文件 gateway.js。

'use strict';

const gateway = require('@surgio/gateway');

module.exports = gateway.createHttpServer();

配置

接口鉴权

注意

不建议关闭鉴权！

在 surgio.conf.js 中增加如下字段：

module.exports = {
  gateway: {
    auth: true,
    accessToken: 'YOUR_PASSWORD',
  },
}

提示

完整的 gateway 配置可以在这里查看。
对于已经部署了托管接口的用户，推荐不要第一时间打开鉴权功能，而是配置 accessToken 一段时间后再将 auth 改为 true。这样可以让已经下载过旧托管文件的客户端更新到新的包含有 access_token 参数的托管文件。

部署

$ vercel --prod

如果不出意外你会看到如图的信息，高亮的 URL 即为云函数服务的访问地址。

为了让托管地址保持一致，你需要到 surgio.conf.js 把 urlBase 更新为：

https://xxxxxx.xxx.vercel.app/get-artifact/

最后，再运行一次

$ vercel --prod

更新服务。

使用

移步至

托管 API 的功能介绍

最后

有几点需要大家注意的：

每一次更新本地的代码，都需要执行一次 vercel，保证远端和本地代码一致；
访问日志、监控、域名绑定等复杂功能恕不提供教程；
如果访问地址泄漏，请立即删除云函数然后修改机场密码；
由于免费用户单次请求的超时时间为 10s，所以不建议使用过多的远程片段、较高的超时时间和重试机制。若你为付费用户，可以在 vercel.json 中加入以下的环境变量增加网络重试次数和超时时间。
```
{
  "env": {
    "SURGIO_NETWORK_RETRY": 2,
    "SURGIO_NETWORK_TIMEOUT": "10000"
  }
}
```