Feat: Bump to Versionv0.1.0 (#4)

* Add docker publish workflow * Add python package workflow * Add `ChatSaver` module * Update README
KenyonY · Apr 22, 2023 · e66c0de · e66c0de
1 parent e007a49
commit e66c0de
Show file tree

Hide file tree

Showing 18 changed files with 516 additions and 357 deletions.
diff --git a/.github/workflows/docker-publish.yml b/.github/workflows/docker-publish.yml
@@ -0,0 +1,52 @@
+name: Publish Docker image
+
+on:
+  workflow_dispatch:
+  release:
+    types: [published]
+
+jobs:
+  push_to_registry:
+    name: Push Docker image to Docker Hub
+    runs-on: ubuntu-latest
+    steps:
+      -
+        name: Check out the repo
+        uses: actions/checkout@v3
+      -
+        name: Log in to Docker Hub
+        uses: docker/login-action@v2
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_PASSWORD }}
+
+      -
+        name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/metadata-action@v4
+        with:
+          images: beidongjiedeguang/openai-forward
+          tags: |
+            type=raw,value=latest
+            type=ref,event=tag
+
+      -
+        name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
+
+      -
+        name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+
+      -
+        name: Build and push Docker image
+        uses: docker/build-push-action@v4
+        with:
+          context: .
+          file: ./docker/Dockerfile
+          platforms: linux/amd64,linux/arm64
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          cache-from: type=gha
+          cache-to: type=gha,mode=max
diff --git a/.github/workflows/gh-release.yml b/.github/workflows/gh-release.yml
@@ -28,8 +28,6 @@ jobs:
           tag_name: ${{ github.ref }}
           release_name: Release ${{ github.ref }}
           body: |
-            Changes in this Release
-            - First Change
-            - Second Change
-          draft: true
+            See ChangeLog
+          draft: false
           prerelease: false
diff --git a/.github/workflows/python-publish.yml b/.github/workflows/python-publish.yml
@@ -11,7 +11,7 @@ jobs:
     steps:
     - uses: actions/checkout@v3
     - name: Set up Python
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v4
       with:
         python-version: '3.10'
     - name: Install dependencies

diff --git a/.github/workflows/run_tests.yml b/.github/workflows/run_tests.yml
@@ -5,7 +5,6 @@ on:
     branches:
       - dev
       - main
-      - update-workflow
   pull_request:
     branches:
       - dev

diff --git a/.gitignore b/.gitignore
@@ -6,6 +6,7 @@ ssl/
 chat.yaml
 chat_*.yaml
 
+.env.example
 Log/
 dist/
 # Byte-compiled / optimized / DLL files

diff --git a/Makefile b/Makefile
@@ -1,20 +1,25 @@
 .PHONY: start build push run down test twine
 
+image := "beidongjiedeguang/openai-forward:latest"
+container := "openai-forward-container"
+compose_path := "docker-compose.yaml"
 
-container = "openai-forward-container"
 start:
-	docker run --name=$(container) -p 8000:8000 $(image)
+	docker run -d \
+    --name $(container) \
+    --env "LETSENCRYPT_HOST=caloi.top,www.caloi.top" \
+    --env "VIRTUAL_HOST=caloi.top,www.caloi.top" \
+    --env "VIRTUAL_PORT=8000" \
+    --env "LOG_CHAT=true" \
+    --env "OPENAI_API_KEY=" \
+    $(image)
+
+log:
+	docker logs -f $(container)
+
 rm:
 	docker rm -f $(container)
 
-image = "beidongjiedeguang/openai-forward:latest"
-build:
-	@docker build -t $(image) -f docker/Dockerfile .
-
-push:
-	@docker push $(image)
-
-compose_path = "docker-compose.yaml"
 up:
 	@docker-compose  -f $(compose_path) up -d
 
@@ -39,5 +44,8 @@ build-web:
 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 .
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-**中文** | [**English**](./README_EN.md)
+[**中文**](./README_ZH.md) | **English**
 
 <h1 align="center">
     <br>
@@ -10,19 +10,8 @@
     The fastest way to deploy openai api forward proxy </b>
 </p>
 
-[//]: # (    <a href="https://github.com/beidongjiedeguang">)
-[//]: # (        <img alt="name" src="https://img.shields.io/badge/author-@kunyuan-orange.svg?style=flat-square&logo=appveyor">)
-[//]: # (    </a>)
-[//]: # (    <a href="https://github.com/beidongjiedeguang/openai-forward/stargazers">)
-[//]: # (        <img alt="starts" src=https://img.shields.io/github/stars/beidongjiedeguang/openai-forward?style=social>)
-[//]: # (    </a>)
-[//]: # ([![Downloads]&#40;https://static.pepy.tech/badge/openai-forward/month&#41;]&#40;https://pepy.tech/project/openai-forward&#41;)
-[//]: # (    <a href="https://codecov.io/gh/beidongjiedeguang/openai-forward">)
-[//]: # (        <img alt="codecov" src="https://codecov.io/gh/beidongjiedeguang/openai-forward/branch/dev/graph/badge.svg">)
-[//]: # (    </a>)
-
 <p align="center">
-<a href="https://badge.fury.io/py/openai-forward"><img src="https://badge.fury.io/py/openai-forward.svg" alt="PyPI version" ></a>
+    <a href="https://pypi.org/project/openai-forward/"><img src="https://img.shields.io/pypi/v/openai-forward?color=brightgreen" alt="PyPI version" ></a>
     <a href="https://github.com/beidongjiedeguang/openai-forward/blob/main/LICENSE">
         <img alt="License" src="https://img.shields.io/github/license/beidongjiedeguang/openai-forward.svg?color=blue&style=flat-square">
     </a>
@@ -32,8 +21,8 @@
     <a href="https://github.com/beidongjiedeguang/openai-forward">
         <img alt="GitHub repo size" src="https://img.shields.io/github/repo-size/beidongjiedeguang/openai-forward">
     </a>
-    <a href="https://github.com/beidongjiedeguang/openai-forward/">
-        <img alt="GitHub top language" src="https://img.shields.io/github/languages/top/beidongjiedeguang/openai-forward">
+    <a href="https://hub.docker.com/r/beidongjiedeguang/openai-forward">
+        <img alt="docer image size" src="https://img.shields.io/docker/image-size/beidongjiedeguang/openai-forward?style=flat&label=docker image">
     </a>
     <a href="https://github.com/beidongjiedeguang/openai-forward/actions/workflows/run_tests.yaml">
         <img alt="tests" src="https://img.shields.io/github/actions/workflow/status/beidongjiedeguang/openai-forward/run_tests.yml?label=tests">
@@ -43,113 +32,108 @@
     </a>
 
 </p>
+This project is designed to solve the problem of some regions being unable to directly access OpenAI. The service is deployed on a server that can access the OpenAI API, and OpenAI requests are forwarded through the service, i.e. a reverse proxy service is set up. 
 
+Test access: https://caloi.top/v1/chat/completions is equivalent to https://api.openai.com/v1/chat/completions 
 
+# Table of Contents 
 
-本项目用于解决一些地区无法直接访问OpenAI的问题，将该服务部署在可以正常访问openai api的服务器上，通过该服务转发OpenAI的请求。即搭建反向代理服务  
-测试访问：https://caloi.top/v1/chat/completions 将等价于 https://api.openai.com/v1/chat/completions
-
-# Table of Contents
+- [Features](#Features) 
+- [Usage](#Usage) 
+- [Service Deployment](#Service-Deployment) 
+- [Service Usage](#Service Usage) 
 
-- [Features](#Features)
-- [Usage](#Usage)
-- [服务部署](#安装部署)
-- [服务调用](#服务调用)
+# Features 
+- [x] Supports forwarding of all OpenAI interfaces 
+- [x] Supports request IP verification 
+- [x] Supports streaming forwarding 
+- [x] Supports default API key 
+- [x] pip installation and deployment 
+- [x] Docker deployment 
+- [ ] Chat content security: Chat content streaming filtering 
 
-
-# Features
-- [x] 支持转发OpenAI所有接口
-- [x] 请求IP验证
-- [x] 支持流式转发
-- [x] 支持默认api key
-- [x] pip安装
-- [x] docker部署
-- [x] 自定义转发端口
-- [ ] 自定义转发路由
-- [ ] 聊天内容安全：聊天内容流式过滤
-
-# Usage
-> 这里以个人搭建好的代理地址 https://caloi.top 为例
- 
-### [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: https://caloi.top 
-```
-
-### [ChatGPT-Next-Web](https://github.com/Yidadaa/ChatGPT-Next-Web)
-替换docker启动命令中的 `BASE_URL`为我们搭建的代理服务地址
-```bash
-docker run -d -p 3000:3000 -e OPENAI_API_KEY="sk-xxx" -e CODE="<your password>" -e BASE_URL="caloi.top" yidadaa/chatgpt-next-web
-```
+# Usage 
+> Here, the proxy address set up by the individual, https://caloi.top, is used as an example 
 
 ### Image Generation (DALL-E):
-```bash
-curl --location 'https://caloi.top/v1/images/generations' \
---header 'Authorization: Bearer sk-***[OUR_API_KEY]***' \
---header 'Content-Type: application/json' \
---data '{
-    "prompt": "A photo of a cat",
-    "n": 1,
-    "size": "512x512",
-}'
-```
-
-### 在模块中使用
-
-**Used in JS/TS**
-```typescript
-import { Configuration } from "openai";
-
-const configuration = new Configuration({
-    basePath: "https://caloi.top",
-    apiKey: "sk-******",
-
-});
-```
-**Used in Python**  
-```python
-import openai
-openai.api_base = "https://caloi.top"
-openai.api_key = "sk-******"
-```
-
-# 服务部署
-提供两种服务部署方式,选择一种即可
-
-## 方式一:  pip
-**安装**
-```bash
-pip install openai-forward
-```
-**运行转发服务**  
-可通过`--port`指定端口号，默认为`8000`，可通过`--workers`指定工作进程数，默认为`1`
-```bash
-openai_forward run --port=9999 --workers=1
-```
-服务就搭建完成了，使用方式只需将`https://api.openai.com` 替换为服务所在端口`http://{ip}:{port}` 即可。  
-
-当然也可以将 OPENAI_API_KEY 作为环境变量传入作为默认api key， 这样客户端在请求相关路由时可以无需在Header中传入Authorization。
-带默认api key的启动方式：
-```bash
-OPENAI_API_KEY="sk-xxx" openai_forward run --port=9999 --workers=1
-```
-注: 如果既存在默认api key又在请求头中传入了api key，则以请求头中的api key会覆盖默认api key.
-
-
-## 方式二: Docker(推荐) 
-```bash
+```bash 
+curl --location 'https://caloi.top/v1/images/generations' \ 
+--header 'Authorization: Bearer sk-******' \ 
+--header 'Content-Type: application/json' \ 
+--data '{ 
+    "prompt": "A photo of a cat", 
+    "n": 1, 
+    "size": "512x512"
+}' 
+``` 
+
+### [chatgpt-web](https://github.com/Chanzhaoyu/chatgpt-web) 
+Modify the `OPENAI_API_BASE_URL` in [Docker Compose](https://github.com/Chanzhaoyu/chatgpt-web#docker-compose) to the address of the proxy service we set up: 
+```bash 
+OPENAI_API_BASE_URL: https://caloi.top 
+``` 
+
+### [ChatGPT-Next-Web](https://github.com/Yidadaa/ChatGPT-Next-Web) 
+Replace `BASE_URL` in the docker startup command with the address of the proxy service we set up: 
+```bash 
+docker run -d -p 3000:3000 -e OPENAI_API_KEY="sk-******" -e CODE="<your password>" -e BASE_URL="caloi.top" yidadaa/chatgpt-next-web 
+``` 
+
+
+### Using in a module 
+
+**Used in JS/TS** 
+```typescript 
+import { Configuration } from "openai"; 
+
+const configuration = new Configuration({ 
+    basePath: "https://caloi.top", 
+    apiKey: "sk-******", 
+
+}); 
+``` 
+**Used in Python** 
+```python 
+import openai 
+openai.api_base = "https://caloi.top" 
+openai.api_key = "sk-******" 
+``` 
+
+# Service Deployment 
+Two service deployment methods are provided, choose one 
+
+## Method 1: pip 
+**Installation** 
+```bash 
+pip install openai-forward 
+``` 
+**Run forwarding service** 
+The port number can be specified through `--port`, which defaults to `8000`, and the number of worker processes can be specified through `--workers`, which defaults to `1`. 
+```bash 
+openai_forward run --port=9999 --workers=1 
+``` 
+The service is now set up, and the usage is to replace `https://api.openai.com` with the port number of the service `http://{ip}:{port}`. 
+
+Of course, OPENAI_API_KEY can also be passed in as an environment variable as the default API key, so that the client does not need to pass in the Authorization in the header when requesting the relevant route. 
+Startup command with default API key: 
+```bash 
+OPENAI_API_KEY="sk-xxx" openai_forward run --port=9999 --workers=1 
+``` 
+Note: If both the default API key and the API key passed in the request header exist, the API key in the request header will override the default API key. 
+
+## Method 2: Docker (recommended) 
+```bash 
 docker run --name="openai-forward" -d -p 9999:8000 beidongjiedeguang/openai-forward:latest 
-```
-将映射宿主机的9999端口，通过`http://{ip}:9999`访问服务。  
-注：同样可以在启动命令中通过-e传入环境变量OPENAI_API_KEY=sk-xxx作为默认api key
-
-# 服务调用
-替换openai的api地址为该服务的地址即可，如：
-```bash
-https://api.openai.com/v1/chat/completions
-```
-替换为
-```bash
-http://{ip}:{port}/v1/chat/completions
+``` 
+The 9999 port of the host is mapped, and the service can be accessed through `http://{ip}:9999`. 
+Note: You can also pass in the environment variable OPENAI_API_KEY=sk-xxx as the default API key in the startup command. 
+
+# Service Usage 
+Simply replace the OpenAI API address with the address of the service we set up, such as: 
+```bash 
+https://api.openai.com/v1/chat/completions 
+``` 
+Replace with 
+```bash 
+http://{ip}:{port}/v1/chat/completions 
 ```