# 构建库

**Repository Path**: keyersoft/bundle

## Basic Information

- **Project Name**: 构建库
- **Description**: 构建库
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-08-13
- **Last Updated**: 2025-09-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 部署文档

## 目录

- **deploy.sh：部署脚本**
- client：科尔客户端发布文件
- recorder-helper：录播小助手 web 静态文件

## 环境准备

将此项目中的 `deploy.sh` 脚本，保存至要部署的机器上（可以放于任意位置，推荐放在和即将要部署静态文件的文件夹同级，便于后续调用）

示例项目目录结构：（宿主机）

|      |      |       |              |      |           | 描述                   |
| ---- | ---- | ----- | ------------ | ---- | --------- | ---------------------- |
| /    |      |       |              |      |           | 根目录                 |
| -    | xxxx |       |              |      |           |                        |
|      | -    | keyer |              |      |           |                        |
|      |      | -     | application/ |      |           |                        |
|      |      |       | -            | web  |           | web 项目文件夹         |
|      |      |       |              | -    | static    | 要部署静态文件的文件夹 |
|      |      |       |              | -    | deploy.sh | 运维脚本               |

### 命令使用

```bash
# 查看命令行工具文档
./deploy.sh -h
# 或
./deploy.sh help
```

## 安装依赖

```bash
./deploy.sh install
```

## 部署

克隆此仓库至服务器宿主机的 `static` 文件夹

```bash
# 将 https://gitee.com/keyersoft/bundle.git 库中的 recorder-helper （录播小助手）项目部署到 static 文件夹中
./deploy.sh init https://gitee.com/keyersoft/bundle.git recorder-helper ./static
```

具体是克隆到哪个文件夹，看 docker compose 配置，卷映射配置的是将宿主机的哪个文件夹为 Nginx 配置中 `root` 配置指向的文件夹

## 更新

```bash
# 更新已部署到 static 中的 recorder-helper （录播小助手）项目
./deploy.sh update ./static recorder-helper

# 强制更新，在手动修改过部署的文件时，会丢弃所有的更改
./deploy.sh update ./static -f recorder-helper
```

## 回撤

```bash
# 回撤已部署到 static 中的 recorder-helper （录播小助手）项目到上一个版本
./deploy.sh revert ./static recorder-helper

# 回撤两个版本，可以回撤 n 个版本，n 为 git 记录个数
./deploy.sh revert ./static recorder-helper 2
```

## 查看版本

查看当前部署过的所有项目版本信息

```bash
./deploy.sh version ./static
```

## 枚举

列出当前已经部署过的项目子模块名称，此名称作为上述所有命令中需要子模块名称参数的值

```bash
# 查看命令行工具文档
./deploy.sh list ./static
```