diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 6967fd8..7b6d3cc 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -42,7 +42,7 @@ jobs: env: GITHUB_TOKEN: ${{ secrets.GHCR_PAT }} with: - tag_name: v2.0.6 + tag_name: v2.0.7 files: | duck2api-linux-amd64.tar.gz duck2api-windows-amd64.tar.gz diff --git a/README copy.md b/README copy.md deleted file mode 100644 index 7a6931c..0000000 --- a/README copy.md +++ /dev/null @@ -1,118 +0,0 @@ -# AURORA - -[README_EN](https://github.com/aurora-develop/aurora/blob/main/README_EN.md) - -(带UI)免费的GPT3.5,支持使用3.5的access 调用 - -# 交流群 -https://t.me/aurora_develop - -# Web端 - -访问http://你的服务器ip:8080/web - -![web使用](https://jsd.cdn.zzko.cn/gh/xiaozhou26/tuph@main/images/%E5%B1%8F%E5%B9%95%E6%88%AA%E5%9B%BE%202024-04-07%20111706.png) - - -### 注:仅ip属地支持免登录使用ChatGpt可以使用(也可以自定义Baseurl来绕过限制) - -## Deploy - -### Glitch部署 - -[![Deploy to Glitch](https://cdn.glitch.com/2703baf2-b643-4da7-ab91-7ee2a2d00b5b%2Fremix-button.svg)](https://github.com/aurora-develop/aurora-glitch) - -### Vercel部署 - -由于vercel的go不支持流式,如果在vercel部署请在STREAM_MODE中填False,不支持任何默认流式的客户端,支持沉浸式翻译。 - -[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Faurora-develop%2Faurora&env=STREAM_MODE&project-name=aurora&repository-name=aurora) - -### Render部署 -[![Deploy](https://render.com/images/deploy-to-render-button.svg)](https://render.com/deploy) - -### Koyeb部署 -地区选美国 - -[![Deploy to Koyeb](https://www.koyeb.com/static/images/deploy/button.svg)](https://app.koyeb.com/deploy?type=docker&name=aurora&ports=8080;http;/&image=ghcr.io/aurora-develop/aurora) - -### Railway部署 -[![Deploy on Railway](https://railway.app/button.svg)](https://railway.app/template/jcl2Es?referralCode=XXqY_5) - -### Zeabur部署 -进入修改镜像名称aurora+任何字母数字 - -[![Deploy on Zeabur](https://zeabur.com/button.svg)](https://zeabur.com/templates/JF3EFW) - -### 编译部署 - -```bash -git clone https://github.com/aurora-develop/aurora -cd aurora -go build -o aurora -chmod +x ./aurora -./aurora -``` - -### Docker部署 -## Docker部署 -您需要安装Docker和Docker Compose。 - -```bash -docker run -d \ - --name aurora \ - -p 8080:8080 \ - ghcr.io/aurora-develop/aurora:latest -``` - -## Docker Compose部署 -创建一个新的目录,例如aurora-app,并进入该目录: -```bash -mkdir aurora -cd aurora -``` -在此目录中下载库中的docker-compose.yml文件: - -```bash -docker-compose up -d -``` - -## Usage - -```bash -curl --location 'http://你的服务器ip:8080/v1/chat/completions' \ ---header 'Content-Type: application/json' \ ---data '{ - "model": "gpt-3.5-turbo", - "messages": [{"role": "user", "content": "Say this is a test!"}], - "stream": true - }' -``` - -## 高级设置 - -默认情况不需要设置,除非你有需求 - -### 环境变量 -``` - -BASE_URL="https://chat.openai.com/backend-api" 代理网关 -Authorization=your_authorization 用户认证 key。 -TLS_CERT=path_to_your_tls_cert 存储TLS(传输层安全协议)证书的路径。 -TLS_KEY=path_to_your_tls_key 存储TLS(传输层安全协议)证书的路径。 -PROXY_URL=your_proxy_url 添加代理池来。 -``` - -## 鸣谢 - -感谢各位大佬的pr支持,感谢。 - - -## 参考项目 - - -https://github.com/xqdoo00o/ChatGPT-to-API - -## License - -MIT License diff --git a/README.md b/README.md index 3098e96..59260d1 100644 --- a/README.md +++ b/README.md @@ -1 +1,87 @@ -# duck2api \ No newline at end of file +# duck2api + + + +# 交流群 +https://t.me/duck2api_develop + +# Web端 + +访问http://你的服务器ip:8080/web + +![web使用](https://jsd.cdn.zzko.cn/gh/xiaozhou26/tuph@main/images/%E5%B1%8F%E5%B9%95%E6%88%AA%E5%9B%BE%202024-04-07%20111706.png) + + + +### 编译部署 + +```bash +git clone https://github.com/aurora-develop/duck2api +cd duck2api +go build -o duck2api +chmod +x ./duck2api +./duck2api +``` + +### Docker部署 +## Docker部署 +您需要安装Docker和Docker Compose。 + +```bash +docker run -d \ + --name duck2api \ + -p 8080:8080 \ + ghcr.io/aurora-develop/duck2api:latest +``` + +## Docker Compose部署 +创建一个新的目录,例如duck2api,并进入该目录: +```bash +mkdir duck2api +cd duck2api +``` +在此目录中下载库中的docker-compose.yml文件: + +```bash +docker-compose up -d +``` + +## Usage + +```bash +curl --location 'http://你的服务器ip:8080/v1/chat/completions' \ +--header 'Content-Type: application/json' \ +--data '{ + "model": "gpt-3.5-turbo", + "messages": [{"role": "user", "content": "Say this is a test!"}], + "stream": true + }' +``` + +## 高级设置 + +默认情况不需要设置,除非你有需求 + +### 环境变量 +``` + +BASE_URL="https://chat.openai.com/backend-api" 代理网关 +Authorization=your_authorization 用户认证 key。 +TLS_CERT=path_to_your_tls_cert 存储TLS(传输层安全协议)证书的路径。 +TLS_KEY=path_to_your_tls_key 存储TLS(传输层安全协议)证书的路径。 +PROXY_URL=your_proxy_url 添加代理池来。 +``` + +## 鸣谢 + +感谢各位大佬的pr支持,感谢。 + + +## 参考项目 + + +https://github.com/xqdoo00o/ChatGPT-to-API + +## License + +MIT License diff --git a/README_EN.md b/README_EN.md deleted file mode 100644 index 5d0e5ea..0000000 --- a/README_EN.md +++ /dev/null @@ -1,104 +0,0 @@ -# AURORA - -(Free GPT-3.5 with UI) Supports the use of GPT-3.5 through access calls. - -# Communication Group -https://t.me/aurora_develop - -# Web Interface -Access http://your-server-ip:8080/web and fill in the server's http://your-server-ip:8080 on the web settings page. -![web usage](https://jsd.cdn.zzko.cn/gh/xiaozhou26/tuph@main/images/2024-04-07%20112100.png) - -### Note: Only users in IP regions that support login-free use of ChatGpt can use this (it's also possible to bypass restrictions by customizing Baseurl). - -## Deployment - -### Deployment on Vercel -Since Vercel does not support streaming, if deploying on Vercel, please fill in False in STREAM_MODE. It does not support any default streaming client but supports immersive translation. - -[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Faurora-develop%2Faurora&env=STREAM_MODE&project-name=aurora&repository-name=aurora) - -### Deployment on Render -[![Deploy](https://render.com/images/deploy-to-render-button.svg)](https://render.com/deploy) - -### Deployment on Koyeb -Choose United States as the region. - -[![Deploy to Koyeb](https://www.koyeb.com/static/images/deploy/button.svg)](https://app.koyeb.com/deploy?type=docker&name=aurora&ports=8080;http;/&image=ghcr.io/aurora-develop/aurora) - -### Deployment on Railway -[![Deploy on Railway](https://railway.app/button.svg)](https://railway.app/template/jcl2Es?referralCode=XXqY_5) - -### Deployment on Zeabur -Go in and change the image name to aurora plus any letter or number. - -[![Deploy on Zeabur](https://zeabur.com/button.svg)](https://zeabur.com/templates/JF3EFW) - -### Compilation Deployment - -```bash -git clone https://github.com/aurora-develop/aurora -cd aurora -go build -o aurora -chmod +x ./aurora -./aurora -``` - -### Docker Deployment -You need to install Docker and Docker Compose. - -```bash -docker run -d \ - --name aurora \ - -p 8080:8080 \ - ghcr.io/aurora-develop/aurora:latest -``` - -## Docker Compose Deployment -Create a new directory, for example, aurora-app, and enter that directory: -```bash -mkdir aurora -cd aurora -``` -In this directory, download the docker-compose.yml file from the repository: - -```bash -docker-compose up -d -``` - -## Usage - -```bash -curl --location 'http://your-server-ip:8080/v1/chat/completions' \ ---header 'Content-Type: application/json' \ ---data '{ - "model": "gpt-3.5-turbo", - "messages": [{"role": "user", "content": "Say this is a test!"}], - "stream": true - }' -``` - -## Advanced Settings - -Default settings do not need to be changed unless you have specific needs. - -### Environment Variables -``` -BASE_URL="https://auroraxf.glitch.me/api" Proxy gateway. -Authorization=your_authorization User authentication key. -TLS_CERT=path_to_your_tls_cert Path to your TLS (Transport Layer Security) certificate. -TLS_KEY=path_to_your_tls_key Path to your TLS (Transport Layer Security) key. -PROXY_URL=your_proxy_url Add a proxy pool. -``` - -## Acknowledgements - -Thanks to all the great developers for their PR support, thank you. - -## Reference Projects - -https://github.com/xqdoo00o/ChatGPT-to-API - -## License - -MIT License