[完整版]aichat官方文档

vtea · 2023 年9 月 20 日 13:33

项目介绍

此项目仅限于学习和交流使用，如若用于商业用途，请确保合法合规

本项目基于ChatGPT-Next-Web开源项目进行二次开发，增加用户注册登录、用户管理、套餐管理等功能，并提供可自行部署的解决方案。

官网：nanjiren.online

Github地址：点击跳转

论坛：jiao.nanjiren.online

QQ群：437 863 036

前台用户界面：chat.nanjiren.online

后台管理界面：admin.nanjiren.online

统一账号：aichat/aichatadmin

演示站:

后台演示：

演示站登录信息
账号：aichat
密

温馨提示：由于后台开放，请勿在演示站中输入敏感信息。

一、项目优势

1、零基础，不会敲代码也可以搭建

快速：项目提供一键部署脚本，采购服务器后只需执行一键部署脚本即可搭建，整个过程最快不超过3分钟。

简单：部署后，进入提供的管理后台，即可定义自己站点的内容，无需修改任何代码，无需构建部署环节，即改即生效。

2、高度自定义

项目提供方便易用，成熟稳定的管理后台（基于vue-element-admin），绝大部分内容可以在后台直接设定。

2.1、网站标题、欢迎词、公告自定义

①可以自定义网站标题，副标题； ②可以自定义欢迎词，支持富文本格式，您可以在此处添加图片（例如二维码）进行引流； ③可以编辑公告，同样支持富文本格式，您可以在此处展示使用声明、通知，可以选择是否开屏展示。

2.2、套餐玩法自定义

次卡？周卡？月卡？统统可以在后台定义。

2.3、更多自定义内容

在后台管理中，您还可以设定注册方式（支持用户名+密码方式、图形验证码方式、邮箱注册方式），各页面主副标题，出现敏感词时的提示语，额度不足提示语……

用户前台

2.4 界面预览

1、聊天

2、登录

3、注册

4、个人中心

管理后台

5、会员列表

6、次数变动记录/手动添加次数

更多预览请访问演示站

二、技术栈

三、版本信息

如需购买专业版请跳转到定价,

社区版：V0.6

专业版：V0.9.3

td {white-space:nowrap;border:1px solid #dee0e3;font-size:10pt;font-style:normal;font-weight:normal;vertical-align:middle;word-break:normal;word-wrap:normal;}

功能	进度
用户管理	已完成(v0.0.1)
额度管理	已完成(v0.1)
注册额度赠送	已完成(v0.1)
邮箱验证码注册	已完成(v0.1)
调用频率限制	已完成(v0.1)
图形验证码注册	已完成(v0.2)
网站标题	已完成(v0.2)
套餐管理	已完成(v0.2)
自定义敏感词拦截	已完成(v0.2)
忘记/重置密码	已完成(v0.4)
API KEY余额自动查询	已完成(v0.4)
忘记密码	已完成(v0.4)
第三方API状态余额查询	已完成(v0.6)
绘图功能	进行中

td {white-space:nowrap;border:1px solid #dee0e3;font-size:10pt;font-style:normal;font-weight:normal;vertical-align:middle;word-break:normal;word-wrap:normal;}

功能	进度
社区版的全功能
仪表盘	已完成(v0.3)
对接支付系统	已接入虎皮椒、蓝兔
邮件模板	已完成(v0.5)
邀请机制	已完成(v0.5)
微信登录	已完成(v0.5)
后台查看聊天记录	已完成(v0.5)
模型名称重映射	已完成(v0.5)
兑换码	已完成(v0.7)
面具管理	已完成(v0.7)
独立注册登录界面	已完成(v0.7)
key余额协议配置	已完成(v0.7)
更多UI自定义	已完成(v0.7)
对接发卡平台	进行中
多模型支持	长期进行

完整的版本更新日志请访问好望角客户支持论坛

四、一键部署

本项目基于docker，手动部署需支持docker compose

社区版一键部署

如果使用宝塔，请登录好望角论坛参照内测专属频道获取教程

AIChat社区版 V0.6

准备工作

在云厂商购买一台合适配置的服务器，操作系统选择CentOS 7.9（其他版本未测试）
在安全策略组中开放80端口和8080端口

服务器推荐海外2核4G的服务器（阿里云、腾讯云、华为云等大厂更稳定安全）

1、执行部署脚本

连接云服务器，在命令行中输入：

bash <(curl -s https://raw.githubusercontent.com/Nanjiren01/AIChatWeb/main/scripts/setup.sh)

2、设置管理前台超管账户

在执行步骤1中的部署脚本中，会提示你设置管理前台的超级管理员账户及密码，请在 Username: 后填写你要设置的超管账户用户名，如下所示：

Please input the super admin username.
Only letters and numbers are supported, the length should between 6 and 20, and they cannot start with a number.
Username: 你要设置的超管账户用户名

如果超级管理员账户名有效，会提示 Super Admin Username is valid. ，并且会接着提示你输入超级管理员账户的密码，请在 Password:后填写你要设置的超管账户密码，如下所示：

Please input the super admin password.
Only letters and numbers are supported, and the length should between 6 and 20.
You can change it on the web page after the Application running
Password: 你要设置的超管账户密码

如果超级管理员账户名有效，会提示 Super Admin Password is valid.

提示

由于在命令行中设定的密码较为简单（只包含字母和数字），建议应用启动后，尽快进入管理前台修改超管密码。

3、完成AIChat社区版部署

当命令行窗口出现以下信息时，则表示部署成功：

[+] Running 5/5
 ✔ Network root_default      Created
 ✔ Container aichat-db       Started
 ✔ Container aichat-admin    Started
 ✔ Container aichat-console  Started
 ✔ Container aichat-web      Started

4、访问AIChat社区版

稍等几秒钟应用初始化，即可打开 http://IP 访问用户前台页面，打开 http://IP:8080 访问管理前台页面。

专业版一键部署

如果使用宝塔，请登录好望角参照内测专属频道获取教程

服务器推荐海外2核4G的服务器（阿里云、腾讯云、华为云等大厂更稳定安全）

专业一键部署前序准备工作：

请先获取私有docker库账户与密码（该信息在专业版QQ群公告中）
提前准备好授权邮箱与授权LSK（授权获取方式在专业版QQ群公告中）

暂时无法在飞书文档外展示此内容

1、执行部署脚本

连接云服务器，在命令行中输入：

bash <(curl -s https://raw.githubusercontent.com/Nanjiren01/AIChatWeb/pro/scripts/aichat_pro_setup.sh)

2、选择语言

当出现以下提示时， 输入1后回车

请选择语言 / Please select your language:
1. 中文 / Chinese
2. 英文 / English
输入相应序号后回车 / Enter after typing the corresponding number:

3、配置专业版授权

在执行步骤1中的部署脚本中，会提示你输入AIChat专业版的授权账户用户名和密码（请在**AIChat专业版内测群中的公告**获取），如下所示：

################################################################################################ 配置AIChat专业版授权私有库账户 ###############################################################################################请输入AIChat专业版授权私有库的授权用户名：
授权用户名：
请输入AIChat专业版授权私有库的授权密码：
授权密码：

请在 授权用户名： 后填写AIChat专业版的授权账户用户名，在 授权密码： 后填写AIChat专业版的授权账户密码，若登录成功，则会提示：

Login Succeeded
****
成功设置AIChat专业版授权仓库账户 
****

4、配置专业版License

输入许可证信息，SK码请登录**AIChat授权中心控制台**后自行生成。

#################################################################
##################### 配置AIChat专业版许可证 ######################
#################################################################
请输入许可证的QQ邮箱：[email protected]
输入的许可证QQ邮箱有效
请输入许可证的SK码：lsk-AJKHAKJAHKJAHKAHKAHJKAKAHKK
输入的许可证SK码有效
**
许可证信息配置成功
**

5、配置管理前台超管账户

输入你自己的超级管理员信息进行配置，如下所示：

######################################################################################### 配置超级管理员 ############################################################################################仅支持字母和数字，长度应在6到20之间，并且不能以数字开头。
请输出超级用户的账户名称： aichat111
超级管理员账户名称有效
仅支持字母和数字，长度应在6到20之间。您可以在应用程序运行后在管理后台上进行更改。
请输出超级用户的账户密码：aichat111
超级管理员账户密码有效
*****
超级管理员信息配置成功 
*****

提示

由于在命令行中设定的密码较为简单（只包含字母和数字），建议应用启动后，尽快进入管理前台修改超管密码。

6、配置阿里云OSS（可选）

该步骤用于存储Midjourney返回的图片，配置过程中出现的参数请前往阿里云OSS控制台自行获取，如下所示：

################################################################
#################### 配置AIChat专业版对象存储 #####################
################################################################
你想进行配置吗？（可选） (按Y开始/按N跳过)
Choice: Y
请输入对象存储的OSS_ENDPOINT： https://oss-dsakdjaljs.aliyun.com
输入在OSS_ENDPOINT有效
请输入对象存储的OSS_BUCKET_NAME： aichat
输入在OSS_BUCKET_NAME有效
请输入对象存储的OSS_ACCESS_KEY_ID： dsaSADHSADJHKDSHFKASHDFASDF
输入在OSS_ACCESS_KEY_ID有效
请输入对象存储的OSS_ACCESS_KEY_SECRET： SDJFHKAHSFKASHDFKASHDFKHAS
输入在OSS_ACCESS_KEY_SECRET有效
***
对象存储信息配置成功
***

7、确认配置信息

配置结束将会输出类似以下信息，请再次核对是否有误，确认无误后请按回车继续进行安装。

======================================================================
============================== 配置总结 ===============================
======================================================================
AIChat专业版许可证信息：
许可证QQ邮箱： [email protected]
许可证SK码： lsk-AJKHAKJAHKJAHKAHKAHJKAKAHKK
超级管理员信息：
账户名称： aichat111
密码： aichat111
AIChat专业版对象存储信息：
OSS_Endpoint: https://oss-dsakdjaljs.aliyun.com
OSS_Bucket_Name: aichat
OSS_Access_Key_ID: dsaSADHSADJHKDSHFKASHDFASDF
OSS_Access_Key_Secret: SDJFHKAHSFKASHDFKASHDFKHAS
UTIL_ENDPOINT: 172.17.0.1
======================================================================
请检查上述配置是否正确，如果确认无误，请按 Enter 继续，或按 Ctrl+C 取消。

8、完成AIChat专业版部署

当命令行窗口出现以下信息时，则表示部署成功：

[+] Running 7/7
 ✔ Network aiass_default     Created                             ✔ Container aichat-db       Started                             ✔ Container aichat-redis    Started                             ✔ Container aichat-util     Started                             ✔ Container aichat-admin    Started                             ✔ Container aichat-console  Started                             ✔ Container aichat-web      Started

9、访问AIChat专业版

稍等几秒钟应用初始化，即可打开 http://IP 访问用户前台页面，打开 http://IP:8080 访问管理前台页面。

AIChat社区版升级为最新AIChat专业版 ¶

1、获取最新账号密码

AIChat项目组会在 专业版内测用户专属QQ群的公告 里不定期更新AIChat专业版的私有仓库账户及密码，请 及时获取最新的账户及密码 ，以保证升级的顺利进行。

2、暂停并移除现有的AIChat

切换至你配置文件所在的目录，命令行输入以下指令：

docker compose down

3、备份数据库

命令行输入以下指令：

cp -r 你的数据库路径/mysql_data 你要备份的数据库路径/mysql_data_bak

4、允许http登录

温馨提示

注意：后面会支持https登录，这个步骤后续会取消

修改docker配置文件，允许docker使用http登录

在 Docker 主机上创建或修改 /etc/docker/daemon.json 文件。如果文件不存在，请创建一个新的文件。
在 daemon.json 文件中，添加 insecure-registries 选项并设置为的AIChat专业版仓库的 HTTP 地址。配置文件应如下所示：

{  "insecure-registries": ["harbor.nanjiren.online:8099"]}

保存并关闭 daemon.json 文件。
重启 Docker 守护进程以应用更改。

systemctl restart docker

5、登录专业版私有库

命令行输入以下指令：

docker login http://harbor.nanjiren.online:8099

输入第1步获取的最新账号密码，提示 Login Succeeded 即为登录成功。

6、修改配置文件

切换当前目录为 docker-compose.yml 所在的目录，使用以下命令批量替换镜像文件源：

sed -i 's|image: nanjiren01\/aichat-admin:latest|image: harbor.nanjiren.online:8099\/aichat\/aichat-admin:latest|; s|image: nanjiren01\/aichat-web:latest|image: nanjiren01\/aichat-web:pro-latest|; s|image: nanjiren01\/aichat-console:latest|image: nanjiren01\/aichat-console:pro-latest|' docker-compose.yml

7、拉取专业版镜像

命令行输入以下指令：

docker compose pull

8、启动AIChat专业版服务

命令行输入以下指令：

docker compose up -d

五、系统更新

手动更新

提示

请在更新之前，务必记住自己的超级管理员用户及密码。

1、停止Docker服务

docker compose down

2、备份数据库

将 mysql_data 目录备份

方法一：直接在服务器上进行备份

温馨提示

请执行此操作之前，先进入存在 mysql_data 的目录，以确保能顺利完成备份。

cp -r mysql_data <备份的目标路径>

方法二：使用支持SFTP的软件从服务器备份至本地

例如：MobaXterm Xshell Xftp

3、获取最新配置文件

温馨提示

请执行此操作之前，先进入存在旧配置文件的目录，以确保能顺利完成替换。

将最新版本的配置文件覆盖旧的配置文件。docker-compose.yml

社区版

curl -o docker-compose.yml https://raw.githubusercontent.com/Nanjiren01/AIChatWeb/main/docker-compose.yml

专业版

bash <(curl -s https://raw.githubusercontent.com/Nanjiren01/AIChatWeb/pro/scripts/aichat_pro_setup.sh)

4、拉取最新镜像

执行以拉取社区版最新版本的 AIChat 镜像文件

docker compose pull

5、运行最新版本的AIChat

docker compose up -d

六、定价

AIChat专业版V0.7全套源码

3888 元/套

请注意：

  1. 源码不得进行二次售卖或交易；

项目组只保证系统第一次在用户本地运行成功，后续出现问题项目组一律不承担责任；
所有源码已申请版权保护，切勿用于学术不端、违反中华人民共和国法律的任何民事行为。

AIChat专业版内测用户资格

温馨提示

请购买 AIChat 专业版内测用户资格的用户，申请加入 专业版内测专属 QQ 群 时提供 支付的交易单号，方便管理员审核成员进入资格。

288 元/年

请注意：

  1. 随着功能的不断完善，价格会逐步提升，已经购买的用户不受影响。

1个专业版内测资格包含3张许可证（ip+mac，简而言之就是部署3台不同的服务器的权限）。
由于用户个人原因而导致许可证未按预期部署在相应服务器上，出现许可证用尽的情况，AIChat团队概不负责，望知悉！
已有AIChat专业版内测资格的用户，增加1张许可证需再次支付当前AIChat专业版内测用户资格价格的70%，当前0.9版本为 258*0.7=180.6 元。
已有AIChat专业版内测资格的用户，变更1张许可证的信息需再次支付 100 元。

客户端打包服务

200 元/年

演示

① AIChat MacOS App 下载 ② AIChat Windows 64位下载

提示

系统要求： ① 大于等于V0.4 ② 已配置好ssl证书且支持https

温馨提示

请在购买此项服务前，准备好以下信息或材料发送给管理员： ① 域名 ② 站点中英文名称 ③ 站点logo

注：包含1年有效期内各版本的打包，有效期从第一次打包起算，一次打包包含 MacOS App 及 Windows 64 位 App。

付款码（支持微信支付）

七、一站式API服务

AIMHUB全模型平台

注意：只有成为 AIChat专业版内测用户 或者 在AIMHUB上进行了额度充值 才能进入 vip分组，否则为 default分组， svip分组 为项目组内测组别，不对外开放。

计费规则

额度是什么？怎么计算的？AIMHUB的额度计算有问题？

额度 = 分组倍率 * 模型倍率 * ( 提示token数 + 补全token数 * 补全倍率 )；
其中补全倍率对于GPT3.5固定为1.33，GPT4为2，与官方保持一致；
如果是非流模式，官方接口会返回消耗的总 token，但是你要注意提示和补全的消耗倍率不一样0；
注意，AIMHUB的默认倍率就是官方倍率，是已经调整过的，除 gpt-4 -32k 类模型比原倍率多了1的倍率，其他均为官方1:1的价格。

如何调用

如果你用的是其它系统：请将 https://api.openai.com 换为AIMHUB的API调用地址，并且根据平台的模型列表，将调用的模型字段换成相应要调用的模型即可。
如果你用的是AIChat的系统：在项目管理后台新建AI平台，根据自己的服务器地域，选择最优的API调用地址，选择完成后，将下面的BASE_URL填入API调用地址保存即可。

AIMHUB API for Global：https://aimhub.nanjiren.online
AIMHUB API for Motherland：https://api.aimhub.cc/cnapi

添加模型（其余模型都按照下图添加即可）

补充说明：Goole PaLM-2目前仅支持英文对话，中文会报错或者不返回数据

添加API KEY

AIMHUB 新建令牌

令牌信息

复制key

使用key

用户端模型展示

用户端聊天展示

AIMHUB在Motherland的调用速度测试

AIMHUB在Global的调用速度测试

① AIMHUB (官网) ② 充值商城 (如果无法打开请修改本地dns或者使用魔法) ③ 点击加入群聊：639620895

Aimage MJ绘画服务

Aimage 入口地址：https://aimage.nanjiren.online/

API Key创建入口： API KEY 创建入口

Midjourney API 定价说明

以下价格仅供参考，具体价格以Aimage官方为准。

Turbo模式：40积分/次调用

Imagine (include variation): 40积分/次调用

Upscale: 10积分/次调用

八、网站基础配置

支付系统(自行选择)

虎皮椒支付：点击跳转

蓝兔支付：点击跳转

请注意后端控制台设置中请添加你的前端域名（列如：https://chat.nanjiren.online）否则支付会失败

微信登录
登陆微信开放平台，创建一个微信网页应用。

自行填写自己的信息提交申请

应用官网、授权回调域请填写前端域名（列如：chat.nanjiren.online）

申请通过后需要仅限开发者认证，否则每天只能调用20次

九、合作交流

商务合作

td {white-space:nowrap;border:1px solid #dee0e3;font-size:10pt;font-style:normal;font-weight:normal;vertical-align:middle;word-break:normal;word-wrap:normal;}

主邮箱	[email protected]
副邮箱	[email protected]

QQ交流群

微信交流群 ¶

添加好友请备注 aichat ，否则不通过好友申请，添加成功后，自动拉你进入微信交流群。

附录

输入 @ 把正文提及的具体文档，或需求相关的其他说明文档附在此处以供查阅

数据分析报告

此处插入数据分析报告

用户调研报告

此处插入用户调研报告

设计分析报告

此处插入设计分析报告

[完整版]aichat官方文档

项目介绍

一 、项目优势

1、零基础，不会敲代码也可以搭建

2、高度自定义

2.1、网站标题、欢迎词、公告自定义

2.2、套餐玩法自定义

2.3、更多自定义内容

2.4 界面预览

1、聊天

2、登录

3、注册

4、个人中心

5、会员列表

6、次数变动记录/手动添加次数

更多预览请访问演示站

二、技术栈

三、 版本信息

四、 一键部署

社区版一键部署

1、执行部署脚本

2、设置管理前台超管账户

3、完成AIChat社区版部署

4、访问AIChat社区版

专业版一键部署

1、执行部署脚本

2、选择语言

3、配置专业版授权

4、配置专业版License

5、配置管理前台超管账户

6、配置阿里云OSS（可选）

7、确认配置信息

8、完成AIChat专业版部署

9、访问AIChat专业版

AIChat社区版升级为最新AIChat专业版 ¶

1、获取最新账号密码

2、暂停并移除现有的AIChat

3、备份数据库

4、允许http登录

5、登录专业版私有库

6、修改配置文件

7、拉取专业版镜像

8、启动AIChat专业版服务

五、 系统更新

手动更新

1、停止Docker服务

2、备份数据库

3、获取最新配置文件

4、拉取最新镜像

5、运行最新版本的AIChat

六、 定价

AIChat专业版V0.7全套源码

AIChat专业版内测用户资格

客户端打包服务

七、 一站式API服务

AIMHUB全模型平台

Aimage MJ绘画服务

八、网站基础配置

九、合作交流

商务合作

QQ交流群

微信交流群 ¶

附录

一、项目优势

三、版本信息

四、一键部署

五、系统更新

六、定价

七、一站式API服务