# Bilibili Live Streaming Recorder (blrec)
这是一个前后端分离的 B 站直播录制工具。前端使用了响应式设计，可适应不同的屏幕尺寸；后端是用 Python 写的，可以跨平台运行。
这个工具是自动化的，会自动完成直播的录制, 在出现未处理异常时会发送通知，空间不足能够自动回收空间，还有详细日志记录，因此可以长期无人值守运行在服务器上。
## 屏幕截图
## 功能
- 自动完成直播录制
- 同步保存弹幕
- 自动修复时间戳问题：跳变、反跳等。
- 直播流参数改变自动分割文件，避免出现花屏等问题。
- 流中断自动拼接且支持 **无缝** 拼接，不会因网络中断而使录播文件片段化。
- `flv` 文件添加关键帧等元数据，使定位播放和拖进度条不会卡顿。
- 可选录制的画质
- 可自定义文件保存路径和文件名
- 支持按文件大小或时长分割文件
- 支持转换 `flv` 为 `mp4` 格式（需要安装 `ffmpeg`）
- 硬盘空间检测并支持空间不足自动删除旧录播文件。
- 事件通知（支持邮箱、`ServerChan`、`PushDeer`、`pushplus`、`Telegram`、`Bark` ）
- `Webhook`（可配合 `REST API` 实现录制控制，录制完成后压制、上传等自定义需求）
## 前提条件
Python 3.8+
ffmpeg、 ffprobe
## 安装
- 通过 pip 或者 pipx 安装
`pip install blrec` 或者 `pipx install blrec`
使用的一些库需要自己编译，Windows 没安装 C / C++ 编译器会安装出错，
参考 [Python Can't install packages](https://stackoverflow.com/questions/64261546/python-cant-install-packages) 先安装好 [Microsoft C++ Build Tools](https://visualstudio.microsoft.com/visual-cpp-build-tools/)。
- 免安装绿色版
支持 Windows 10+ 或 Windows Server 2016+，下载后解压运行 `run.bat` 或 `run.ps1` 。
不是官方或最新系统可能需要安装系统更新或缺少的 `C` 或 `C++` 运行时库
下载
- Releases: https://github.com/acgnhiki/blrec/releases
- 网盘: https://gooyie.lanzoui.com/b01om2zte 密码: 2233
## 更新
- 通过 pip 或者 pipx 安装的用以下方式更新
`pip install blrec --upgrade` 或者 `pipx upgrade blrec`
- 免安装绿色版
- 下载并解压新版本
- 确保旧版本已经关闭退出以避免之后出现端口冲突
- 把旧版本的设置文件 `settings.toml` 复制并覆盖新版本的设置文件
- 运行新版本的 `run.bat`
## 卸载
- 通过 pip 或者 pipx 安装的用以下方式卸载
`pip uninstall blrec` 或者 `pipx uninstall blrec`
- 免安装绿色版
删除解压后的文件夹
## Docker
### 环境变量
- 默认设置文件位置: `ENV BLREC_DEFAULT_SETTINGS_FILE=/cfg/settings.toml`
- 默认日志存放目录: `ENV BLREC_DEFAULT_LOG_DIR=/log`
- 默认录播存放目录: `ENV BLREC_DEFAULT_OUT_DIR=/rec`
- 默认时区: `ENV TZ="Asia/Shanghai"`
### 默认参数运行
`sudo docker run -v /etc/blrec:/cfg -v /var/log/blrec:/log -v ~/blrec:/rec -dp 2233:2233 acgnhiki/blrec`
### 命令行参数用法
```bash
sudo docker run \
-v /etc/blrec:/cfg -v /var/log/blrec:/log -v ~/blrec:/rec \
-dp 2233:2233 acgnhiki/blrec \
-c /cfg/another_settings.toml \
--key-file path/to/key-file \
--cert-file path/to/cert-file \
--api-key bili2233
```
## 使用方法
### 命令行参数用法
`blrec --help`
### 默认参数运行
在命令行终端里执行 `blrec` ，然后浏览器访问 `http://localhost:2233`。
默认设置文件位置：`~/.blrec/settings.toml`
默认日志文件目录： `~/.blrec/logs`
默认录播文件目录: `.`
### 指定设置文件和录播与日志保存位置
`blrec -c path/to/settings.toml -o path/to/records --log-dir path/to/logs`
如果指定的设置文件不存在会自动创建
**命令行参数会覆盖掉设置文件的对应的设置**
### 绑定主机和端口
默认为本地运行，主机和端口绑定为： `localhost:2233`
需要外网访问，把主机绑定到 `0.0.0.0`，端口绑定则按照自己的情况修改。
例如：`blrec --host 0.0.0.0 --port 8000`
### 网络安全
指定 `SSL` 证书使用 **https** 协议并指定 `api key` 可防止被恶意访问和泄漏设置里的敏感信息
例如：`blrec --key-file path/to/key-file --cert-file path/to/cert-file --api-key bili2233`
如果指定了 api key，浏览器第一次访问会弹对话框要求输入 api key。
输入的 api key 会被保存在浏览器的 `local storage` 以避免每次都得输入
如果在不信任的环境下，请使用浏览器的隐式模式访问。
### 关于 api-key
api key 可以使用数字和字母，长度限制为最短 8 最长 80。
3 次尝试内 api key 正确客户端 ip 会自动加入白名单，3 次错误后则 ip 会被加入黑名单，黑名单后请求会被拒绝 (403)。
黑名单和白名单数以及同时尝试连接的 ip 数量限制各为 100，黑名单或白名单到达限制后不再接受除了白名单内的其它 ip 。
只有重启才会清空黑名单和白名单。
## 作为 ASGI 应用运行
uvicorn blrec.web:app
或者
hypercorn blrec.web:app
作为 ASGI 应用运行，参数通过环境变量指定。
- `BLREC_CONFIG` 指定设置文件
- `BLREC_OUT_DIR` 指定录播存放位置
- `BLREC_LOG_DIR` 指定日志存放位置
- `BLREC_API_KEY` 指定 `api key`
### bash
BLREC_CONFIG=path/to/settings.toml BLREC_OUT_DIR=path/to/dir BLREC_API_KEY=******** uvicorn blrec.web:app --host 0.0.0.0 --port 8000
### cmd
set BLREC_CONFIG=D:\\path\\to\\config.toml & set BLREC_OUT_DIR=D:\\path\\to\\dir & set BLREC_API_KEY=******** uvicorn blrec.web:app --host 0.0.0.0 --port 8000
## Webhook
程序在运行过程中会触发一些事件，如果是支持 `webhook` 的事件，就会给所设置的 `webhook` 网络地址发送 POST 请求。
关于支持的事件和 `POST` 请求所发送的数据，详见 wiki。
## REST API
后端 `web` 框架用的是 `FastApi` , 要查看自动生成的交互式 `API` 文档，访问 `http://localhost:2233/docs` （默认主机和端口绑定）。
## Progressive Web App（PWA）
前端其实是一个渐进式网络应用，可以通过地址栏右侧的图标安装，然后像原生应用一样从桌面启动运行。
**注意：PWA 要在本地访问或者在 `https` 下才支持。**
---
## 开发
1. 克隆代码
`git clone https://github.com/acgnhiki/blrec.git`
2. 进入项目目录
`cd blrec`
3. 创建虚拟环境
`python3 -m venv .venv`
4. 激活虚拟环境
`source .venv/bin/activate`
5. 以可编辑方式安装
`pip install -e .[dev]`
6. 修改代码
……
7. 运行 blrec
`blrec`
8. 退出虚拟环境
`deactivate`
---
## 常见问题
[FAQ](FAQ.md)
## 更新日志
[CHANGELOG](CHANGELOG.md)
---
## 其它相关工具或项目
| 名称 | 链接 | 简介 |
| --- | --- | --- |
| 录播姬 | [官网](https://rec.danmuji.org/) | 简单易用成熟稳定的 B 站直播录制工具 |
| rclone | [官网](https://rclone.org/) | 可以挂载网盘用于存放录播文件 |
| alist | [官网](https://alist-doc.nn.ci/) | 网盘文件浏览、播放 |
| filebrowser | [官网](https://filebrowser.org/) | 服务器文件管理 |
Raw data
{
"_id": null,
"home_page": "https://github.com/acgnhiki/blrec",
"name": "blrec",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "bilibili,live,danmaku,recorder",
"author": "acgnhiki",
"author_email": "acgnhiki@outlook.com",
"download_url": "https://files.pythonhosted.org/packages/af/e1/d491fae255acfe97312b267bd7fe909f8d5502ab7c59b105d0f1c475daa2/blrec-1.15.0.tar.gz",
"platform": null,
"description": "# Bilibili Live Streaming Recorder (blrec)\n\n\u8fd9\u662f\u4e00\u4e2a\u524d\u540e\u7aef\u5206\u79bb\u7684 B \u7ad9\u76f4\u64ad\u5f55\u5236\u5de5\u5177\u3002\u524d\u7aef\u4f7f\u7528\u4e86\u54cd\u5e94\u5f0f\u8bbe\u8ba1\uff0c\u53ef\u9002\u5e94\u4e0d\u540c\u7684\u5c4f\u5e55\u5c3a\u5bf8\uff1b\u540e\u7aef\u662f\u7528 Python \u5199\u7684\uff0c\u53ef\u4ee5\u8de8\u5e73\u53f0\u8fd0\u884c\u3002\n\n\u8fd9\u4e2a\u5de5\u5177\u662f\u81ea\u52a8\u5316\u7684\uff0c\u4f1a\u81ea\u52a8\u5b8c\u6210\u76f4\u64ad\u7684\u5f55\u5236, \u5728\u51fa\u73b0\u672a\u5904\u7406\u5f02\u5e38\u65f6\u4f1a\u53d1\u9001\u901a\u77e5\uff0c\u7a7a\u95f4\u4e0d\u8db3\u80fd\u591f\u81ea\u52a8\u56de\u6536\u7a7a\u95f4\uff0c\u8fd8\u6709\u8be6\u7ec6\u65e5\u5fd7\u8bb0\u5f55\uff0c\u56e0\u6b64\u53ef\u4ee5\u957f\u671f\u65e0\u4eba\u503c\u5b88\u8fd0\u884c\u5728\u670d\u52a1\u5668\u4e0a\u3002\n\n## \u5c4f\u5e55\u622a\u56fe\n\n\n\n\n\n## \u529f\u80fd\n\n- \u81ea\u52a8\u5b8c\u6210\u76f4\u64ad\u5f55\u5236\n- \u540c\u6b65\u4fdd\u5b58\u5f39\u5e55\n- \u81ea\u52a8\u4fee\u590d\u65f6\u95f4\u6233\u95ee\u9898\uff1a\u8df3\u53d8\u3001\u53cd\u8df3\u7b49\u3002\n- \u76f4\u64ad\u6d41\u53c2\u6570\u6539\u53d8\u81ea\u52a8\u5206\u5272\u6587\u4ef6\uff0c\u907f\u514d\u51fa\u73b0\u82b1\u5c4f\u7b49\u95ee\u9898\u3002\n- \u6d41\u4e2d\u65ad\u81ea\u52a8\u62fc\u63a5\u4e14\u652f\u6301 **\u65e0\u7f1d** \u62fc\u63a5\uff0c\u4e0d\u4f1a\u56e0\u7f51\u7edc\u4e2d\u65ad\u800c\u4f7f\u5f55\u64ad\u6587\u4ef6\u7247\u6bb5\u5316\u3002\n- `flv` \u6587\u4ef6\u6dfb\u52a0\u5173\u952e\u5e27\u7b49\u5143\u6570\u636e\uff0c\u4f7f\u5b9a\u4f4d\u64ad\u653e\u548c\u62d6\u8fdb\u5ea6\u6761\u4e0d\u4f1a\u5361\u987f\u3002\n- \u53ef\u9009\u5f55\u5236\u7684\u753b\u8d28\n- \u53ef\u81ea\u5b9a\u4e49\u6587\u4ef6\u4fdd\u5b58\u8def\u5f84\u548c\u6587\u4ef6\u540d\n- \u652f\u6301\u6309\u6587\u4ef6\u5927\u5c0f\u6216\u65f6\u957f\u5206\u5272\u6587\u4ef6\n- \u652f\u6301\u8f6c\u6362 `flv` \u4e3a `mp4` \u683c\u5f0f\uff08\u9700\u8981\u5b89\u88c5 `ffmpeg`\uff09\n- \u786c\u76d8\u7a7a\u95f4\u68c0\u6d4b\u5e76\u652f\u6301\u7a7a\u95f4\u4e0d\u8db3\u81ea\u52a8\u5220\u9664\u65e7\u5f55\u64ad\u6587\u4ef6\u3002\n- \u4e8b\u4ef6\u901a\u77e5\uff08\u652f\u6301\u90ae\u7bb1\u3001`ServerChan`\u3001`PushDeer`\u3001`pushplus`\u3001`Telegram`\u3001`Bark` \uff09\n- `Webhook`\uff08\u53ef\u914d\u5408 `REST API` \u5b9e\u73b0\u5f55\u5236\u63a7\u5236\uff0c\u5f55\u5236\u5b8c\u6210\u540e\u538b\u5236\u3001\u4e0a\u4f20\u7b49\u81ea\u5b9a\u4e49\u9700\u6c42\uff09\n\n## \u524d\u63d0\u6761\u4ef6\n\n Python 3.8+\n ffmpeg\u3001 ffprobe\n\n## \u5b89\u88c5\n\n- \u901a\u8fc7 pip \u6216\u8005 pipx \u5b89\u88c5\n\n `pip install blrec` \u6216\u8005 `pipx install blrec`\n\n \u4f7f\u7528\u7684\u4e00\u4e9b\u5e93\u9700\u8981\u81ea\u5df1\u7f16\u8bd1\uff0cWindows \u6ca1\u5b89\u88c5 C / C++ \u7f16\u8bd1\u5668\u4f1a\u5b89\u88c5\u51fa\u9519\uff0c\n \u53c2\u8003 [Python Can't install packages](https://stackoverflow.com/questions/64261546/python-cant-install-packages) \u5148\u5b89\u88c5\u597d [Microsoft C++ Build Tools](https://visualstudio.microsoft.com/visual-cpp-build-tools/)\u3002\n\n- \u514d\u5b89\u88c5\u7eff\u8272\u7248\n\n \u652f\u6301 Windows 10+ \u6216 Windows Server 2016+\uff0c\u4e0b\u8f7d\u540e\u89e3\u538b\u8fd0\u884c `run.bat` \u6216 `run.ps1` \u3002\n\n \u4e0d\u662f\u5b98\u65b9\u6216\u6700\u65b0\u7cfb\u7edf\u53ef\u80fd\u9700\u8981\u5b89\u88c5\u7cfb\u7edf\u66f4\u65b0\u6216\u7f3a\u5c11\u7684 `C` \u6216 `C++` \u8fd0\u884c\u65f6\u5e93\n\n \u4e0b\u8f7d\n\n - Releases: https://github.com/acgnhiki/blrec/releases\n - \u7f51\u76d8: https://gooyie.lanzoui.com/b01om2zte \u5bc6\u7801: 2233\n\n## \u66f4\u65b0\n\n- \u901a\u8fc7 pip \u6216\u8005 pipx \u5b89\u88c5\u7684\u7528\u4ee5\u4e0b\u65b9\u5f0f\u66f4\u65b0\n\n `pip install blrec --upgrade` \u6216\u8005 `pipx upgrade blrec`\n\n- \u514d\u5b89\u88c5\u7eff\u8272\u7248\n\n - \u4e0b\u8f7d\u5e76\u89e3\u538b\u65b0\u7248\u672c\n - \u786e\u4fdd\u65e7\u7248\u672c\u5df2\u7ecf\u5173\u95ed\u9000\u51fa\u4ee5\u907f\u514d\u4e4b\u540e\u51fa\u73b0\u7aef\u53e3\u51b2\u7a81\n - \u628a\u65e7\u7248\u672c\u7684\u8bbe\u7f6e\u6587\u4ef6 `settings.toml` \u590d\u5236\u5e76\u8986\u76d6\u65b0\u7248\u672c\u7684\u8bbe\u7f6e\u6587\u4ef6\n - \u8fd0\u884c\u65b0\u7248\u672c\u7684 `run.bat`\n\n## \u5378\u8f7d\n\n- \u901a\u8fc7 pip \u6216\u8005 pipx \u5b89\u88c5\u7684\u7528\u4ee5\u4e0b\u65b9\u5f0f\u5378\u8f7d\n\n `pip uninstall blrec` \u6216\u8005 `pipx uninstall blrec`\n\n- \u514d\u5b89\u88c5\u7eff\u8272\u7248\n\n \u5220\u9664\u89e3\u538b\u540e\u7684\u6587\u4ef6\u5939\n\n\n## Docker\n\n### \u73af\u5883\u53d8\u91cf\n\n- \u9ed8\u8ba4\u8bbe\u7f6e\u6587\u4ef6\u4f4d\u7f6e: `ENV BLREC_DEFAULT_SETTINGS_FILE=/cfg/settings.toml`\n- \u9ed8\u8ba4\u65e5\u5fd7\u5b58\u653e\u76ee\u5f55: `ENV BLREC_DEFAULT_LOG_DIR=/log`\n- \u9ed8\u8ba4\u5f55\u64ad\u5b58\u653e\u76ee\u5f55: `ENV BLREC_DEFAULT_OUT_DIR=/rec`\n- \u9ed8\u8ba4\u65f6\u533a: `ENV TZ=\"Asia/Shanghai\"`\n\n### \u9ed8\u8ba4\u53c2\u6570\u8fd0\u884c\n\n`sudo docker run -v /etc/blrec:/cfg -v /var/log/blrec:/log -v ~/blrec:/rec -dp 2233:2233 acgnhiki/blrec`\n\n### \u547d\u4ee4\u884c\u53c2\u6570\u7528\u6cd5\n\n```bash\nsudo docker run \\\n -v /etc/blrec:/cfg -v /var/log/blrec:/log -v ~/blrec:/rec \\\n -dp 2233:2233 acgnhiki/blrec \\\n -c /cfg/another_settings.toml \\\n --key-file path/to/key-file \\\n --cert-file path/to/cert-file \\\n --api-key bili2233\n```\n\n## \u4f7f\u7528\u65b9\u6cd5\n\n### \u547d\u4ee4\u884c\u53c2\u6570\u7528\u6cd5\n\n`blrec --help`\n\n### \u9ed8\u8ba4\u53c2\u6570\u8fd0\u884c\n\n\u5728\u547d\u4ee4\u884c\u7ec8\u7aef\u91cc\u6267\u884c `blrec` \uff0c\u7136\u540e\u6d4f\u89c8\u5668\u8bbf\u95ee `http://localhost:2233`\u3002\n\n\u9ed8\u8ba4\u8bbe\u7f6e\u6587\u4ef6\u4f4d\u7f6e\uff1a`~/.blrec/settings.toml`\n\n\u9ed8\u8ba4\u65e5\u5fd7\u6587\u4ef6\u76ee\u5f55\uff1a `~/.blrec/logs`\n\n\u9ed8\u8ba4\u5f55\u64ad\u6587\u4ef6\u76ee\u5f55: `.`\n\n### \u6307\u5b9a\u8bbe\u7f6e\u6587\u4ef6\u548c\u5f55\u64ad\u4e0e\u65e5\u5fd7\u4fdd\u5b58\u4f4d\u7f6e\n\n`blrec -c path/to/settings.toml -o path/to/records --log-dir path/to/logs`\n\n\u5982\u679c\u6307\u5b9a\u7684\u8bbe\u7f6e\u6587\u4ef6\u4e0d\u5b58\u5728\u4f1a\u81ea\u52a8\u521b\u5efa\n\n**\u547d\u4ee4\u884c\u53c2\u6570\u4f1a\u8986\u76d6\u6389\u8bbe\u7f6e\u6587\u4ef6\u7684\u5bf9\u5e94\u7684\u8bbe\u7f6e**\n\n### \u7ed1\u5b9a\u4e3b\u673a\u548c\u7aef\u53e3\n\n\u9ed8\u8ba4\u4e3a\u672c\u5730\u8fd0\u884c\uff0c\u4e3b\u673a\u548c\u7aef\u53e3\u7ed1\u5b9a\u4e3a\uff1a `localhost:2233`\n\n\u9700\u8981\u5916\u7f51\u8bbf\u95ee\uff0c\u628a\u4e3b\u673a\u7ed1\u5b9a\u5230 `0.0.0.0`\uff0c\u7aef\u53e3\u7ed1\u5b9a\u5219\u6309\u7167\u81ea\u5df1\u7684\u60c5\u51b5\u4fee\u6539\u3002\n\n\u4f8b\u5982\uff1a`blrec --host 0.0.0.0 --port 8000`\n\n### \u7f51\u7edc\u5b89\u5168\n\n\u6307\u5b9a `SSL` \u8bc1\u4e66\u4f7f\u7528 **https** \u534f\u8bae\u5e76\u6307\u5b9a `api key` \u53ef\u9632\u6b62\u88ab\u6076\u610f\u8bbf\u95ee\u548c\u6cc4\u6f0f\u8bbe\u7f6e\u91cc\u7684\u654f\u611f\u4fe1\u606f\n\n\u4f8b\u5982\uff1a`blrec --key-file path/to/key-file --cert-file path/to/cert-file --api-key bili2233`\n\n\u5982\u679c\u6307\u5b9a\u4e86 api key\uff0c\u6d4f\u89c8\u5668\u7b2c\u4e00\u6b21\u8bbf\u95ee\u4f1a\u5f39\u5bf9\u8bdd\u6846\u8981\u6c42\u8f93\u5165 api key\u3002\n\n\u8f93\u5165\u7684 api key \u4f1a\u88ab\u4fdd\u5b58\u5728\u6d4f\u89c8\u5668\u7684 `local storage` \u4ee5\u907f\u514d\u6bcf\u6b21\u90fd\u5f97\u8f93\u5165\n\n\u5982\u679c\u5728\u4e0d\u4fe1\u4efb\u7684\u73af\u5883\u4e0b\uff0c\u8bf7\u4f7f\u7528\u6d4f\u89c8\u5668\u7684\u9690\u5f0f\u6a21\u5f0f\u8bbf\u95ee\u3002\n\n### \u5173\u4e8e api-key\n\napi key \u53ef\u4ee5\u4f7f\u7528\u6570\u5b57\u548c\u5b57\u6bcd\uff0c\u957f\u5ea6\u9650\u5236\u4e3a\u6700\u77ed 8 \u6700\u957f 80\u3002\n\n3 \u6b21\u5c1d\u8bd5\u5185 api key \u6b63\u786e\u5ba2\u6237\u7aef ip \u4f1a\u81ea\u52a8\u52a0\u5165\u767d\u540d\u5355\uff0c3 \u6b21\u9519\u8bef\u540e\u5219 ip \u4f1a\u88ab\u52a0\u5165\u9ed1\u540d\u5355\uff0c\u9ed1\u540d\u5355\u540e\u8bf7\u6c42\u4f1a\u88ab\u62d2\u7edd (403)\u3002\n\n\u9ed1\u540d\u5355\u548c\u767d\u540d\u5355\u6570\u4ee5\u53ca\u540c\u65f6\u5c1d\u8bd5\u8fde\u63a5\u7684 ip \u6570\u91cf\u9650\u5236\u5404\u4e3a 100\uff0c\u9ed1\u540d\u5355\u6216\u767d\u540d\u5355\u5230\u8fbe\u9650\u5236\u540e\u4e0d\u518d\u63a5\u53d7\u9664\u4e86\u767d\u540d\u5355\u5185\u7684\u5176\u5b83 ip \u3002\n\n\u53ea\u6709\u91cd\u542f\u624d\u4f1a\u6e05\u7a7a\u9ed1\u540d\u5355\u548c\u767d\u540d\u5355\u3002\n\n## \u4f5c\u4e3a ASGI \u5e94\u7528\u8fd0\u884c\n\n uvicorn blrec.web:app\n\n\u6216\u8005\n\n hypercorn blrec.web:app\n\n\u4f5c\u4e3a ASGI \u5e94\u7528\u8fd0\u884c\uff0c\u53c2\u6570\u901a\u8fc7\u73af\u5883\u53d8\u91cf\u6307\u5b9a\u3002\n\n- `BLREC_CONFIG` \u6307\u5b9a\u8bbe\u7f6e\u6587\u4ef6\n- `BLREC_OUT_DIR` \u6307\u5b9a\u5f55\u64ad\u5b58\u653e\u4f4d\u7f6e\n- `BLREC_LOG_DIR` \u6307\u5b9a\u65e5\u5fd7\u5b58\u653e\u4f4d\u7f6e\n- `BLREC_API_KEY` \u6307\u5b9a `api key`\n\n### bash\n\n BLREC_CONFIG=path/to/settings.toml BLREC_OUT_DIR=path/to/dir BLREC_API_KEY=******** uvicorn blrec.web:app --host 0.0.0.0 --port 8000\n\n### cmd\n\n set BLREC_CONFIG=D:\\\\path\\\\to\\\\config.toml & set BLREC_OUT_DIR=D:\\\\path\\\\to\\\\dir & set BLREC_API_KEY=******** uvicorn blrec.web:app --host 0.0.0.0 --port 8000\n\n## Webhook\n\n\u7a0b\u5e8f\u5728\u8fd0\u884c\u8fc7\u7a0b\u4e2d\u4f1a\u89e6\u53d1\u4e00\u4e9b\u4e8b\u4ef6\uff0c\u5982\u679c\u662f\u652f\u6301 `webhook` \u7684\u4e8b\u4ef6\uff0c\u5c31\u4f1a\u7ed9\u6240\u8bbe\u7f6e\u7684 `webhook` \u7f51\u7edc\u5730\u5740\u53d1\u9001 POST \u8bf7\u6c42\u3002\n\n\u5173\u4e8e\u652f\u6301\u7684\u4e8b\u4ef6\u548c `POST` \u8bf7\u6c42\u6240\u53d1\u9001\u7684\u6570\u636e\uff0c\u8be6\u89c1 wiki\u3002\n\n## REST API\n\n\u540e\u7aef `web` \u6846\u67b6\u7528\u7684\u662f `FastApi` , \u8981\u67e5\u770b\u81ea\u52a8\u751f\u6210\u7684\u4ea4\u4e92\u5f0f `API` \u6587\u6863\uff0c\u8bbf\u95ee `http://localhost:2233/docs` \uff08\u9ed8\u8ba4\u4e3b\u673a\u548c\u7aef\u53e3\u7ed1\u5b9a\uff09\u3002\n\n## Progressive Web App\uff08PWA\uff09\n\n\u524d\u7aef\u5176\u5b9e\u662f\u4e00\u4e2a\u6e10\u8fdb\u5f0f\u7f51\u7edc\u5e94\u7528\uff0c\u53ef\u4ee5\u901a\u8fc7\u5730\u5740\u680f\u53f3\u4fa7\u7684\u56fe\u6807\u5b89\u88c5\uff0c\u7136\u540e\u50cf\u539f\u751f\u5e94\u7528\u4e00\u6837\u4ece\u684c\u9762\u542f\u52a8\u8fd0\u884c\u3002\n\n**\u6ce8\u610f\uff1aPWA \u8981\u5728\u672c\u5730\u8bbf\u95ee\u6216\u8005\u5728 `https` \u4e0b\u624d\u652f\u6301\u3002**\n\n---\n\n## \u5f00\u53d1\n\n1. \u514b\u9686\u4ee3\u7801\n\n `git clone https://github.com/acgnhiki/blrec.git`\n\n2. \u8fdb\u5165\u9879\u76ee\u76ee\u5f55\n\n `cd blrec`\n\n3. \u521b\u5efa\u865a\u62df\u73af\u5883\n\n `python3 -m venv .venv`\n\n4. \u6fc0\u6d3b\u865a\u62df\u73af\u5883\n\n `source .venv/bin/activate`\n\n5. \u4ee5\u53ef\u7f16\u8f91\u65b9\u5f0f\u5b89\u88c5\n\n `pip install -e .[dev]`\n\n6. \u4fee\u6539\u4ee3\u7801\n\n \u2026\u2026\n\n7. \u8fd0\u884c blrec\n\n `blrec`\n\n8. \u9000\u51fa\u865a\u62df\u73af\u5883\n\n `deactivate`\n\n---\n\n## \u5e38\u89c1\u95ee\u9898\n\n[FAQ](FAQ.md)\n\n## \u66f4\u65b0\u65e5\u5fd7\n\n[CHANGELOG](CHANGELOG.md)\n\n---\n\n## \u5176\u5b83\u76f8\u5173\u5de5\u5177\u6216\u9879\u76ee\n\n| \u540d\u79f0 | \u94fe\u63a5 | \u7b80\u4ecb |\n| --- | --- | --- |\n| \u5f55\u64ad\u59ec | [\u5b98\u7f51](https://rec.danmuji.org/) | \u7b80\u5355\u6613\u7528\u6210\u719f\u7a33\u5b9a\u7684 B \u7ad9\u76f4\u64ad\u5f55\u5236\u5de5\u5177 |\n| rclone | [\u5b98\u7f51](https://rclone.org/) | \u53ef\u4ee5\u6302\u8f7d\u7f51\u76d8\u7528\u4e8e\u5b58\u653e\u5f55\u64ad\u6587\u4ef6 |\n| alist | [\u5b98\u7f51](https://alist-doc.nn.ci/) | \u7f51\u76d8\u6587\u4ef6\u6d4f\u89c8\u3001\u64ad\u653e |\n| filebrowser | [\u5b98\u7f51](https://filebrowser.org/) | \u670d\u52a1\u5668\u6587\u4ef6\u7ba1\u7406 |\n\n\n",
"bugtrack_url": null,
"license": "GPLv3",
"summary": "Bilibili Live Streaming Recorder",
"version": "1.15.0",
"project_urls": {
"Homepage": "https://github.com/acgnhiki/blrec"
},
"split_keywords": [
"bilibili",
"live",
"danmaku",
"recorder"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bd1814f7323146298d6e77d56d9994c327632f3faa7f2415a63271b72ed29ed1",
"md5": "64a3a279a02d863e2afb8bfbddb9eb43",
"sha256": "3088c495cb2cc0ed97f77adae0f09c01c0f90af06a64658d86ea5aca3d3d87dd"
},
"downloads": -1,
"filename": "blrec-1.15.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "64a3a279a02d863e2afb8bfbddb9eb43",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 2139206,
"upload_time": "2023-10-14T11:47:18",
"upload_time_iso_8601": "2023-10-14T11:47:18.526620Z",
"url": "https://files.pythonhosted.org/packages/bd/18/14f7323146298d6e77d56d9994c327632f3faa7f2415a63271b72ed29ed1/blrec-1.15.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "afe1d491fae255acfe97312b267bd7fe909f8d5502ab7c59b105d0f1c475daa2",
"md5": "86bc53025e61e01f99e85705666e4d1b",
"sha256": "6198039bc1685446a9aebaab17e4cffb4acaf626fe3ba417e5533193bed29a8b"
},
"downloads": -1,
"filename": "blrec-1.15.0.tar.gz",
"has_sig": false,
"md5_digest": "86bc53025e61e01f99e85705666e4d1b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 1371498,
"upload_time": "2023-10-14T11:47:30",
"upload_time_iso_8601": "2023-10-14T11:47:30.239008Z",
"url": "https://files.pythonhosted.org/packages/af/e1/d491fae255acfe97312b267bd7fe909f8d5502ab7c59b105d0f1c475daa2/blrec-1.15.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-14 11:47:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "acgnhiki",
"github_project": "blrec",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "blrec"
}
JSON
