From aa29323a8a10c4fb90e562dc28d8bd4b583d6163 Mon Sep 17 00:00:00 2001 From: RockYang Date: Fri, 17 Nov 2023 18:42:13 +0800 Subject: [PATCH] docs: update docs installation docs url --- README.md | 207 +----------------------------------------------------- 1 file changed, 2 insertions(+), 205 deletions(-) diff --git a/README.md b/README.md index 6b929163..c469d9f4 100644 --- a/README.md +++ b/README.md @@ -129,212 +129,9 @@ ChatGPT 的服务。 * [ ] 会员推广功能 * [ ] 微信支付功能 -## Docker 快速部署 +## 快速部署 -> -鉴于最新不少网友反馈在部署的时候遇到一些问题，大部分问题都是相同的，所以我这边做了一个视频教程 [五分钟部署自己的 ChatGPT 服务](https://www.bilibili.com/video/BV1H14y1B7Qw/)。 -> 习惯看视频教程的朋友可以去看视频教程，视频的语速比较慢，建议 2 倍速观看。 - -V3.0.0 版本以后已经支持使用容器部署了，跳过所有的繁琐的环境准备，一条命令就可以轻松部署上线。 - -### 1. 导入数据库 - -首先我们需要创建一个 MySQL 容器，并导入初始数据库。 - -```shell -cd docker/mysql -# 创建 mysql 容器 -docker-compose up -d -# 导入数据库 -docker exec -i chatgpt-plus-mysql sh -c 'exec mysql -uroot -p12345678' < ../../database/chatgpt_plus-v3.1.8.sql -``` - -如果你本地已经安装了 MySQL 服务，那么你只需手动导入数据库即可。 - -```shell -# 连接数据库 -mysql -u username -p password -# 导入数据库 -source database/chatgpt_plus.sql -``` - -### 2. 修改配置文档 - -修改配置文档 `docker/conf/config.toml` 配置文档，修改代理地址和管理员密码： - -```toml -Listen = "0.0.0.0:5678" -ProxyURL = "" # 如 http://127.0.0.1:7777 -MysqlDns = "root:12345678@tcp(172.22.11.200:3307)/chatgpt_plus?charset=utf8&parseTime=True&loc=Local" -StaticDir = "./static" # 静态资源的目录 -StaticUrl = "/static" # 静态资源访问 URL -AesEncryptKey = "" -WeChatBot = false # 是否启动微信机器人 - -[Session] - SecretKey = "azyehq3ivunjhbntz78isj00i4hz2mt9xtddysfucxakadq4qbfrt0b7q3lnvg80" # 注意：这个是 JWT Token 授权密钥，生产环境请务必更换 - MaxAge = 86400 - -[Manager] - Username = "admin" - Password = "admin123" # 如果是生产环境的话，这里管理员的密码记得修改 - -[Redis] # redis 配置信息 - Host = "localhost" - Port = 6379 - Password = "" - DB = 0 - -[ApiConfig] # 微博热搜，今日头条等函数服务 API 配置，此为第三方插件服务，如需使用请联系作者开通 - ApiURL = "" - AppId = "" - Token = "" - -[SmsConfig] # 阿里云短信服务配置 - AccessKey = "" - AccessSecret = "" - Product = "Dysmsapi" - Domain = "dysmsapi.aliyuncs.com" - -[OSS] # OSS 配置，用于存储 MJ 绘画图片 - Active = "local" # 默认使用本地文件存储引擎 - [OSS.Local] - BasePath = "./static/upload" # 本地文件上传根路径 - BaseURL = "http://localhost:5678/static/upload" # 本地上传文件根 URL 如果是线上，则直接设置为 /static/upload 即可 - [OSS.Minio] - Endpoint = "" # 如 172.22.11.200:9000 - AccessKey = "" # 自己去 Minio 控制台去创建一个 Access Key - AccessSecret = "" - Bucket = "chatgpt-plus" # 替换为你自己创建的 Bucket，注意要给 Bucket 设置公开的读权限，否则会出现图片无法显示。 - UseSSL = false - Domain = "" # 地址必须是能够通过公网访问的，否则会出现图片无法显示。 - [OSS.QiNiu] # 七牛云 OSS 配置 - Zone = "z2" # 区域，z0：华东，z1: 华北，na0：北美，as0：新加坡 - AccessKey = "" - AccessSecret = "" - Bucket = "" - Domain = "" # OSS Bucket 所绑定的域名，如 https://img.r9it.com - -[MjConfig] # MidJourney AI 绘画配置 - Enabled = false # 是否启动 MidJourney 机器人服务 - UserToken = "" # 用户授权 Token - BotToken = "" # Discord 机器人 Token - GuildId = "" # 服务器 ID - ChanelId = "" # 频道 ID - -[SdConfig] - Enabled = false # 是否启动 Stable Diffusion 机器人服务 - ApiURL = "http://172.22.11.200:7860" # stable-diffusion-webui API 地址 - ApiKey = "" # 如果开启了授权，这里需要配置授权的 ApiKey - Txt2ImgJsonPath = "res/text2img.json" # 文生图的 API 请求报文 json 模板，允许自定义请求json报文，因为不同版本的 API 绘图的参数以及 fn_index 会不同。 - -[XXLConfig] # xxl-job 配置，需要你部署 XXL-JOB 定时任务工具，用来定期清理未支付订单和清理过期 VIP，如果你没有启用支付服务，则该服务也无需启动 - Enabled = false # 是否启用 XXL JOB 服务 - ServerAddr = "http://172.22.11.47:8080/xxl-job-admin" # xxl-job-admin 管理地址 - ExecutorIp = "172.22.11.47" # 执行器 IP 地址 - ExecutorPort = "9999" # 执行器服务端口 - AccessToken = "xxl-job-api-token" # 执行器 API 通信 token - RegistryKey = "chatgpt-plus" # 任务注册 key - -[AlipayConfig] - Enabled = false # 启用支付宝支付通道 - SandBox = false # 是否启用沙盒模式 - UserId = "2088721020750581" # 商户ID - AppId = "9021000131658023" # App Id - PrivateKey = "certs/alipay/privateKey.txt" # 应用私钥 - PublicKey = "certs/alipay/appPublicCert.crt" # 应用公钥证书 - AlipayPublicKey = "certs/alipay/alipayPublicCert.crt" # 支付宝公钥证书 - RootCert = "certs/alipay/alipayRootCert.crt" # 支付宝根证书 - NotifyURL = "http://r9it.com:6004/api/payment/alipay/notify" # 支付异步回调地址 -``` - -> 1. 如果你不知道如何获取 Discord 用户 Token 和 Bot Token - 请查参考 [Midjourney｜如何集成到自己的平台](https://zhuanlan.zhihu.com/p/631079476)。 -> 2. `Txt2ImgJsonPath` - 的默认用的是使用最广泛的 [stable-diffusion-webui](https://github.com/AUTOMATIC1111/stable-diffusion-webui) 项目的 - API，如果你用的是其他版本，比如秋叶的懒人包部署的，那么请将对应的 text2img 的参数报文复制放在 `res/text2img.json` - 文件中即可。 - -修改 nginx 配置文档 `docker/conf/nginx/conf.d/chatgpt-plus.conf`，把后端转发的地址改成当前主机的内网 IP 地址。 - -```shell - # 这里配置后端 API 的转发 -location /api/ { - proxy_http_version 1.1; - proxy_connect_timeout 300s; - proxy_read_timeout 300s; - proxy_send_timeout 12s; - proxy_set_header Host $host; - proxy_set_header X-Real-IP $remote_addr; - proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; - proxy_set_header Upgrade $http_upgrade; - proxy_set_header Connection $connection_upgrade; - proxy_pass http://172.28.173.76:6789; # 这里改成后端服务的内网 IP 地址 - -# 静态资源转发 -location /static/ { - proxy_pass http://172.22.11.47:5678; # 这里改成后端服务的内网 IP 地址 -} -} -``` - -### 3. 启动应用 - -先修改 `docker/docker-compose.yaml` 文件中的镜像地址，改成最新的版本： - -```yaml -version: '3' -services: - # 后端 API 镜像 - chatgpt-plus-api: - image: registry.cn-shenzhen.aliyuncs.com/geekmaster/chatgpt-plus-api:v3.1.8 #这里改成最新的 release 版本 - container_name: chatgpt-plus-api - restart: always - environment: - - DEBUG=false - - LOG_LEVEL=info - - CONFIG_FILE=config.toml - ports: - - "5678:5678" - volumes: - - /usr/share/zoneinfo/Asia/Shanghai:/etc/localtime - - ./conf/config.toml:/var/www/app/config.toml - - ./logs:/var/www/app/logs - - ./static:/var/www/app/static - - # 前端应用镜像 - chatgpt-plus-web: - image: registry.cn-shenzhen.aliyuncs.com/geekmaster/chatgpt-plus-web:v3.1.8 #这里改成最新的 release 版本 - container_name: chatgpt-plus-web - restart: always - ports: - - "8080:8080" # 这边是对外的端口，支持 8080，80和443 - volumes: - - ./logs/nginx:/var/log/nginx - - ./conf/nginx/conf.d:/etc/nginx/conf.d - - ./conf/nginx/nginx.conf:/etc/nginx/nginx.conf - - ./ssl:/etc/nginx/ssl -``` - -```shell -cd docker -docker-compose up -d -``` - -* 前端访问地址：http://localhost:8080/chat -* 后台管理地址：http://localhost:8080/admin -* 移动端地址：http://localhost:8080/mobile - -> 注意：你得访问后台管理系统 http://localhost:8080/admin -> 输入你前面配置文档中设置的管理员用户名和密码登录。 -> 然后进入 `API KEY 管理` 菜单，添加一个 OpenAI 的 API KEY 才可以正常开启 AI 对话。 - -![add API Key](docs/imgs/apikey_add.png) - -最后进入前端聊天页面 [http://localhost:8080/chat](http://localhost:8080/chat) -你可以注册新用户，也可以使用系统默认有个账号：`18575670125/12345678` 登录聊天。 - -祝你使用愉快！！！ +请参考 [ChatGPT-Plus 部署文档](https://ai.r9it.com/docs/)。 ## 本地开发调试