Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
KenyonY committed Mar 29, 2023
1 parent c458c3d commit 844b484
Showing 1 changed file with 15 additions and 6 deletions.
21 changes: 15 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Openai forwarding agent
# OpenAI forwarding agent
## 简介
openai 接口转发服务.
用途:
解决国内无法直接访问openai的问题,将该服务部署在海外服务器上,通过该服务转发openai的请求。即搭建反向代理服务
解决国内无法直接访问OpenAI的问题,将该服务部署在海外服务器上,通过该服务转发OpenAI的请求。即搭建反向代理服务

### 已实现转发的接口
`https://api.openai.com`
Expand All @@ -12,17 +12,20 @@ openai 接口转发服务.


## 服务部署
### 方式一: 使用 pip
**Install**
提供两种服务部署方式,选择一种即可

### 方式一: pip
**安装**
```bash
pip install openai-forward
```
**Run**
**运行转发服务**
可通过`--port`指定端口号,默认为`8000`,可通过`--workers`指定工作进程数,默认为`1`
```bash
openai_forward run --port 8000 --worders=1
```

### 方式二: 使用Docker compose
### 方式二: Docker compose
下载项目根目录下的`docker-compose.yaml`文件,然后在文件路径下执行以下命令即可。
```bash
docker-compose up -d
Expand All @@ -42,3 +45,9 @@ http://{ip}:{port}/v1/chat/completions
http://2.56.125.247:9999/v1/chat/completions
http://2.56.125.247:9999/dashboard/billing/credit_grants

## 应用
例如可以在项目 [chatgpt-web](https://github.com/Chanzhaoyu/chatgpt-web) 中使用该服务
以其 [Docker Compose](https://github.com/Chanzhaoyu/chatgpt-web#docker-compose) 启动方式为例,只需修改其中的`OPENAI_API_BASE_URL`为我们搭建的代理服务地址即可:
```bash
OPENAI_API_BASE_URL: http://2.56.125.247:9999
```

0 comments on commit 844b484

Please sign in to comment.