WebUI 使用指南
本指南讲解 WebUI 各功能模块,帮助你充分利用 biliup 的管理能力。
文档与界面版本说明
本文档基于 biliup v1.2.6 对界面路由与功能进行走查。WebUI 界面会随版本变化,下列路由名称以当前源码为准;逐页面截图与最终复核建议由前端维护者补充。如果你的界面与本指南不符,请以实际界面为准,并到 GitHub 反馈。
访问 WebUI
启动 biliup 后,根据部署方式访问对应地址:
| 部署方式 | 默认访问地址 |
|---|---|
| 本地直接运行 | http://localhost:19159 |
| Docker | http://<服务器IP>:19159 |
| 自定义端口 | http://<地址>:<端口> |
⚠️ 未设置
--auth时,WebUI 与 API 均无认证保护。请勿在生产 / 公网环境中不设认证直接暴露端口。
启动时使用 --auth 参数开启 WebUI 认证:
biliup server --auth关于 WebUI 管理员账号(统一说明)
--auth 是布尔开关,不接收 user:pass 参数。开启后首次访问 WebUI 会进入登录页:用户名固定为 biliup(不可修改),由你设置管理员密码;之后使用同一用户名与密码登录。
请勿把「WebUI 管理员账号(biliup)」与「B站投稿账号(通过扫码 / Cookie 添加)」混为一谈——前者只用于登录管理界面,后者用于上传与投稿。
页面总览
登录后左侧导航栏包含以下主要模块(路由以 v1.2.6 为准):
| 导航项 | 路由 | 作用 |
|---|---|---|
| 📡 录播管理 | /streamers | 管理需要录制的直播间,添加 / 编辑 / 删除主播 |
| 📤 投稿管理 | /upload-manager | 管理 B站账号与投稿模板 |
| 📊 任务平台 | /status | 查看录制 / 上传 / 后处理等任务的数据 |
| 📜 直播历史 | /job | 查看已完成的录制与上传历史记录 |
| 📝 日志查看 | /logviewer | 在浏览器中查看运行日志 |
| ⚙️ 空间配置 | /dashboard | 全局设置、各平台设置、开发者选项 |
旧文档把
/dashboard写成 KPI 仪表盘、把/status写成资源监控与启停页、把/job写成可取消 / 重试的任务队列——这些描述已与当前界面不符,以下各节按真实路由说明。
录播管理 (Streamers)
路径: /streamers
核心功能模块,管理所有需要录制的直播间。
添加直播源
点击「新增」按钮,支持以下方式的直播源添加:
方式一:直接粘贴房间链接(推荐)
支持各平台的完整 URL,biliup 会自动识别平台:
# B站
https://live.bilibili.com/123456
# 斗鱼
https://www.douyu.com/123456
# 虎牙
https://www.huya.com/123456
# Twitch
https://www.twitch.tv/username
# YouTube
https://www.youtube.com/watch?v=xxxxx
https://youtu.be/xxxxx方式二:手动选择平台 + 填写房间号
适用于链接识别异常的情况。
主播卡片说明
每个已添加的主播以卡片形式展示,包含直播状态、房间标题、开播时间、录制状态与文件大小,以及「编辑 / 删除 / 日志」等操作。
单个主播配置项
点击主播卡片的「编辑」按钮,可配置该主播的独立参数(优先级高于全局配置):
| 配置项 | 说明 |
|---|---|
| 录制开关 | 临时禁用/启用该主播的录制 |
| 上传插件 | 覆盖全局设置,单独指定上传方式(Noop = 不自动上传 / biliup-rs = 自动上传) |
| 投稿模板 | 指定使用的投稿配置模板 |
| 文件名模板 | 覆盖全局的 filename_prefix |
| 分段大小/时长 | 覆盖全局的视频分段规则 |
| 弹幕录制 | 是否录制该主播的弹幕(部分平台需安装 ffmpeg) |
| Cookie/Token | 部分平台需要单独设置认证信息 |
默认行为风险(务必先读)
默认上传器是 Noop(只录制、不上传),且新建主播默认带 rm 后处理:即使没有配置上传、或使用了 Noop,下播后本地录像也可能被删除。要让录完自动投稿并保留本地文件,请:① 创建投稿模板并选择 biliup-rs 等非 Noop 上传器;② 将模板绑定到主播;③ 在确认要保留本地文件前,先移除默认 rm 或改用安全的保留策略。
批量操作
- 全选 — 批量启用/禁用录制
- 批量应用模板 — 为多个主播统一指定投稿模板
- 批量删除 — 移除多个主播(不会删除已录制的文件)
投稿管理 (Upload Manager)
路径: /upload-manager
管理 B站账号和投稿模板,是自动上传和投稿的配置中心。
账号管理
添加 B站账号
- 进入「投稿管理」→ 点击左上角「新增」
- 选择「扫码登录」
- 使用哔哩哔哩 APP 扫描屏幕上显示的二维码
- 手机确认登录后,页面自动刷新,显示账号信息
✅ 登录成功后,Cookie 会自动保存,无需重复登录。Cookie 有效期通常为 1-3 个月,过期后请在页面点击「刷新登录」重新扫码。
多账号管理
biliup 支持添加多个 B站账号:
- 不同主播可以指定不同的投稿账号
- 账号列表中显示每个账号的 UID、昵称、Cookie 有效期
- 点击「刷新登录」可重新扫码续期
投稿模板
投稿模板是 biliup 的核心概念:将投稿参数打包成一个可复用的配置。
创建模板
点击「模板管理」→「新建模板」,填写以下参数:
基础信息:
| 参数 | 说明 | 示例 |
|---|---|---|
| 模板名称 | 模板的标识符,便于区分 | 默认投稿、游戏区投稿 |
| 投稿账号 | 使用哪个 B站账号投稿 | (选择已登录的账号) |
| 上传器 | 选择实际上传方式(如 biliup-rs) | 选 Noop 则只录制不上传 |
| 分区 | 视频投稿的分区 | 游戏 → 电子竞技 |
| 标题格式 | 支持变量替换 | {title} - {date} |
| 简介 | 视频简介,支持变量 | 录制自 {streamer} 的直播间 |
| 标签 | 视频标签 | 直播录制, {streamer} |
| 封面 | 封面获取方式 | 自动使用直播封面 / 手动指定 |
高级参数:
| 参数 | 说明 |
|---|---|
| 动态 | 投稿时同步发布的动态内容 |
| 延迟发布 | 设定投稿后多久才公开(小时) |
| 合集 (Season) | 将视频加入指定合集 |
| 互动视频 | 启用互动视频功能 |
| 杜比音效 | 开启杜比音效(需 biliup-rs 上传插件) |
| 充电专属 | 设为充电专属视频 |
支持的变量:
| 变量 | 替换为 |
|---|---|
{streamer} | 主播名 |
{title} | 直播标题 |
{date} | 录制日期 YYYY-MM-DD |
{time} | 录制时间 HH:MM:SS |
{url} | 直播间链接 |
模板与主播的绑定
在「录播管理」中编辑主播 → 选择「投稿模板」→ 指定该主播使用的模板。
绑定后,该主播录制完成并启用自动上传时,会使用对应模板的参数进行投稿。
任务平台 (Status)
路径: /status
查看 biliup 后台任务平台的数据,包括录制、上传、后处理等任务的运行状态与数据。
⚠️ 旧文档称此页展示 CPU / 内存 / 磁盘监控并提供「重启 / 停止服务」按钮——当前版本并非如此。本页是任务数据的查看界面,不包含系统资源监控,也不提供服务的启停控制。服务的重启 / 停止请在命令行或系统服务管理器中操作。
典型可查看内容(以当前界面为准):
- 正在进行的录制 / 上传 / 后处理任务及其进度数据
- 任务的状态、来源主播与关联文件等信息
直播历史 (Job)
路径: /job
查看已完成的直播录制与上传历史记录(旧文档称其为「任务管理」并提供取消 / 重试,当前版本本页为历史查看,不提供任务取消 / 重试操作)。
记录列表字段
| 字段 | 说明 |
|---|---|
| 主播名 | 来源主播 |
| 标题 | 录制时获取的直播标题 |
| 文件大小 | 录制文件的尺寸 |
| 录制时间 | 开播 → 下播的时间范围 |
| 上传状态 | 未上传 / 上传中 / 已上传 / 投稿完成 |
| 操作 | 查看详情 / 手动触发上传 / 删除记录 |
过滤与搜索
- 按主播过滤 — 只看某个主播的历史记录
- 按状态过滤 — 只看未上传 / 已上传的记录
- 按时间范围过滤 — 查看指定日期范围内的记录
- 关键词搜索 — 按标题关键词搜索
手动触发上传
对于未启用自动上传、或自动上传失败的主播,可以在历史记录中:
- 找到对应的记录
- 点击「上传」按钮
- 选择投稿模板
- 确认后开始上传
日志查看 (Log Viewer)
路径: /logviewer
在浏览器中直接查看 biliup 的运行日志,无需 SSH 到服务器。
日志级别
| 级别 | 说明 |
|---|---|
| ERROR | 错误,需要关注 |
| WARN | 警告,可能影响功能但不致命 |
| INFO | 一般信息,记录正常操作流程 |
| DEBUG | 调试信息,排查问题时开启 |
使用技巧
- 级别过滤 — 选择只显示某一级别及以上的日志
- 关键词搜索 — 在日志中搜索特定关键词(如房间号、错误码)
- 自动滚动 — 开启后新日志会自动滚动到可见区域
- 下载日志 — 将当前日志下载到本地,用于反馈问题
💡 提交 GitHub Issue 前,请先删除日志中的 Cookie、Token、直播地址与个人路径等敏感信息。
日志 WebSocket 的认证边界(ACC-14)
实时日志通过 /v1/ws/logs 推送,可订阅的频道为 ds_update.log、download.log、upload.log(旧文档写的 postprocessor 频道已不存在)。在开启 --auth 后,/v1/ws/logs 是否受同一登录守卫保护取决于具体版本实现,日志可能包含文件名、路径等敏感信息。 建议在公网暴露前确认该端点的认证行为,并以反向代理层做额外的访问控制。
空间配置 (Dashboard)
路径: /dashboard
配置中心,包含三个子页面:
全局设置
影响所有主播的默认行为,详见全局设置文档。
关键参数速查(默认值以当前版本为准):
| 参数 | 默认值 | 说明 |
|---|---|---|
| 下载器 | stream-gears | 可选 streamlink / ffmpeg / sync-downloader |
| 分段大小 | - | 按文件大小分段(Byte) |
| 分段时长 | - | 按录制时长分段(HH:MM:SS) |
| 文件名模板 | {streamer}%Y-%m-%dT%H_%M_%S | 录制文件命名格式 |
| 下载线程池大小 | 5 | 同时录制的最大直播间数 |
| 下播延迟检测 | 300 | 延迟 N 秒再次确认下播(旧文档误写为 0) |
| 直播事件检测间隔 | - | 单个主播的检测间隔(秒) |
各平台设置
针对特定平台的配置,详见各平台设置文档。
常见需要单独配置的平台:
- 哔哩哔哩 — 直播流协议(flv / hls_fmp4)、Cookie 文件、API 反代地址
- 斗鱼 — CDN 优选
- 虎牙 — CDN 优选
- YouTube — cookies 文件(用于访问受限内容)
开发者选项
面向进阶用户,详见开发者选项文档。
主要功能:
- 钩子系统 (Hooks) — 在录制前 / 分段后 / 下载完成 / 上传后执行自定义脚本
- Webhook — 上传完成后向指定 URL 发送 POST 通知
- 分段处理器 — 配置
remux:mp4或自定义 Python 脚本 - 日志级别 — 通过全局配置调整日志详细程度
常见问题
无法访问 WebUI
- 确认 biliup 已正常启动(查看终端输出)
- 确认访问的端口正确(默认 19159,可通过
--port修改) - 如部署在远程服务器,确认防火墙已放行对应端口
- 如在 Docker 中运行,确认已正确映射端口(
-p 19159:19159)
修改配置后不生效
全局配置和平台配置的修改必须重启 biliup 才能生效。请在命令行重启进程,或通过系统服务管理器(如 systemd、Docker restart)重启。
忘记 WebUI 密码
如果忘记了 WebUI 管理员(biliup)密码,需要操作数据库来重置:
- 停止 biliup 服务
- 重置管理员密码目前需要修改 / 重建用户数据(操作
data/data.sqlite3) - 重新使用
biliup server --auth启动,首次访问时重新设置密码
DANGER
直接删除 data/data.sqlite3 会丢失全部配置、账号、主播与历史记录。操作前请务必先备份该文件;理想情况下未来版本应提供「仅重置管理员密码」的方式,而非删除整个数据库。
WebUI 响应缓慢
- 检查服务器资源(CPU / 内存 / 磁盘)是否充足
- 降低日志级别(DEBUG 级别会产生大量日志影响性能)
- 减少同时录制的直播间数量