部署 WebUI
通过 WebUI 部署、管理您的 sithra-rs 机器人
欢迎使用 sithra-web！
sithra-web 为 sithra-rs 提供了现代化的 Web 用户界面，
让您可以更直观、便捷地配置、访问和管理您的机器人。
本篇文档将引导您在几分钟内完成 sithra-web 的下载、配置和启动。
系统要求
为了方便用户，我们为以下主流平台提供了预编译的二进制文件。您可以直接下载并运行，无需手动编译。
- Linux (x86-64)
- Windows (x86-64)
- macOS (x86-64)
- macOS (ARM64)
其他平台
如果您的操作系统或 CPU 架构不在上述列表内，您需要从源代码手动编译 sithra-web。请参考下文的 从源码编译 部分。
首次启动设置
首次访问 WebUI 时，系统会要求您设置管理员用户名和密码，请务必妥善保管。
1. 下载与部署
前往 GitHub Releases 页面，根据您的操作系统下载最新版本的 sithra-web 压缩包。
将下载的压缩包解压到一个您喜欢的目录。我们建议您为 sithra-web 创建一个独立的文件夹。
解压后，您的目录结构应该如下所示：
首次运行前，请确保 config.toml 文件存在于 sithra-web 的运行目录中。sithra-web 依赖此文件来加载和配置插件。
注意
如果 sithra-web 在启动时没有找到 config.toml 文件，程序将会自动退出。
关于如何编写配置文件，请参考文档：编写配置项。
一切就绪！现在您可以启动 sithra-web 了。
在终端中执行以下命令：
.\sithra-web.exe首先，为文件添加可执行权限，然后运行它：
chmod +x ./sithra-web
./sithra-web如果一切顺利，您将在终端看到 sithra-web 成功启动的日志信息。默认情况下，您可以访问 http://127.0.0.1:8080 来打开 WebUI。
服务配置
sithra-web 提供了灵活的配置选项，您可以通过命令行参数或环境变量来调整服务行为。
命令行参数的优先级高于环境变量。
--host
功能: 设置服务监听的主机地址。
默认值: 127.0.0.1
环境变量: SITHRA_WEB_HOST
示例: sithra-web --host 0.0.0.0
--port
功能: 设置服务监听的端口。
默认值: 8080
环境变量: SITHRA_WEB_PORT
示例: sithra-web --port 8000
--web-path
功能: 指定 Web UI 静态资源文件的路径。
默认值: web
环境变量: SITHRA_WEB_PATH
示例: sithra-web --web-path /opt/sithra-web/ui
--api-only
功能: 仅启动后端 API 服务，不托管 Web UI。
默认值: false
环境变量: SITHRA_WEB_API_ONLY
示例: sithra-web --api-only
2. 从源码编译
如果您是开发者，或者您需要在非官方支持的平台上运行 sithra-web，您可以选择从源代码进行编译。
准备 Rust 环境
请确保您的系统中已安装 Rust 工具链。如果尚未安装，可以参考 Rust 官方文档 进行安装。
编译项目
在项目根目录下，执行 cargo build 命令并指定编译 sithra-web：
cargo build -p sithra-web --release编译完成后，生成的可执行文件将位于 target/release/ 目录下。
获取帮助
SithraBot/sithra-rs
9
如果您在使用过程中遇到任何问题，或有任何功能建议，欢迎随时在 GitHub Issues 中提出。
您也可以加入我们的 QQ 群获取帮助：948180922