搜索
切换搜索
切换菜单
切换个人菜单
欢迎来到小可 · Wiki,人人可编辑的,多平台聊天机器人“小可”的官方文档资源。
小可很可爱,请
给我们打钱
。
原 MkDocs 已迁入本站。若发现 404 属正常现象,请点击左上角搜索您想要的模块。
查看“自搭建指南”的源代码
来自小可 · Wiki,人人可编辑的,QQ机器人“小可”的官方文档资源
阅读
查看源代码
查看历史
页面
讨论
更多操作
←
自搭建指南
因为以下原因,您没有权限编辑本页:
您请求的操作仅限属于该用户组的用户执行:
用户
您可以查看和复制此页面的源代码。
本文将会指导你如何搭建与部署小可。 搭建机器人需要计算机等相关知识有一定的了解,若在阅读过程中感到困惑,请善于使用搜索引擎。 == 安装 Python 环境 == 请前往 [https://www.python.org/ Python 官网] 下载 Python 3.12 及以上版本,低于此版本将不再受到支持。 == 获取源代码 == === 使用 Git 克隆 === 请在需要放置小可的文件目录下打开终端,并输入以下命令: <syntaxhighlight lang="sh"> git clone https://github.com/Teahouse-studios/akari-bot.git </syntaxhighlight> === 直接下载 === 请前往[https://github.com/Teahouse-Studios/akari-bot/archive/refs/heads/master.zip 此处]下载 Master 分支的源代码。由于无法保证 Release 版本的稳定性,我们不再提供 Release 版本的下载。 {{Mbox | text = 不建议通过直接下载的方式进行部署,因为这样将无法使用 git 或 <code>~[[update]]</code> 命令更新机器人源代码。 | type = note }} == 安装依赖 == === 使用 Poetry === Poetry 是一个现代化的依赖管理工具,它能够帮助你管理项目的依赖和虚拟环境。要使用 Poetry 安装依赖,首先需请确保已经安装了 Poetry。 : '''Windows''' 打开终端或 PowerShell,执行以下命令: <syntaxhighlight lang="powershell"> (Invoke-WebRequest -Uri "https://install.python-poetry.org" -UseBasicParsing).Content | py - </syntaxhighlight> : '''Linux''' 打开终端并运行以下命令: <syntaxhighlight lang="sh"> curl -sSL https://install.python-poetry.org | python - </syntaxhighlight> 安装 Poetry 完成后,请执行以下命令安装依赖: <syntaxhighlight lang="sh"> poetry install </syntaxhighlight> === 使用 pip === pip 是 Python 自带的官方包管理工具。 如果你不想使用 Poetry,请执行以下命令安装依赖: <syntaxhighlight lang="sh"> pip install -r requirements.txt </syntaxhighlight> == 设置配置 == 进入 <code>config</code> 文件夹,将配置文件 <code>config.toml.example</code> 重命名为 <code>config.toml</code>,然后开始配置所需的内容。 {{Mbox | text = 目前配置文件后缀为 toml ,与旧版 cfg 后缀文件不同的是,请在填写好必要的字段后,请删除所有留空的字段,否则程序将无法正常运行。<br> 若你拥有旧版 cfg 文件,机器人会自动帮你转换为 toml 格式。 | type = important }} 在表 <code>secret</code> 储存的属性为私有内容,例如 API 密钥等,当机器人发送的消息中存在这些内容时会被自动拦截。表 <code>config</code> 中大多数属性的默认值与程序内设定的默认值一致。如果你觉得这些默认值在配置文件中显得冗余,可以直接将其删除。 关于详细信息,请查看[[配置文件]]。 === 配置数据库 === 机器人需要一个数据库以用于存储用户数据。<code>db_path</code> 配置项需要填写一个可被 sqlalchemy 支持的数据库链接。 如果使用 MySQL 作为数据库: : 格式:<code>db_path = "mysql+pymysql://<数据库用户名>:<数据库用户密码>@<数据库地址>"</code> : 示例:<code>db_path = "mysql+pymysql://bot:123456@example.com/bot_prod"</code> 如果选择 SQLite 作为数据库: : 格式:<code>db_path = "sqlite:///<相对路径>/<数据库文件名>.db"</code> : 示例:<code>db_path = "sqlite:///database/save.db"</code> 此示例将会在 <code>database</code> 文件夹内创建 <code>save.db</code> 来存储用户数据。 {{Mbox | text = 如果你不希望为了部署一个机器人而去研究如何安装数据库(或购买某服务商的数据库服务)的话,使用 SQLite 就是最佳选择。缺点是可能会遇到锁表问题(极小概率发生),以及将来运维失误(误删除 db 文件且没有备份)导致原先用户数据损毁的情况。 | type = note }} === 内容安全 === 机器人内置了[https://www.aliyun.com/product/lvwang 阿里云内容安全服务]对接,可用于 QQ 和 KOOK 平台下部分功能检查发送文本是否安全,以达到机器人账户安全的目的。 如有需求,请前往阿里云进行开通并获取 AccessKeyID 及 AccessKeySecret,并在配置文件中填写相关配置项。 : <code>check_access_key_id =</code> - 填写获取的 AccessKeyID。 : <code>check_access_key_secret =</code> - 填写获取的 AccessKeySecret。 注意,由于阿里云政策限制,内容安全服务'''不面向个人开发者''',若账号未完成阿里云企业认证,即使生成 AccessKey 也不会调用相关接口。 === Webrender === Webrender 为机器人的外置服务,主要用于处理 Wiki infobox 图片渲染、 html 渲染以及部分功能的访问代理。 Webrender 的部署相关内容请见 [[Webrender#部署]]。亦可使用云服务产商的 Serverless 来部署本服务。 请在配置文件中 <code>web_render</code> 与 <code>web_render_local</code> 配置项填写访问地址。 : 格式: :: <code>web_render =</code> - Webrender 的地址(IP 或域名)及端口。 :: <code>web_render_local =</code> - 本地 Webrender 的地址,同时填写时将优先使用此地址,与 <code>web_render</code> 相同可不填。 : 示例:<code>web_render = "http://127.0.0.1:15551"</code> [[Category:开发]]
本页使用的模板:
Template:Mbox
(
查看源代码
)
Template:Mbox/config
(
查看源代码
)
Template:Navbox dev
(
查看源代码
)
返回
自搭建指南
。
Cookie帮助我们提供我们的服务。通过使用我们的服务,您同意我们使用cookie。
更多信息
确定