Skip to content

Commit 0c37ed0

Browse files
authored
docs: update docs (#272)
* docs: update docs
1 parent b6a8210 commit 0c37ed0

File tree

1 file changed

+12
-11
lines changed

1 file changed

+12
-11
lines changed

README.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737

3838
> 如果您觉得项目不错,欢迎 :star: 也欢迎 PR 合作,如果有任何疑问,欢迎提 issue 交流。
3939
40-
自动监听并录制B站直播和弹幕(含付费留言、礼物等),根据分辨率转换弹幕、语音识别字幕并渲染进视频,根据弹幕密度切分精彩片段并通过视频理解大模型生成有趣的标题,自动投稿视频和切片至B站,兼容无GPU版本,兼容超低配置服务器与主机。
40+
自动监听并录制B站直播和弹幕(含付费留言、礼物等),根据分辨率转换弹幕、语音识别字幕并渲染进视频,根据弹幕密度切分精彩片段并通过视频理解大模型生成有趣的标题,根据图像生成模型自动生成视频封面,自动投稿视频和切片至B站,兼容无GPU版本,兼容超低配置服务器与主机。
4141

4242
## 2. Major features
4343

@@ -108,7 +108,7 @@ graph TD
108108
| Bandwidth | 3Mbps | 100Mbps | 100Mbps |
109109
| Python Version | 3.10 | 3.10 | 3.10 |
110110

111-
> 个人经验:若想尽可能快地更新视频,主要取决于上传速度而非弹幕渲染速度,因此建议网络带宽越大越好。
111+
> 个人经验:若想尽可能快地更新视频,主要取决于上传速度而非渲染速度,因此建议网络带宽越大越好。由于 [aarch64 版本 PyPI 没有 release](https://github.com/triton-lang/triton/issues/5561)[triton 库](https://pypi.org/project/triton/#history),因此 aarch64 版本暂时不支持本地部署 whisper,pip 时请自行注释 requirement 中的 triton 环境,配置均测试可用
112112
113113
## 4. Quick start
114114

@@ -277,7 +277,7 @@ python -m bilitool.cli login
277277

278278
#### 6. 启动自动录制
279279

280-
默认密码为 `bilive2233`, 如果要将录制页面向公网开放,请务必在 `record.sh``--api-key` 后重新设置密码!如需使用 https,可以考虑 openssl 自签名证书并添加参数 `--key-file path/to/key-file --cert-file path/to/cert-file`
280+
默认密码为 `bilive2233`, 如果要将录制页面向公网开放,请务必在 `record.sh``--api-key` **重新设置密码**(最短 8 最长 80)!如需使用 https,可以考虑 openssl 自签名证书并添加参数 `--key-file path/to/key-file --cert-file path/to/cert-file`
281281

282282
```bash
283283
./record.sh
@@ -287,7 +287,7 @@ python -m bilitool.cli login
287287

288288
#### 7. 启动自动上传
289289

290-
> 如果你使用 deploy 的方式进行语音识别,请先确保你已经正确下载并放置了对应的模型文件。
290+
> 如果你使用 deploy 的方式本地部署 whisper,请先确保你已经正确下载并放置了对应的模型文件,并确保 CUDA 可用
291291
292292
```bash
293293
./upload.sh
@@ -313,16 +313,17 @@ logs # 日志文件夹
313313

314314
### Docker 运行
315315

316-
也可以直接拉取 docker 镜像运行,默认 latest。守护进程是 upload,而 record 以及 scan 需要在配置后手动启动,相关配置以及启动流程从 3.2 开始即可。
317-
318316
> [!IMPORTANT]
319-
> 如果不需要使用可视化页面可以忽略以下提醒:
320-
> - 不推荐在有公网 ip 的服务器上直接暴露 22333 端口访问管理页面,如果使用请自行限制端口入站 ip 规则或者采用 nginx 等反向代理配置密钥限制他人访问。
321-
> - 管理页面主要针对 record 模块,只有手动运行 record 后(步骤5)才能访问到管理页面。
317+
> 在有公网 ip 的服务器上使用默认密码并暴露端口号有潜在的暴露 cookie 风险,因此**不推荐**在有公网 ip 的服务器映射端口号。
318+
> 如果需要在有公网 ip 的服务器上访问管理页面:
319+
> - 请务必在 `record.sh``--api-key`**重新设置密码**(最短 8 最长 80)!!!
320+
> - 如需使用 https,可以考虑 openssl 自签名证书并添加参数 `--key-file path/to/key-file --cert-file path/to/cert-file`
321+
> - 最好再自行限制服务器端口入站 ip 规则或者采用 nginx 等反向代理配置限制他人访问。
322+
> - 管理页面主要针对 record 模块,record 模块启动后才能访问到可视化管理页面。
322323
323324
#### 无 GPU 版本
324325

325-
如果你能看到这行字,说明 0.3.0 版本还没有发布,会在两天内测试完发布,请耐心等待。可以尝试源码部署。
326+
如果你能看到这行字,说明 0.3.0 版本还没有发布,会在两天内测试完发布,请耐心等待。可以尝试源码部署。注意:0.2.x 版本和 0.3.0 版本不兼容,如需采用 0.2.x 版本,请参考项目文档而不是本 README。
326327

327328
```bash
328329
sudo docker run \
@@ -334,7 +335,7 @@ sudo docker run \
334335

335336
#### 有 GPU 版本
336337

337-
如果你能看到这行字,说明 0.3.0 版本还没有发布,会在两天内测试完发布,请耐心等待。可以尝试源码部署。
338+
如果你能看到这行字,说明 0.3.0 版本还没有发布,会在两天内测试完发布,请耐心等待。可以尝试源码部署。注意:0.2.x 版本和 0.3.0 版本不兼容,如需采用 0.2.x 版本,请参考项目文档而不是本 README。
338339

339340
```bash
340341
sudo docker run \

0 commit comments

Comments
 (0)