diff --git a/packages/docs/config.ts b/packages/docs/config.ts index 2306688..e14ae43 100644 --- a/packages/docs/config.ts +++ b/packages/docs/config.ts @@ -4,7 +4,7 @@ import { join } from 'node:path' import type { PresetOptions } from 'redocusaurus' const title = 'Chronocat' -const tagline = '小巧轻便的 Red 实现' +const tagline = '模块化的 Satori 框架' const logo = { alt: 'Chronocat Logo', @@ -64,7 +64,7 @@ const themeConfig: ThemeConfig = { { name: 'keywords', content: - 'Chronocat, Red, Chrononeko, RedProtocol, BetterQQNT, LiteLoaderQQNT, QQNTim, NoneBot, NoneBot2, Koishi, Koishi.js, Bot, Chatbot, 机器人, OneBot, QQ', + 'Chronocat, Crychiccat, Yukihana, Curinacat, Red, Chrononeko, RedProtocol, BetterQQNT, LiteLoaderQQNT, QQNTim, NoneBot, NoneBot2, Koishi, Koishi.js, Bot, Chatbot, 机器人, OneBot, QQ', }, ], @@ -77,26 +77,7 @@ const themeConfig: ThemeConfig = { { label: '使用', position: 'left', - type: 'dropdown', to: 'install', - items: [ - { - label: '安装', - to: 'install', - }, - { - label: '启动', - to: 'launch', - }, - { - label: '接入', - to: 'connect', - }, - { - label: '配置', - to: 'config', - }, - ], }, { label: '开发', @@ -126,6 +107,17 @@ const themeConfig: ThemeConfig = { }, ], }, + { + label: 'v0.2', + position: 'right', + type: 'dropdown', + items: [ + { + label: 'v0.1', + href: 'https://chronocat.vercel.app/v01', + }, + ], + }, { href: 'https://github.com/chrononeko/chronocat', html: '', @@ -150,10 +142,6 @@ const themeConfig: ThemeConfig = { label: '安装', to: '/install', }, - { - label: '启动', - to: '/launch', - }, { label: '接入', to: '/connect', diff --git a/packages/docs/docs/faq/2/index.mdx b/packages/docs/docs/faq/2/index.mdx index e995db4..8d507b6 100644 --- a/packages/docs/docs/faq/2/index.mdx +++ b/packages/docs/docs/faq/2/index.mdx @@ -3,6 +3,11 @@ title: Chronocat 是什么？ sidebar_position: 2 --- -Chronocat 是一个小巧轻便的 Red 实现。除了 Red -以外，Chronocat 还支持 Satori 等多种协议。目前，已经有多个框架可供接入 -Chronocat，支持的框架可参见 [接入](/connect) 页面。 +Chronocat 是一个模块化的 Satori 框架。 + +Chronocat 自身实现了 Satori 协议，但并不实现任何特定的功能；这些功能由 Chronocat +引擎提供。你可以安装不同的 Chronocat 引擎来使用各种功能。 + +目前，已经有多个框架可供接入 +Chronocat，支持的框架可参见 [接入](/connect) 页面。你也可以使用该页面列举的 SDK +进行开发。 diff --git a/packages/docs/docs/install/docker/community.mdx b/packages/docs/docs/install/docker/community.mdx deleted file mode 100644 index a875836..0000000 --- a/packages/docs/docs/install/docker/community.mdx +++ /dev/null @@ -1,75 +0,0 @@ ---- -title: 社区镜像 ---- - -import Link from '@docusaurus/Link' -import { UntrustedContents } from '@site/src/components/UntrustedContents' - - - -Chronocat 社区贡献者制作了多种 Docker -镜像，每个镜像都配有详细的使用说明。你可以任意选择一个镜像进行使用。 - -## 社区镜像 - -### yuukinya/chronocat-docker - -- 基于 Linux QQ -- 运行内存大于 310M -- 镜像大小 515.94 MB（压缩后） -- 支持持久化 QQ 登录状态和数据 - -阅读使用说明： - - - 前往 GitHub - - -查看镜像详情： - - - 前往 Docker Hub - - -### he0119/chronocat-docker - -- 基于 Windows QQ -- 运行内存大于 2G -- 镜像大小 1.91 GB（压缩后） -- 支持 NoVNC，你可以直接使用浏览器登录和操作 QQ -- 始终使用最新的 Chronocat - -阅读使用说明： - - - 前往 GitHub - - -查看镜像详情： - - - 前往 Docker Hub - - -## 下一步 - -安装完成后，你可以将 Chronocat 接入你喜爱的应用或框架。 - - - 前往接入 - diff --git a/packages/docs/docs/install/docker/index.mdx b/packages/docs/docs/install/docker/index.mdx deleted file mode 100644 index 8d751d7..0000000 --- a/packages/docs/docs/install/docker/index.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: Docker 安装 ---- - -import Link from '@docusaurus/Link' - -## 官方镜像（推荐） - -Chrononeko 团队提供了官方的 Chronocat 镜像。 - - - 使用官方镜像 - - -## 社区镜像 - -在 Chrononeko 团队推出官方镜像之前，一些社区小伙伴制作了第三方的 Chronocat 镜像。Chrononeko -团队在制作官方镜像的时候参考了这些社区实现。 - -目前，大部分的第三方镜像已不再维护。你仍然可以 [查看](/install/docker/community) 这些内容。 diff --git a/packages/docs/docs/install/docker/official/docker-mem.png b/packages/docs/docs/install/docker/official/docker-mem.png deleted file mode 100644 index 4fed725..0000000 Binary files a/packages/docs/docs/install/docker/official/docker-mem.png and /dev/null differ diff --git a/packages/docs/docs/install/docker/official/index.mdx b/packages/docs/docs/install/docker/official/index.mdx deleted file mode 100644 index f7b9511..0000000 --- a/packages/docs/docs/install/docker/official/index.mdx +++ /dev/null @@ -1,77 +0,0 @@ ---- -title: 官方镜像 ---- - -import { Constructing } from '@site/src/components/Constructing' - - - -`chronoc/at` 是由 Chrononeko 团队开发和维护的 Chronocat 官方镜像。 - -## 立即尝试 - -创建一个目录作为 Chronocat 的数据目录，并在目录内执行： - -```sh -docker run -it \ - --name chronocat \ - -p 16530:16530 \ - -p 5500:5500 \ - -p 16340:16340 \ - -v ./config:/chrono/.chronocat/config \ - -v ./qq:/chrono/.config/QQ \ - chronoc/at -``` - -Chronocat 会随即启动并打印远程登录的链接，点击链接即可登录 -QQ。之后，即可立即开始使用 Satori 和 Red 服务了。 - -## 参数 - -下面解释了各个参数的意义。推荐配置的参数均已包含在上方的命令里。 - -### 端口映射 - -暴露 Chronocat 登录服务： - -```sh --p 16340:16340 -``` - -暴露 Chronocat Red 服务： - -```sh --p 16530:16530 -``` - -暴露 Chronocat Satori 服务： - -```sh --p 5500:5500 -``` - -### 持久化 - -下文中提供的命令都将在工作目录（当前文件夹）创建持久化目录，因此请先设定好用于 -Chronocat 的工作目录。 - -持久化 Chronocat 配置： - -```sh --v ./config:/chrono/.chronocat/config -``` - -默认情况下，容器停止后登录信息会被保留，但销毁容器后登录信息会被一并销毁。因此，推荐对容器进行持久化配置，以保留 -QQ 的登录信息，或是直接保留所有 QQ 数据。 - -若要持久化登录信息： - -```sh --v ./nt_db:/chrono/.config/QQ/global/nt_db -``` - -若要持久化 QQ 的所有数据： - -```sh --v ./qq:/chrono/.config/QQ -``` diff --git a/packages/docs/docs/install/docker/official/reference.mdx b/packages/docs/docs/install/docker/official/reference.mdx deleted file mode 100644 index e9c797a..0000000 --- a/packages/docs/docs/install/docker/official/reference.mdx +++ /dev/null @@ -1,81 +0,0 @@ ---- -title: 参考 ---- - -## 资源 - -### 内存占用 - -目前版本的容器会占用约 250MiB -的内存。我们将在未来持续探索无头模式的更多可能性，并力求进一步降低内存占用。 - -![镜像内存占用](./docker-mem.png) - -### 镜像体积 - -基于下面的实际情况： - -- 镜像应当永远使用 Chronocat 的最新版本 -- 镜像可以使用 QQ 和 LiteLoaderQQNT 的稳定版本 - -我们对镜像进行了分层，将 QQ 和 LiteLoaderQQNT -作为镜像的下层存储。因此，我们也推荐在升级镜像版本时，先拉取新的版本，再删除旧的版本。 - -镜像压缩后的总体积小于 500MB。 - -各层体积的粗略值如下： - -- 基础镜像使用 `phusion/baseimage:jammy-1.0.1`，体积为 229MB -- base 镜像的公共体积约为 800MB -- 本地存在任一版本的 base 镜像的情况下，在不同 base 镜像间移动需要重新拉取约 400MB 的层 -- `chronoc/at` 层约为 1MB - -## 调试 - -### 进入容器 - -如果你需要进入容器调试，可以使用下面的命令。 - -进入容器（启动所有服务）： - -```sh -docker run --rm -it chronoc/at /sbin/my_init -- bash -l -``` - -进入容器（不启动任何服务）： - -```sh -docker run --rm -it chronoc/at bash -``` - -### 截图 - -对容器内的虚拟显示器进行截图： - -```sh -docker exec -i chronocat bash -c 'xwd -display :1 -root -silent | xwdtopnm | pnmtopng' > screenshot.png -``` - -你将永远得到黑屏，因此截图并无意义。 - -## 开发 - -### 自行构建 Chronocat 镜像 - -先创建一个 builder： - -```sh -docker buildx create --name container --driver=docker-container -``` - -构建 base 镜像： - -```sh -BUILD_DOCKER_BUILDER=container ./build-base.sh -``` - -构建 chronocat 镜像： - -```sh -BUILD_DOCKER_BUILDER=container ./build.sh -``` diff --git a/packages/docs/docs/launch/index.mdx b/packages/docs/docs/launch/index.mdx deleted file mode 100644 index c329b1b..0000000 --- a/packages/docs/docs/launch/index.mdx +++ /dev/null @@ -1,88 +0,0 @@ ---- -title: 启动 ---- - -import { Unsafe } from '@site/src/components/Unsafe' - -Chronocat 提供了多种启动方式，你可以根据自己的需求进行选择。 - -## 常规启动（推荐） - -在你没有特殊需求的情况下，我们总是推荐使用常规方式启动 Chronocat。 - -直接点击「QQ」进行启动即可。QQ 启动并登录账号后，Chronocat 会自动启动。 - -直接使用浏览器访问 Chronocat 启动的 Satori 服务即可判断 Chronocat 是否正在运行。 - -## 远程登录 - -如果你希望在正常启动 QQ 的同时使用 Chronocat 进行 QQ 登录，则可以选择远程登录。 - -启动 QQ 时附加如下的命令行参数或环境变量，则 Chronocat 将启用远程登录。 - -```sh -./QQ --chrono-mode=login -``` - -```ini -CHRONO_MODE=login -``` - -启动时，Chronocat 会在控制台打印一个链接，链接包含了登录服务使用的端口和服务密码，你可以使用这个链接进行登录。 - -直接打开链接，登录服务地址和服务密码会自动填充。 - -![远程登录-连接](./login-1.png) - -点击连接后，将会出现可用的快速登录账号。可以点击账号进行快速登录。如果不能快速登录，则需点击右边的二维码区域进行扫码登录。 - -![远程登录-登录](./login-2.png) - -登录服务的服务密码默认随机生成。可附加如下的命令行参数或环境变量用作登录服务的服务密码。如果同时存在，则使用命令行参数。 - -```sh -./QQ --chrono-admin-token=my-token -``` - -```ini -CHRONO_ADMIN_TOKEN=my-token -``` - -如果不存在上述命令行参数或环境变量，但存在初始化服务密码，则会使用初始化服务密码，不论 -Chronocat 是否为首次启动。参见 [配置](/config)。 - -登录服务的默认监听地址为 -`0.0.0.0:16340`。可附加如下的命令行参数或环境变量来改变登录服务的监听地址。如果同时存在，则使用命令行参数。 - -```sh -./QQ --chrono-admin-listen=127.0.0.1:16341 -``` - -```ini -CHRONO_ADMIN_LISTEN=127.0.0.1:16341 -``` - -## 手动无头启动 - - - -如果你追求更低的内存占用，则可以使用 Chronocat 无头启动。 - -启动 QQ 时附加如下的命令行参数或环境变量，则 Chronocat 将使用无头启动。 - -```sh -./QQ --chrono-mode=headless3 -``` - -```ini -CHRONO_MODE=headless3 -``` - -:::warning[注意 `headless3`] - -无头模式现在仍然处在「实验性功能」阶段。目前，只有模式 -3（`headless3`）可供使用。不要尝试其他模式。 - -::: - -启用 `headless3` 时会自动同时启用 `login`。 diff --git a/packages/docs/docs/launch/login-1.png b/packages/docs/docs/launch/login-1.png deleted file mode 100644 index 08d247a..0000000 Binary files a/packages/docs/docs/launch/login-1.png and /dev/null differ diff --git a/packages/docs/docs/launch/login-2.png b/packages/docs/docs/launch/login-2.png deleted file mode 100644 index c9ab6d1..0000000 Binary files a/packages/docs/docs/launch/login-2.png and /dev/null differ diff --git a/packages/docs/sidebars.ts b/packages/docs/sidebars.ts index 36e17a5..e95d62b 100644 --- a/packages/docs/sidebars.ts +++ b/packages/docs/sidebars.ts @@ -19,31 +19,10 @@ const sidebars: SidebarsConfig = { }, items: ['install/llqqnt-airgap'], }, - { - type: 'category', - label: 'Docker', - link: { - type: 'doc', - id: 'install/docker/index', - }, - items: [ - { - type: 'category', - label: '官方镜像', - link: { - type: 'doc', - id: 'install/docker/official/index', - }, - items: ['install/docker/official/reference'], - }, - 'install/docker/community', - ], - }, 'install/phone/index', 'install/trusted-installation', ], }, - 'launch/index', { type: 'category', label: '接入',