Surge配置指南

安装 Surge

使用 npm

打开终端，运行以下命令安装 Surge：

npm install -g surge

使用 Homebrew（Mac 用户）

安装 Homebrew 后,运行：

brew install surge

下载 binaries

从 Surge 官网 下载适合你操作系统的 binaries 并安装。

初始化 Surge 项目

在项目根目录中，运行以下命令初始化 Surge：

surge init

这会生成一个 surge.json 文件。

配置 surge.json

在 surge.json 文件中,配置项目信息：

{
  "surge": {
    "src": "./", // 项目根目录，默认为当前目录
    "private": true, // 是否私有项目
    "build": "surge", // 构建文件的路径，默认为 `surge`
    "to": "surge@example.com" // 指向域名，`surge: surge@yourdomain.com`
  }
}

配置说明：

• src：项目根目录,默认为当前目录。
• private：设置为 true 以保护项目不公开。
• build：构建文件的路径，默认为 surge。
• to：指定生成的文件名和域名，格式为 surge@yourdomain.com。

配置 package.json

在项目根目录中，编辑 package.json,添加以下内容：

{
  "name": "project-name",
  "version": "1..",
  "private": true,
  "scripts": {
    "prebuild": "npm run lint:fix",
    "build": "surge build",
    "postbuild": "surge delete --force"
  }
}

脚本说明：

• prebuild：在构建前执行的脚本,例如检查代码风格或清理文件。
• build：使用 surge 命令构建项目。
• postbuild：构建完成后执行的脚本,例如删除旧版本或清理缓存。

部署项目

运行以下命令将项目部署到 Surge：

npm run surge

项目部署完成后：

• 在浏览器中访问 http://surge[subdomain].yourdomain.com，subdomain 是随机生成的。
• Surge 会自动在默认浏览器中打开该 URL。

使用自定义域名

如果你有自己的域名,按照以下步骤配置：

1. 修改 surge.json 中的 to 为 https://yourdomain.com：

   "to": "https://yourdomain.com"

2. 在 Surge官网 创建项目：

   • 项目名称为你的项目名称。
   • 指向设置为你的 GitHub 存储库。
   • 域名设置为你的域名。

高级配置

修改 HTTPS 设置

在 surge.json 中添加 force_https：

{
  "surge": {
    "force_https": true // 强制使用 HTTPS
  }
}

自定义构建文件路径

如果需要修改构建文件路径，编辑 surge.json：

{
  "surge": {
    "build": "custom-build"
  }
}

常见问题

Surge failed to build

• 检查 package.json 中的 scripts 是否正确。
• 确保所有依赖项已经安装，运行 npm install。

Cannot access 'file:///...'

• 确保项目根目录权限正确，可能需要使用 chmod 755 .。

Failed to deploy

• 检查网络连接，确保 Surge 能够访问互联网。

使用命令行工具

• surge init：生成初始 surge.json 文件。
• surge list：列出已部署的子域名。
• surge delete：删除项目，格式为 surge delete [subdomain]。

示例

{
  "surge": {
    "src": ".",
    "private": true,
    "build": "surge",
    "to": "surge@yourdomain.com"
  }
}