# opengpt **Repository Path**: gngpp/opengpt ## Basic Information - **Project Name**: opengpt - **Description**: Not just a unofficial ChatGPT proxy (bypass Cloudflare 403 Access Denied) - **Primary Language**: Rust - **License**: MIT - **Default Branch**: main - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2023-07-09 - **Last Updated**: 2023-09-08 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README
简体中文 | [English](README.md) [![CI](https://github.com/gngpp/opengpt/actions/workflows/CI.yml/badge.svg)](https://github.com/gngpp/opengpt/actions/workflows/CI.yml) [![CI](https://github.com/gngpp/opengpt/actions/workflows/Release.yml/badge.svg)](https://github.com/gngpp/opengpt/actions/workflows/Release.yml) [![](https://img.shields.io/docker/image-size/gngpp/opengpt)](https://registry.hub.docker.com/r/gngpp/opengpt) [![Docker Image](https://img.shields.io/docker/pulls/gngpp/opengpt.svg)](https://hub.docker.com/r/gngpp/opengpt/) # opengpt 一个逆向工程的非官方的 `ChatGPT` 代理（绕过 Cloudflare 403 Access Denied） ### 功能 - API密钥获取 - 电子邮件/密码帐户认证 (由于作者没有账号，暂不支持Google/微软第三方登录) - `Unofficial`/`Official`/`ChatGPT-to-API` Http API 代理 (供第三方客户端接入) - 原汁原味的ChatGPT WebUI - 极少的内存占用 > 局限性: 无法绕过 OpenAI 的彻底 IP 禁令 ### ArkoseLabs 发送`GPT4`对话需要`Arkose Token`作为参数发送，支持的解决方案暂时只有三种 1) `Arkose Token` 获取的端点，不管你用什么方式，使用 `--arkose-token-endpoint` 指定端点获取token，支持的`JSON`格式，一般按照社区的格式：`{"token":"xxxxxx"}` 2) `ChatGPT` 官网发送一次 `GPT4` 会话消息，浏览器 `F12` 下载 `https://tcr9i.chat.openai.com/fc/gt2/public_key/35536E1E-65B4-4D96-9D97-6ADB7EFF8147` 接口的HAR日志记录文件，使用启动参数 `--arkose-har-path` 指定HAR文件路径使用。支持上传更新HAR `请求路径: /har/upload`，HAR文件是必须是存在的，此时才支持上传更新HAR文件，可选上传身份验证参数 `--arkose-har-upload-key` 3) 使用[YesCaptcha](https://yescaptcha.atlassian.net/wiki/spaces/YESCAPTCHA/overview?homepageId=33020)平台进行AI打码，启动参数 `--arkose-yescaptcha-key` 填写Key启用，价格实惠，`10RMB` 按积分提交来计算，`10000/3 ~= 3333 次提交`， 三种方案都使用，优先级是：`HAR` > `Arkose Token 端点` > `YesCaptcha` ### 平台支持 - Linux - `x86_64-unknown-linux-musl` - `aarch64-unknown-linux-musl` - `armv7-unknown-linux-musleabi` - `armv7-unknown-linux-musleabihf` - `arm-unknown-linux-musleabi` - `arm-unknown-linux-musleabihf` - `armv5te-unknown-linux-musleabi` - Windows - `x86_64-pc-windows-msvc` - MacOS - `x86_64-apple-darwin` - `aarch64-apple-darwin` ### 安装 > #### Ubuntu(Other Linux) GitHub [Releases](https://github.com/gngpp/opengpt/releases/latest) 中有预编译的 deb包，二进制文件，以Ubuntu为例： ```shell wget https://github.com/gngpp/opengpt/releases/download/v0.4.8/opengpt-0.4.8-x86_64-unknown-linux-musl.deb dpkg -i opengpt-0.4.8-x86_64-unknown-linux-musl.deb opengpt serve run ``` > #### OpenWrt GitHub [Releases](https://github.com/gngpp/opengpt/releases/latest) 中有预编译的 ipk 文件， 目前提供了 aarch64/x86_64 等架构的版本，下载后使用 opkg 安装，以 nanopi r4s 为例： ```shell wget https://github.com/gngpp/opengpt/releases/download/v0.4.8/opengpt_0.4.8_aarch64_generic.ipk wget https://github.com/gngpp/opengpt/releases/download/v0.4.8/luci-app-opengpt_1.0.6-1_all.ipk wget https://github.com/gngpp/opengpt/releases/download/v0.4.8/luci-i18n-opengpt-zh-cn_1.0.6-1_all.ipk opkg install opengpt_0.4.8_aarch64_generic.ipk opkg install luci-app-opengpt_1.0.6-1_all.ipk opkg install luci-i18n-opengpt-zh-cn_1.0.6-1_all.ipk ``` > #### Docker ```shell docker run --rm -it -p 7999:7999 --name=opengpt \ -e WORKERS=1 \ -e LOG=info \ gngpp/opengpt:latest serve run ``` > docker-compose ```yaml version: '3' services: opengpt: image: ghcr.io/gngpp/opengpt:latest container_name: opengpt restart: unless-stopped environment: - TZ=Asia/Shanghai - PROXIES=socks5://warp:10000 # - CONFIG=/serve.toml # - PORT=8080 # - HOST=0.0.0.0 # - TLS_CERT= # - TLS_KEY= # volumes: # - ${PWD}/ssl:/etc # - ${PWD}/serve.toml:/serve.toml command: serve run ports: - "8080:7999" depends_on: - warp warp: container_name: warp image: ghcr.io/gngpp/warp:latest restart: unless-stopped watchtower: container_name: watchtower image: containrrr/watchtower volumes: - /var/run/docker.sock:/var/run/docker.sock command: --interval 3600 --cleanup restart: unless-stopped ``` ### Command Line(dev) ### Http 服务 > 公开接口, `*` 表示任意`URL`后缀 > > - backend-api, > - public-api, > - platform-api, > - dashboard-api, > - chatgpt-to-api, > > 详细API文档 > > - Platfrom API [doc](https://platform.openai.com/docs/api-reference) > - Backend API [doc](doc/rest.http) - 原汁原味ChatGPT WebUI - 公开`非官方`/`官方API`代理 - `API`前缀与官方一致 - `ChatGPT` 转 `API` - 可接入第三方客户端 - 可接入IP代理池，提高并发 - 参数说明 - `--level`，环境变量 `LOG`，日志级别: 默认info - `--host`，环境变量 `HOST`， 服务监听地址: 默认0.0.0.0， - `--port`，环境变量 `PORT`， 监听端口: 默认7999 - `--tls-cert`，环境变量 `TLS_CERT`，TLS证书公钥，支持格式: EC/PKCS8/RSA - `--tls-key`，环境变量 `TLS_KEY`，TLS证书私钥 - `--proxies`，代理，支持代理池，格式: protocol://user:pass@ip:port - `--workers`， 工作线程: 默认1 ... ```shell $ opengpt serve --help Start the http server Usage: opengpt serve run [OPTIONS] Options: -C, --config Configuration file path (toml format file) [env: CONFIG=] -H, --host Server Listen host [env: HOST=] [default: 0.0.0.0] -L, --level Log level (info/debug/warn/trace/error) [env: LOG=] [default: info] -P, --port Server Listen port [env: PORT=] [default: 7999] -W, --workers Server worker-pool size (Recommended number of CPU cores) [default: 1] --concurrent-limit Enforces a limit on the concurrent number of requests the underlying [default: 65535] --proxies Server proxies pool, Example: protocol://user:pass@ip:port [env: PROXIES=] --timeout Client timeout (seconds) [default: 600] --connect-timeout Client connect timeout (seconds) [default: 60] --tcp-keepalive TCP keepalive (seconds) [default: 60] --tls-cert TLS certificate file path [env: TLS_CERT=] --tls-key TLS private key file path (EC/PKCS8/RSA) [env: TLS_KEY=] --puid PUID cookie value of Plus account [env: PUID=] --puid-user Obtain the PUID of the Plus account user, Example: `user:pass` or `user:pass:mfa` --api-prefix Web UI api prefix [env: UI_API_PREFIX=] --arkose-endpoint Arkose endpoint, Example: https://client-api.arkoselabs.com -A, --arkose-token-endpoint Get arkose token endpoint -a, --arkose-har-path About the browser HAR file path requested by ArkoseLabs -K, --arkose-har-upload-key HAR file upload authenticate key -Y, --arkose-yescaptcha-key About the YesCaptcha platform client key solved by ArkoseLabs -S, --sign-secret-key Enable url signature (signature secret key) -T, --tb-enable Enable token bucket flow limitation --tb-store-strategy Token bucket store strategy (mem/redis) [default: mem] --tb-redis-url Token bucket redis url, Example: redis://user:pass@ip:port [default: redis://127.0.0.1:6379] --tb-capacity Token bucket capacity [default: 60] --tb-fill-rate Token bucket fill rate [default: 1] --tb-expired Token bucket expired (seconds) [default: 86400] --cf-site-key Cloudflare turnstile captcha site key [env: CF_SECRET_KEY=] --cf-secret-key Cloudflare turnstile captcha secret key [env: CF_SITE_KEY=] -D, --disable-webui Disable WebUI [env: DISABLE_WEBUI=] -h, --help Print help ``` ### 自行编译 - Linux编译，Ubuntu机器为例: ```shell # 本机编译 git clone https://github.com/gngpp/opengpt.git && cd opengpt ./build.sh # 跨平台编译，依赖于docker(如果您可以自己解决跨平台编译依赖)，默认使用docker构建linux/windows平台 ./build_cross.sh # 默认在Macos上构建Macos平台 os=macos ./build_cross.sh # 编译单个平台二进制，以 aarch64-unknown-linux-musl 为例: docker run --rm -it --user=$UID:$(id -g $USER) \ -v $(pwd):/home/rust/src \ -v $HOME/.cargo/registry:/root/.cargo/registry \ -v $HOME/.cargo/git:/root/.cargo/git \ ghcr.io/gngpp/opengpt-builder:x86_64-unknown-linux-musl \ cargo build --release ``` - OpenWrt 编译 ```shell cd package svn co https://github.com/gngpp/opengpt/trunk/openwrt cd - make menuconfig # choose LUCI->Applications->luci-app-opengpt make V=s ``` ### 预览 ![img0](./doc/img/img0.png) ![img1](./doc/img/img1.png) ![img2](./doc/img/img2.png)