qianchen94 / feishu-openai Goto Github PK

git clone [email protected]:Leizhenpeng/feishu-chatgpt.git
cd feishu-chatgpt/code

如果你的服务器没有公网 IP，可以使用反向代理的方式

飞书的服务器在国内对 ngrok 的访问速度很慢，所以推荐使用一些国内的反向代理服务商

• cpolar
• natapp

# 配置config.yaml
mv config.example.yaml config.yaml

//测试部署
go run main.go
cpolar http 9000

//正式部署
nohup cpolar http 9000 -log=stdout &

//查看服务器状态
https://dashboard.cpolar.com/status

// 下线服务
ps -ef | grep cpolar
kill -9 PID

更多详细介绍，参考飞书上的小计算器: Go 机器人来啦

git clone [email protected]:Leizhenpeng/feishu-chatgpt.git
cd feishu-chatgpt/code

安装severless工具

# 配置config.yaml
mv config.example.yaml config.yaml
# 安装severless cli
npm install @serverless-devs/s -g

安装完成后，请根据您本地环境，根据下面教程部署severless

• 本地 linux/mac os 环境

1. 修改s.yaml中的部署地区和部署秘钥

edition: 1.0.0
name: feishuBot-chatGpt
access: "aliyun" #  修改自定义的秘钥别称

vars: # 全局变量
region: "cn-hongkong" # 修改云函数想要部署地区

2. 一键部署

cd ..
s deploy

• 本地windows

1. 首先打开本地cmd命令提示符工具，运行go env检查你电脑上 go 环境变量设置, 确认以下变量和值

set GO111MODULE=on
set GOARCH=amd64
set GOOS=linux
set CGO_ENABLED=0

如果值不正确，比如您电脑上为set GOOS=windows, 请运行以下命令设置GOOS变量值

go env -w GOOS=linux

2. 修改s.yaml中的部署地区和部署秘钥

edition: 1.0.0
name: feishuBot-chatGpt
access: "aliyun" #  修改自定义的秘钥别称

vars: # 全局变量
  region: "cn-hongkong" #  修改云函数想要部署地区

3. 修改s.yaml中的pre-deploy, 去除第二步run前面的环变量改置部分

  pre-deploy:
        - run: go mod tidy
          path: ./code
        - run: go build -o
            target/main main.go  # 删除GO111MODULE=on GOOS=linux GOARCH=amd64 CGO_ENABLED=0
          path: ./code

4. 一键部署

cd ..
s deploy

更多详细介绍，参考仅需 1min，用 Serverless 部署基于 gin 的飞书机器人

Railway 是一家国外的 Serverless 平台，支持多种语言，可以一键将 GitHub 上的代码仓库部署到 Railway 平台，然后在 Railway 平台上配置环境变量即可。部署本项目的流程如下：

点击下方按钮即可创建一个对应的 Railway 项目，其会自动 Fork 本项目到你的 GitHub 账号下。

在打开的页面中，配置环境变量，每个变量的说明如下图所示：

填写完环境变量后，点击 Deploy 就完成了项目的部署。部署完成后还需获取对应的域名用于飞书机器人访问，如下图所示：

如果不确定自己部署是否成功，可以通过访问上述获取到的域名 (https://xxxxxxxx.railway.app/ping) 来查看是否返回了pong ，如果返回了pong，说明部署成功。

The fastest way to deploy the feishu-openai to repl.it is to click the run on repl.it button below.

Remember switch to secrets tab then edit System environment variables.You can also edit raw json:

{
  "APP_ID": "",
  "APP_SECRET": "",
  "APP_ENCRYPT_KEY": "",
  "APP_VERIFICATION_TOKEN": "",
  "BOT_NAME": "ChatGPT",
  "OPENAI_KEY": "sk-",
  "OPENAI_MODEL": "gpt-3.5-turbo"
}

docker build -t feishu-chatgpt:latest .
docker run -d --name feishu-chatgpt -p 9000:9000 \
--env APP_ID=xxx \
--env APP_SECRET=xxx \
--env APP_ENCRYPT_KEY=xxx \
--env APP_VERIFICATION_TOKEN=xxx \
--env BOT_NAME=chatGpt \
--env OPENAI_KEY="sk-xxx1,sk-xxx2,sk-xxx3" \
--env API_URL="https://api.openai.com" \
--env HTTP_PROXY="" \
feishu-chatgpt:latest

注意:

• BOT_NAME 为飞书机器人名称，例如 chatGpt
• OPENAI_KEY 为openai key，多个key用逗号分隔，例如 sk-xxx1,sk-xxx2,sk-xxx3
• HTTP_PROXY 为宿主机的proxy地址，例如 http://host.docker.internal:7890,没有代理的话，可以不用设置
• API_URL 为openai api 接口地址，例如 https://api.openai.com, 没有反向代理的话，可以不用设置

小白简易化 docker 部署

• docker 地址: https://hub.docker.com/r/leizhenpeng/feishu-chatgpt

docker run -d --restart=always --name feishu-chatgpt2 -p 9000:9000 -v /etc/localtime:/etc/localtim:ro  \
--env APP_ID=xxx \
--env APP_SECRET=xxx \
--env APP_ENCRYPT_KEY=xxx \
--env APP_VERIFICATION_TOKEN=xxx \
--env BOT_NAME=chatGpt \
--env OPENAI_KEY="sk-xxx1,sk-xxx2,sk-xxx3" \
--env API_URL=https://api.openai.com \
--env HTTP_PROXY="" \
dockerproxy.com/leizhenpeng/feishu-chatgpt:latest

事件回调地址: http://IP:9000/webhook/event 卡片回调地址: http://IP:9000/webhook/card

把它填入飞书后台

部署azure版本

docker build -t feishu-chatgpt:latest .
docker run -d --name feishu-chatgpt -p 9000:9000 \
--env APP_ID=xxx \
--env APP_SECRET=xxx \
--env APP_ENCRYPT_KEY=xxx \
--env APP_VERIFICATION_TOKEN=xxx \
--env BOT_NAME=chatGpt \
--env AZURE_ON=true \
--env AZURE_API_VERSION=xxx \
--env AZURE_RESOURCE_NAME=xxx \
--env AZURE_DEPLOYMENT_NAME=xxx \
--env AZURE_OPENAI_TOKEN=xxx \
feishu-chatgpt:latest

注意:

• BOT_NAME 为飞书机器人名称，例如 chatGpt
• AZURE_ON 为是否使用azure ,请填写 true
• AZURE_API_VERSION 为azure api版本 例如 2023-03-15-preview
• AZURE_RESOURCE_NAME 为azure 资源名称 类似 https://{AZURE_RESOURCE_NAME}.openai.azure.com
• AZURE_DEPLOYMENT_NAME 为azure 部署名称 类似 https://{AZURE_RESOURCE_NAME}.openai.azure.com/deployments/{AZURE_DEPLOYMENT_NAME}/chat/completions
• AZURE_OPENAI_TOKEN 为azure openai token

编辑 docker-compose.yaml，通过 environment 配置相应环境变量（或者通过 volumes 挂载相应配置文件），然后运行下面的命令即可

# 构建镜像
docker compose build

# 启动服务
docker compose up -d

# 停止服务
docker compose down

事件回调地址: http://IP:9000/webhook/event 卡片回调地址: http://IP:9000/webhook/card

1. 进入release 页面 下载对应的安装包
2. 解压安装包,修改 config.example.yml 中配置信息,另存为 config.yaml
3. 目录下添加文件 role_list.yaml，自定义角色，可以从这里获取：链接
4. 运行程序入口文件 feishu-chatgpt

事件回调地址: http://IP:9000/webhook/event 卡片回调地址: http://IP:9000/webhook/card