diff --git a/Getting-started.md b/Getting-started.md new file mode 100644 index 0000000..542194b --- /dev/null +++ b/Getting-started.md @@ -0,0 +1,17 @@ +# 开始使用 ScalaBot + +## 前提条件 + +首先,你需要准备以下内容: +1. Telegram Bot 账户(可以在 Telegram 中搜索 [`@BotFather`](https://t.me/BotFather) 来创建机器人账户); + +2. 一台服务器: + - 服务器中需要安装 Java 11 或更高,建议使用 Java 17; + +3. + +## 安装 + +安装 ScalaBot 有两种方法: +- [手动安装(支持 Windows、Linux)](Manual-installation.md) +- [使用 Docker 安装(支持 Linux)](Install-with-docker.md) diff --git a/Home.md b/Home.md index 4295e2d..cde9196 100644 --- a/Home.md +++ b/Home.md @@ -1 +1,5 @@ -欢迎来到 ScalaBot 的 Wiki! +欢迎来到 ScalaBot 的 Wiki! + +建议查看: +- [开始使用 ScalaBot](Getting-started.md) +- [配置详解](Configuration.md) \ No newline at end of file diff --git a/Install-with-docker.md b/Install-with-docker.md new file mode 100644 index 0000000..ef7dafb --- /dev/null +++ b/Install-with-docker.md @@ -0,0 +1,47 @@ +# 使用 Docker 容器部署 + +## 受支持的标签 +### 开发版 +开发版镜像由 Github Action 从 main 分支中自动构建并发布,不保证稳定性,请勿用于生产环境。 +镜像名称: +```text +lamgc/scalabot:dev +``` + +### 发布版 +发布版命名规则为:`latest`、`v<版本号>`, +例如: +```text +# 该标签将确保是最新稳定发布版. +lamgc/scalabot:latest +# 不一定是最新版, 具体最新版请查看 Github Releases. +lamgc/scalabot:v0.5.1 +``` +## 使用 +> 注意:开始前,请先确保满足[前提条件](Getting-started.md#前提条件)。 + +> 注意:请在执行命令前替换掉 `<...>` 中的内容. + +使用以下命令使用最新版镜像创建一个 ScalaBot 容器: +```shell +docker run -d --name scalabot \ + -v :/scalabot/data \ + lamgc/scalabot:latest +``` +如果为第一次使用 ScalaBot,那么镜像将会自动退出, 此时请前往 **ScalaBot 数据目录**中按需要修改配置文件,至少添加并启用一个 Telegram 机器人账号。 + +然后,再次启动 ScalaBot 容器: +```shell +docker start scalabot +``` +首次启动 ScalaBot 时,会自动下载扩展包和相关依赖库,这可能需要一段时间,请耐心等待。 + +## 容器中的路径 +镜像中主要有三个路径: +- `/scalabot/app/`:ScalaBot 主程序路径; +- `/scalabot/data/`:ScalaBot 配置文件路径(所有数据和配置文件都存放在该目录); +- `/scalabot/run/`:ScalaBot 运行路径(一般不存放数据); + +> 警告:请不要直接映射 `/scalabot/` 路径,这样会导致 `/scalabot/app/` 路径被覆盖,进而导致无法找到 ScalaBot 主程序。 + +如无特殊情况,建议只映射 `/scalabot/data/` 路径到宿主机,ScalaBot 开发指南中已明确要求扩展包将数据存放在位于 `/scalabot/data/` 的数据目录中。