Skip to content

Commit

Permalink
add security warning detail and solution, update quick start
Browse files Browse the repository at this point in the history
  • Loading branch information
ylxmf2005 committed Jan 23, 2025
1 parent 13269b1 commit 2be87ff
Show file tree
Hide file tree
Showing 4 changed files with 44 additions and 16 deletions.
9 changes: 2 additions & 7 deletions docs/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -186,21 +186,16 @@ curl -LsSf https://astral.sh/uv/install.sh | sh
### 1. 获取项目代码

:::info 开发版说明
目前处于 v1.0.0 开发阶段,需要切换到 `superb-refactoring` 分支。

`v1.0.0` 开始,前端代码已被拆分到独立仓库中。我们建立了完整的构建流程,并通过 git submodule 将前端代码链接到主仓库的 `frontend` 目录下。
:::

```bash
# 克隆仓库
# 克隆仓库 / 下载最新的 Github Release
git clone https://github.com/t41372/Open-LLM-VTuber

# 进入项目目录
cd Open-LLM-VTuber

# 切换到开发分支
git switch superb-refactoring

# 由于 git submodule 链接的内容不会自动同步到本地目录,我们需要手动获取前端代码。
git submodule update --init --recursive
```
Expand Down Expand Up @@ -322,7 +317,7 @@ uv run run_server.py
运行成功后,访问 `http://localhost:12393` 打开 Web 界面。

:::tip 桌面应用
如果你更喜欢 Electron 应用 (窗口模式 + 桌充模式),可以从 [Open-LLM-VTuber-Web Releases](https://github.com/Open-LLM-VTuber/Open-LLM-VTuber-Web/releases) 下载对应平台 Electron 客户端,可以在后端服务运行的前提下直接使用。
如果你更喜欢 Electron 应用 (窗口模式 + 桌充模式),可以从 [Open-LLM-VTuber-Web Releases](https://github.com/Open-LLM-VTuber/Open-LLM-VTuber-Web/releases) 下载对应平台 Electron 客户端,可以在后端服务运行的前提下直接使用。但你有可能会遇到因为没有签名验证而导致的**安全警告**,具体情况和解决方案请查看 [模式介绍](./user-guide/frontend/mode.md)

有关前端的更多信息,请参考 [前端指南](./user-guide/frontend/)
:::
Expand Down
23 changes: 21 additions & 2 deletions docs/user-guide/frontend/mode.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,30 @@ Open LLM VTuber 提供了三种使用模式,以满足不同用户的需求:[

Web 模式需要通过部署或访问他人部署的网页链接来使用。

窗口模式和桌宠模式是基于 Electron 应用的两个模式,支持 Windows 和 Mac 系统,但暂时不支持移动设备。你可以直接从 Github Release 下载对应平台的安装包(推荐),或者下载源码进行测试或打包。
窗口模式和桌宠模式是基于 Electron 应用的两个模式,支持 Windows 和 Mac 系统,但暂时不支持移动设备。你可以直接从 [Github Release](https://github.com/Open-LLM-VTuber/Open-LLM-VTuber-Web/releases) 下载对应平台的安装包(推荐),或者下载源码进行测试或打包。

Window 模式和 Pet 模式共享上下文,这意味着你可以在两种模式之间任意切换的同时,保持当前的设置、状态、和连接不变。

:::note 详细说明
:::warning 关于安全警告
由于我们的桌面应用尚未进行代码签名,你可能会遇到以下安全提示:

- **Windows**: 运行时可能出现"Windows 已保护你的电脑"的提示。这时只需点击"更多信息",然后选择"仍要运行"即可。
- **macOS**: 首次打开时可能提示应用"已损坏,无法打开。您应该将它移到废纸篓"。解决方法:
1. 在命令行执行命令 `sudo spctl --master-disable`
2. 打开系统设置 - 安全与隐私,在软件来源处选择任意来源。
3. 在命令行执行命令 `xattr -rc /Applications/open-llm-vtuber-electron.app`
4. 再次打开应用即可

你可以通过搜索这些报错,了解更多关于他们的信息和解决方法。

这些警告是由于应用未经过操作系统认证导致的,不会影响应用的正常使用。未来我们可能考虑通过签名验证的方式彻底解决这一问题。
:::

:::info 关于更新
目前应用尚未支持自动检查更新功能。如需获取最新版本,你可以期关注 Github Release 页面的版本发布信息,也可以尝试使用最新的不稳定分支 (除开发者外不推荐)。
:::

:::note

关于每种模式的具体使用方法和功能特性,请参考
- [Web 模式 使用指南](./web.md)
Expand Down
9 changes: 2 additions & 7 deletions i18n/en/docusaurus-plugin-content-docs/current/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -183,21 +183,16 @@ For more uv installation methods, refer to: [Installing uv](https://docs.astral.
### 1. Get the Project Code

:::info Development Version Note
Currently in the v1.0.0 development phase, you need to switch to the `superb-refactoring` branch.

Starting from `v1.0.0`, the frontend code has been split into a separate repository. We have established a complete build process and linked the frontend code to the main repository's `frontend` directory via git submodule.
:::

```bash
# Clone the repository
# Clone the repository / Download the latest release
git clone https://github.com/t41372/Open-LLM-VTuber

# Enter the project directory
cd Open-LLM-VTuber

# Switch to the development branch
git switch superb-refactoring

# Since git submodule linked content is not automatically synced to the local directory, we need to manually fetch the frontend code.
git submodule update --init --recursive
```
Expand Down Expand Up @@ -319,7 +314,7 @@ uv run run_server.py
After successful execution, visit `http://localhost:12393` to open the web interface.

:::tip Desktop Application
If you prefer an Electron application (window mode + desktop mode), you can download the corresponding platform Electron client from [Open-LLM-VTuber-Web Releases](https://github.com/Open-LLM-VTuber/Open-LLM-VTuber-Web/releases), which can be used directly while the backend service is running.
If you prefer an Electron application (window mode + desktop mode), you can download the corresponding platform Electron client from [Open-LLM-VTuber-Web Releases](https://github.com/Open-LLM-VTuber/Open-LLM-VTuber-Web/releases), which can be used directly while the backend service is running. You may encounter **security warnings** due to the lack of code signing - please check [Mode Introduction](./user-guide/frontend/mode.md) for details and solutions.

For more information about the frontend, refer to the [Frontend Guide](./user-guide/frontend/)
:::
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,25 @@ Window Mode and Desktop Pet Mode are two modes based on the Electron application

Window Mode and Pet Mode share context, which means you can switch between the two modes at will while maintaining current settings, status, and connections.

:::warning About Security Warnings
Since our desktop application has not been code-signed, you may encounter the following security warnings:

- **Windows**: When running, you may see a "Windows protected your PC" warning. Simply click "More info" and then select "Run anyway" to proceed.
- **macOS**: When first opening, you may see a warning that the app "is damaged and can't be opened. You should move it to the Trash". To resolve this:
1. Run the command `sudo spctl --master-disable` in terminal
2. Open System Settings - Security & Privacy, select "Allow apps downloaded from: Anywhere"
3. Run the command `xattr -rc /Applications/open-llm-vtuber-electron.app` in terminal
4. Try opening the app again

You can search for these errors to learn more about them and their solutions.

These warnings occur because the application has not been certified by the operating system and will not affect the normal use of the application. In the future, we may consider resolving this issue completely through code signing.
:::

:::info About Updates
Currently, the application does not support automatic update checking. To get the latest version, you can follow the version release information on the Github Release page, or try using the latest unstable branch (not recommended except for developers).
:::

:::note Detailed Instructions

For specific usage methods and features of each mode, please refer to
Expand Down

0 comments on commit 2be87ff

Please sign in to comment.