amtoaer/bili-sync

bili-sync Docker镜像文档

镜像概述和主要用途

bili-sync是一款专为NAS用户开发的B站收藏夹同步工具，旨在解决收藏夹视频失效问题。通过实时同步收藏夹内容并下载到NAS存储，结合生成媒体库所需的元数据文件（如nfo、poster），可方便导入EMBY等媒体库工具进行浏览管理。工具基于Python开发，支持定时任务、并发下载及多种本地内容更新操作，提供Docker打包以便快速部署。

核心功能和特性

• 凭证认证：支持B站用户凭证配置，实现收藏夹访问授权
• 视频选优下载：自动选择优质视频资源进行下载
• 并发下载：支持多任务并发下载，提升同步效率
• 后台运行：可作为daemon服务持续运行，定时触发同步任务
• 媒体库适配：生成nfo元数据和poster封面文件，支持EMBY等媒体库以单集形式导入
• 完整同步：支持收藏夹翻页，下载全部历史视频内容
• 智能检查：对接数据库记录下载状态，按需下载避免重复
• 多命令支持：提供单次同步、重新检查、元数据更新等多种操作命令
• Docker部署：提供Docker镜像，简化配置与运行流程

工作截图

!https://raw.githubusercontent.com/amtoaer/bili-sync/main/asset/run.png

!https://raw.githubusercontent.com/amtoaer/bili-sync/main/asset/emby.png

配置文件说明

配置文件路径

程序默认配置文件路径：${程序路径}/config/config.json
数据库文件路径：${程序路径}/data/data.db

首次运行时，若配置文件不存在将自动创建并写入初始配置。配置文件内容为空时程序会校验报错并终止，需编辑配置后重新运行。

配置项说明

配置文件前五项为B站用户凭证，获取方法参考https://nemo2011.github.io/bilibili-api/#/get-credential%E3%80%82%E5%AE%8C%E6%95%B4%E9%85%8D%E7%BD%AE%E7%BB%93%E6%9E%84%E5%A6%82%E4%B8%8B%EF%BC%9A

python
@dataclass
class SubtitleConfig(DataClassJsonMixin):
    font_name: str = "微软雅黑，黑体"  # 字体名称
    font_size: float = 40  # 字号大小
    alpha: float = 0.8  # 透明度
    fly_time: float = 5  # 滚动弹幕持续时间（秒）
    static_time: float = 10  # 静态弹幕持续时间（秒）

class Config(DataClassJsonMixin):
    sessdata: str = ""  # B站用户凭证
    bili_jct: str = ""  # B站用户凭证
    buvid3: str = ""  # B站用户凭证
    dedeuserid: str = ""  # B站用户凭证
    ac_time_value: str = ""  # B站用户凭证
    interval: int = 20  # 定时任务执行间隔（分钟）
    path_mapper: dict[int, str] = field(default_factory=dict)  # 收藏夹ID与存储目录的映射关系
    subtitle: SubtitleConfig = field(default_factory=SubtitleConfig)  # 字幕相关配置

Docker部署示例

Docker Compose配置

yaml
services:
  bili-sync:
    image: amtoaer/bili-sync:latest
    user: 1000:1000  # 指定运行用户权限，推荐填写（默认root）
    tty: true  # 终端彩色日志支持（日志乱码时可移除）
    volumes:
      - /path/to/local/videos:/Videos/Bilibilis/  # 视频存储目录映射
      - /path/to/local/config:/app/config/  # 配置文件目录映射
      - /path/to/local/data:/app/data/  # 数据库文件目录映射
      # 如需EMBY显示UP主头像，挂载EMBY的metadata/people目录
      - /path/to/emby/metadata/people:/app/thumb/
    environment:
      - TZ=Asia/Shanghai  # 设置时区
    restart: always
    network_mode: bridge
    hostname: bili-sync
    container_name: bili-sync
    logging:
      driver: "local"

配置文件示例

json
{
    "sessdata": "你的sessdata值",
    "bili_jct": "你的bili_jct值",
    "buvid3": "你的buvid3值",
    "dedeuserid": "你的dedeuserid值",
    "ac_time_value": "你的ac_time_value值",
    "interval": 20,
    "path_mapper": {
        "711322958": "/Videos/Bilibilis/Bilibili-711322958/"  # 收藏夹ID与存储路径映射
    },
    "subtitle": {
        "font_name": "微软雅黑，黑体",
        "font_size": 40.0,
        "alpha": 0.8,
        "fly_time": 5.0,
        "static_time": 10.0
    }
}

支持的额外命令

在容器内或程序目录下，可通过python entry.py ${command name}执行以下命令：

1. once
   执行单次收藏夹同步，与定时任务触发的操作完全一致，仅运行一次。

2. recheck
   将本地不存在的视频标记为未下载，下次定时任务触发时重新下载。

3. refresh_poster
   更新本地视频的封面文件。

4. refresh_upper
   更新本地UP主的头像和元数据信息。

5. refresh_nfo
   更新本地视频的元数据（如标题、标签等信息）。

6. refresh_video
   更新本地视频源文件。

7. refresh_subtitle
   更新本地弹幕文件。

注意：所有以refresh开头的命令均支持--force参数，添加该参数将全量覆盖对应内容，默认仅更新缺失部分。

已实现功能

• B站用户凭证认证
• 视频质量自动选择
• 视频下载与本地存储
• 多任务并发下载
• 后台服务模式运行
• 生成EMBY兼容的nfo和poster文件
• 收藏夹翻页支持，下载全部历史视频
• 数据库记录下载状态，按需下载
• Docker容器化打包，简化部署