feat: vercel deploy support (#31)

* vercel deploy support * clean code * Update readme
KenyonY · May 20, 2023 · 0f489fa · 0f489fa
1 parent 5670bac
commit 0f489fa
Show file tree

Hide file tree

Showing 17 changed files with 216 additions and 146 deletions.
diff --git a/.env b/.env
@@ -1,4 +1,4 @@
-LOG_CHAT=True
+LOG_CHAT=False
 OPENAI_BASE_URL=https://api.openai.com
 OPENAI_API_KEY=
 FORWARD_KEY=

diff --git a/.env.example b/.env.example
@@ -0,0 +1,15 @@
+# LOG_CHAT: 是否Log 对话记录
+LOG_CHAT=True
+
+OPENAI_BASE_URL=https://api.openai.com
+
+# OPENAI_API_KEY：允许输入多个api key 形成轮询池
+OPENAI_API_KEY=sk-xxx1 sk-xxx2 sk-xxx3
+
+# FORWARD_KEY: 当前面的OPENAI_API_KEY被设置，就可以设置这里的FORWARD_KEY，客户端调用时可以使用FORWARD_KEY作为api key
+FORWARD_KEY=fk-xxx1
+
+ROUTE_PREFIX=/openai
+
+IP_WHITELIST=
+IP_BLACKLIST=
diff --git a/.gitignore b/.gitignore
@@ -12,7 +12,6 @@ ssl/
 chat.yaml
 chat_*.yaml
 
-.env.example
 Log/
 Log-caloi-top/
 dist/
@@ -144,3 +143,4 @@ dmypy.json
 
 # Pyre type checker
 .pyre/
+.vercel
diff --git a/.vercelignore b/.vercelignore
@@ -0,0 +1,8 @@
+**/*
+!openai_forward
+!openai_forward/*
+!*.py
+
+!vercel.json
+!requirements.txt
+!.env
diff --git a/Makefile b/Makefile
@@ -39,14 +39,14 @@ twine:
 	@twine upload dist/*
 	@rm -rf dist/*
 
-start-web:
-	@openai_forward node --port=9099 --base_url="https://api.openai.com"
-
 build:
 	docker build --tag $(image) -f docker/Dockerfile .
 
 build-push:
 	docker buildx build --push --platform linux/arm64/v8,linux/amd64 --tag $(image) -f docker/Dockerfile .
 
 pull:
-	 docker pull $(image)
+	 docker pull $(image)
+
+deploy:
+	vercel --prod
diff --git a/README.md b/README.md
@@ -42,40 +42,50 @@ api的服务器上，通过该服务转发OpenAI的请求。即搭建反向代
 
 ---
 
-测试访问：https://caloi.top/openai/v1/chat/completions  
-或者说 https://caloi.top/openai 等价于 https://api.openai.com
+本项目搭建的长期代理地址：
+> https://api.openai-forward.top/v1/chat/completions   
+
+或者说 https://api.openai-forward.top 等价于 https://api.openai.com
 
 ---
 
-# 目录
+## 目录
 
 - [功能](#功能)
+- [部署指南](#部署指南)
 - [应用](#应用)
-- [安装部署](#安装部署)
-- [服务调用](#服务调用)
 - [配置选项](#配置选项)
 - [聊天日志](#聊天日志)
 - [高级配置](#高级配置)
 
-# 功能
+## 功能
 **基础功能**  
 - [x] 支持转发OpenAI所有接口
 - [x] 支持流式响应
 - [x] 支持指定转发路由前缀
 - [x] docker部署
 - [x] pip 安装部署
+- [x] vercel 一键个人免费部署
+  [![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fbeidongjiedeguang%2Fopenai-forward&project-name=openai-forward&repository-name=openai-forward&framework=other)
 
 **高级功能**  
 - [x] 实时记录聊天记录(包括流式响应的聊天内容)
-- [x] 支持默认openai api key(多api key 循环调用)
+- [x] 允许输入多个openai api key 形成轮询池
 - [x] 自定义forward api key 代替 openai api key (见高级配置)
 - [x] 支持请求IP验证(IP白名单与黑名单)
 
-# 应用
+## 部署指南
+
+提供三种部署方式
+1. [vps + pip 安装部署](deploy.md#pip-推荐) (推荐)
+2. [vps + Docker](deploy.md#docker-推荐) (推荐) 
+    > https://api.openai-forward.top 
+3. [一键Vercel部署](deploy.md#vercel-一键部署) 
+   > https://vercel.openai-forward.top 
 
-> 这里以个人使用该项目搭建好的代理服务 https://caloi.top/openai 为例
+## 应用
 
-### [caloi.top](https://caloi.top)
+### [聊天应用](https://chat.beidongjiedeguang.top)
 
 基于开源项目[ChatGPT-Next-Web](https://github.com/Yidadaa/ChatGPT-Next-Web)搭建自己的chatgpt服务  
 替换docker启动命令中的 `BASE_URL`为我们自己搭建的代理服务地址
@@ -84,22 +94,22 @@ api的服务器上，通过该服务转发OpenAI的请求。即搭建反向代
 docker run -d \
     -p 3000:3000 \
     -e OPENAI_API_KEY="sk-******" \
-    -e BASE_URL="caloi.top/openai" \
-    -e CODE="<your password>" \
+    -e BASE_URL="https://api.openai-forward.top" \
+    -e CODE="kunyuan" \
     yidadaa/chatgpt-next-web 
 ``` 
+这里部署了一个，供大家轻度使用:  
+ https://chat.beidongjiedeguang.top , 访问密码: `kunyuan` 
 
-访问 https://caloi.top 。访问密码为 `beidongjiedeguang`
-
-### 在模块中使用
+### 在代码中使用
 
 **JS/TS**
 
 ```diff
   import { Configuration } from "openai";
 
   const configuration = new Configuration({
-+ basePath: "https://caloi.top/openai/v1",
++ basePath: "https://api.openai-forward.top/v1",
   apiKey: "sk-******",
   });
 ```
@@ -108,14 +118,23 @@ docker run -d \
 
 ```diff
   import openai
-+ openai.api_base = "https://caloi.top/openai/v1"
++ openai.api_base = "https://api.openai-forward.top/v1"
   openai.api_key = "sk-******"
 ```
 
-### Image Generation (DALL-E):
+**bash**
+```bash
+curl https://api.openai-forward.top/v1/chat/completions \
+  -H "Content-Type: application/json" \
+  -H "Authorization: Bearer sk-******" \
+  -d '{
+    "model": "gpt-3.5-turbo",
+    "messages": [{"role": "user", "content": "Hello!"}]
+  }'
+```
 
 ```bash
-curl --location 'https://caloi.top/openai/v1/images/generations' \
+curl --location 'https://api.openai-forward.top/v1/images/generations' \
 --header 'Authorization: Bearer sk-******' \
 --header 'Content-Type: application/json' \
 --data '{
@@ -125,80 +144,8 @@ curl --location 'https://caloi.top/openai/v1/images/generations' \
 }'
 ```
 
-# 安装部署
-
-选择一种即可
-
-## pip
-
-**安装**
-
-```bash
-pip install openai-forward
-```
-
-**运行转发服务**  
-可通过`--port`指定端口号，默认为`8000`
-
-```bash
-openai_forward run --port=9999 
-```
-
-服务就搭建完成了，使用方式只需将`https://api.openai.com` 替换为服务所在端口`http://{ip}:{port}` 即可。
-
-当然也可以将 OPENAI_API_KEY 作为环境变量或`--api_key`参数传入作为默认api key， 这样客户端在请求相关路由时可以无需在Header中传入Authorization。
-带默认api key的启动方式：
-
-```bash
-openai_forward run --port=9999 --api_key="sk-******"
-```
-
-注: 如果既存在默认api key又在请求头中传入了api key，则以请求头中的api key会覆盖默认api key.
-
-## Docker (推荐)
-
-```bash
-docker run -d -p 9999:8000 beidongjiedeguang/openai-forward:latest 
-```
-
-将映射宿主机的9999端口，通过`http://{ip}:9999`访问服务。  
-注：同样可以在启动命令中通过-e传入环境变量OPENAI_API_KEY=sk-xxx作为默认api key
-
-## 源码部署
-
-```bash
-git clone https://github.com/beidongjiedeguang/openai-forward.git --depth=1
-cd openai-forward
-```
-
-**Docker**
-
-```bash
-docker-compose up
-```
-
-**pip**
-
-```bash
-pip install -e .
-openai-forward run 
-```
-
-# 服务调用
-
-替换openai的api地址为该服务的地址即可，如：
-
-```bash
-https://api.openai.com/v1/chat/completions
-```
-
-替换为
-
-```bash
-http://{ip}:{port}/v1/chat/completions
-```
 
-# 配置选项
+## 配置选项
 
 **`openai-forward run`参数配置项**
 
@@ -220,7 +167,7 @@ http://{ip}:{port}/v1/chat/completions
 | IP_WHITELIST    | ip白名单, 空格分开                                                     |           无            |
 | IP_BLACKLIST    | ip黑名单, 空格分开                                                     |           无            | 
 
-# 聊天日志
+## 聊天日志
 
 保存路径在当前目录下的`Log/`路径中。  
 聊天日志以 `chat_`开头, 默认每5轮对话写入一次文件    
@@ -236,7 +183,7 @@ http://{ip}:{port}/v1/chat/completions
 ...
 ```
 
-# 高级配置
+## 高级配置
 
 **设置api_key为自己设置的forward key**  
 需要配置 OPENAI_API_KEY 和 FORWARD_KEY, 例如
@@ -250,7 +197,7 @@ FORWARD_KEY=fk-****** # 这里fk-token由我们自己定义
 
 **用例:**
 ```bash
-curl https://caloi.top/openai/v1/chat/completions \
+curl https://api.openai-forward.top/v1/chat/completions \
   -H "Content-Type: application/json" \
   -H "Authorization: Bearer fk-mytoken-abcd" \
   -d '{
@@ -261,7 +208,7 @@ curl https://caloi.top/openai/v1/chat/completions \
 **Python**
 ```diff
   import openai
-+ openai.api_base = "https://caloi.top/openai/v1"
++ openai.api_base = "https://api.openai-forward.top/v1"
 - openai.api_key = "sk-******"
 + openai.api_key = "fk-******"
 ```
@@ -270,17 +217,17 @@ curl https://caloi.top/openai/v1/chat/completions \
 docker run -d \
     -p 3000:3000 \
     -e OPENAI_API_KEY="fk-******" \
-    -e BASE_URL="caloi.top/openai" \
+    -e BASE_URL="https://api.openai-forward.top" \
     -e CODE="<your password>" \
     yidadaa/chatgpt-next-web 
 ``` 
 
-# Backer and Sponsor
+## Backer and Sponsor
 
 <a href="https://www.jetbrains.com/?from=beidongjiedeguang/openai-forward" target="_blank">
 <img src=".github/images/jetbrains.svg" width="100px" height="100px">
 </a>
 
-# License
+## License
 
 Openai-forward is licensed under the [MIT](https://opensource.org/license/mit/) license.