Docker 镜像 - 安装使用¶

本页面介绍了如何使用 Docker 和 Docker Compose 来运行录播姬。两种运行方式选择一个即可。

拉取镜像¶

Docker 镜像在 Docker Hub 和 GitHub Container registry 上提供。

两个位置提供的正式版本镜像完全一样。
GitHub Container registry 上除了正式版以外还提供了开发版的镜像。

docker pull bililive/recorder:latest
# 或指定 tag (请注意此处写的可能不是最新版本)
docker pull bililive/recorder:2
docker pull bililive/recorder:2.0
docker pull bililive/recorder:2.0.0

docker pull ghcr.io/bililiverecorder/bililiverecorder
# 或指定 tag (请注意此处写的可能不是最新版本)
docker pull ghcr.io/bililiverecorder/bililiverecorder:2
docker pull ghcr.io/bililiverecorder/bililiverecorder:2.0
docker pull ghcr.io/bililiverecorder/bililiverecorder:2.0.0

关于镜像 tag 的含义

latest 是最新的一个正式版本。
2 是大版本为 2 的最新一个版本。
2.0 是大版本为 2 次版本为 0 的最新一个版本。
2.0.0 是固定的 2.0.0 版，不会变。

镜像的默认 cmd

录播姬的镜像中 entrypoint 已经设置成运行录播姬，默认的 cmd 是在用容器内的 /rec 作为工作目录运行。
镜像的默认命令相当于是：

./brec run --bind http://*:2356 /rec

地址有变动

之前镜像地址是 ghcr.io/bililive/bililiverecorder 这个旧地址已经不再使用。

这个地址目前暂时还可以拉取旧版本的镜像文件，之后会完全删除。
请更换到上面给出的两个镜像。

不要误用开发版本

ghcr.io/bililiverecorder/bililiverecorder 同时提供了开发版，注意不要误用开发版本。
不要用 dev edge 等 tag。开发版不保证能用。

运行录播姬¶

录播姬的配置文件和录制的视频文件在同一个文件夹内。配置文件在工作目录里，文件名是 config.json。一般来说不推荐手写配置文件，可以复制录播姬桌面版的配置文件、或者在浏览器打开录播姬管理页面来添加房间、修改设置。如果需要手改配置文件的话可以参考配置文件页面。

完整的 Docker 启动命令例子：

# 复制粘贴运行之前记得修改  "宿主机路径"
docker run -d -v 宿主机路径:/rec -p 2356:2356 bililive/recorder
# 或使用 ghcr.io ，两个不同的 registry 里的镜像内容是一样的
docker run -d -v 宿主机路径:/rec -p 2356:2356 ghcr.io/bililiverecorder/bililiverecorder

重要安全提醒

如果要把录播姬的管理页面对公网开放，请一定一定一定做好安全措施，给录播姬设置一个密码，或使用其他有身份验证功能的反向代理软件。

直接把没有身份验证的录播姬暴露到公网可能会有严重的安全风险。轻则被添加一大堆直播间导致硬盘塞满，重则可能会被任意上传下载文件。（理论上是不能通过录播姬来做到任意代码执行的，不过不做任何保证）

注意映射存储路径

如果对 Docker 的原理和使用方法不太了解，在使用录播姬之前强烈建议通过 Docker 官方文档或其他中文教程等途径了解 Docker 使用方法。
其中重点注意挂载目录（有的文章里也叫做卷/绑定/Volume 等）相关的内容，如 Docker 官方文档的 Manage data in Docker 章节，避免出现录了之后找不到文件的情况。

提醒：如果没有把录播姬的工作目录映射到宿主机，录制的视频文件会在容器内部，容器被删除之后文件也会丢失。同时需要注意 Docker 不支持修改已有容器的运行参数、映射目录等设置，各种 Docker 管理网页的修改设置功能是会先删除容器再重新创建一个新容器，如果没有把录播姬的工作目录映射到宿主机，这样的操作会导致录制的视频文件丢失。可以使用 docker cp 命令把容器里的文件复制出来，具体方法请参考 Docker 官方文档。

录播姬目前有 HTTP Basic 登录功能，设置了用户名和密码的 docker 命令例：

docker run -d -v 宿主机路径:/rec -p 2356:2356 bililive/recorder run --bind "http://*:2356" --http-basic-user "用户名" --http-basic-pass "密码" /rec

从录播姬 2.6.3 开始也可以使用环境变量 BREC_HTTP_BASIC_USER 和 BREC_HTTP_BASIC_PASS 来设置用户名密码，不再需要覆盖掉镜像的默认命令。

docker run -d -v 宿主机路径:/rec -p 2356:2356 -e BREC_HTTP_BASIC_USER="用户名" -e BREC_HTTP_BASIC_PASS="密码" bililive/recorder

启用 HTTP 服务之后，默认在 /file 路径下会提供整个录播工作目录的内容。可以通过 --enable-file-browser false 来禁用。

docker run -d -v 宿主机路径:/rec -p 2356:2356 bililive/recorder run --bind "http://*:2356" --enable-file-browser false /rec

录播姬支持以 HTTPS 协议提供服务

# 注意 --bind 参数传入的协议是 https 而不是 http

# 本段示例省略了前面的 docker run 的命令部分，只保留了最终传递给录播姬命令行版的部分。
# 请自行把存放证书文件的目录映射到容器内。

# 使用录播姬自己生成的自签名证书
... run --bind "https://*:2356" "工作目录"

# 使用 pem 格式的证书，和 Nginx Caddy 等软件的证书格式一致
... run --bind "https://*:2356" --cert-pem-path "证书文件路径" --cert-key-path "私钥文件路径" "工作目录"
# 使用带密码的私钥
... run --bind "https://*:2356" --cert-pem-path "证书文件路径" --cert-key-path "私钥文件路径" --cert-password "私钥密码" "工作目录"

# 使用 pfx 格式的证书
... run --bind "https://*:2356" --cert-pfx-path "证书文件路径" "工作目录"
# 使用带密码的证书
... run --bind "https://*:2356" --cert-pfx-path "证书文件路径" --cert-password "私钥密码" "工作目录"

日志文件默认保存在 /app/logs，可以把这个目录也挂载出来。或者可以修改日志文件保存位置，请参考日志文件页面。

Docker Compose¶

推荐使用 Docker Compose 来运行录播姬。

docker-compose.yml 文件示例：

version: "3.8"
services:
  recorder:
    image: bililive/recorder:latest
    # 或者
    # image: ghcr.io/bililiverecorder/bililiverecorder:latest

    volumes:
      - type: bind
        source: # 在这里写宿主机保存录播的路径
        target: /rec

    ports:
      - "2356:2356"
      # 第一个 2356 是宿主机的端口，可以根据自己需求改动。
      # 第二个 2356 是容器内的端口，不要修改。

    # 如果需要设置用户名密码，可以在这里设置环境变量
    environment:
      - BREC_HTTP_BASIC_USER=用户名
      - BREC_HTTP_BASIC_PASS=密码

编辑好 docker-compose.yml 文件之后，使用下面的命令启动录播姬。

docker compose up -d

更新录播姬¶

更新录播姬只需要重新拉取镜像，删除旧版本的容器，再重新运行新的容器即可。

更新前请注意

更新前请注意检查录制出的视频文件是否映射到了宿主机上，是否能直接在宿主机上访问到。偶尔有人在创建容器的时候忘记映射目录，平常使用录播姬自带的文件浏览器访问文件，在更新录播姬时删除容器后录制的视频文件也一起删除了。
如果没有映射出来，在更新录播姬之前可以使用 docker cp 命令把容器里的文件复制出来，具体方法请参考 Docker 官方文档。

# 拉取最新版本的镜像
# 参考本页面上面的拉取镜像部分
docker pull bililive/recorder:latest

# 停止运行并删除
docker stop <旧容器ID>
docker rm <旧容器ID>

# 重新新建容器运行
# 参考本页面上面的运行录播姬部分
docker run -d -v 宿主机路径:/rec -p 2356:2356 bililive/recorder:latest

Docker Compose 的更新方法¶

# 拉取最新版本的镜像
docker compose pull
# 重新运行最新的容器
docker compose up -d