obeoneorg/simple-cors-proxy

🐳 Docker Simple CORS Proxy

这是一个简单的CORS代理服务器，主要设计用于配合TypingMind插件使用，允许跨域请求任何API而无需担心CORS限制。其功能不仅限于TypingMind，还可用于任何需要CORS代理的应用场景。

🚀 核心功能与特性

• 🌐 与TypingMind插件无缝集成，支持外部API调用
• 🔒 通过API密钥实现安全认证
• 🔗 支持通过X-Url-Destination请求头或URL路径直接指定代理目标URL
• 🔄 自动处理CORS头信息，启用跨域请求
• ⚙️ 配置简单，部署便捷
• 🐳 提供Docker镜像，支持快速部署

⌨️ TypingMind插件集成

TypingMind插件是增强GPT功能的工具，通过该插件，GPT可不受CORS（跨域资源共享）策略限制，无缝调用任何API。这使GPT能够访问外部数据源和服务，拓展集成与交互能力。

使用TypingMind插件只需访问TypingMind插件页面并点击"Import"即可安装。

🐳 Docker部署

使用Docker镜像可快速运行代理服务器，步骤如下：

1. 拉取镜像

shell
docker pull obeoneorg/simple-cors-proxy

2. 运行容器

shell
docker run -d --name simple-cors-proxy -p 8080:8080 obeoneorg/simple-cors-proxy

🐳 Docker Compose部署

通过Docker Compose文件快速部署：

1. 启动服务

shell
docker compose up -d

💻 手动安装

无需Docker时，可按以下步骤安装：

1. 克隆仓库：

shell
git clone https://github.com/obeone/simple-cors-proxy.git

2. 安装依赖：

shell
npm install

3. 启动服务器：

shell
npm start

4. 服务器默认运行在8080端口，可通过设置PORT环境变量修改端口。

📝 使用说明

基本用法

使用代理服务器时，需在请求中设置X-Url-Destination头指定目标资源URL：

shell
curl -H "X-Url-Destination: http://example.com" http://localhost:8080/proxy

高级用法

直接传递URL

可在请求URL路径中直接指定目标URL，此方式会保留URL中的查询参数：

shell
curl http://localhost:8080/proxy/https://example.com/some/path?foo=1

服务器会自动将完整解码后的URL作为X-Url-Destination头值，简化使用流程。

认证配置

通过PROXY_TOKEN环境变量启用代理访问认证，客户端需在请求头X-Proxy-Token中提供匹配的API密钥：

shell
# 启动带认证的容器
docker run -d --name simple-cors-proxy -p 8080:8080 -e PROXY_TOKEN=YOUR_API_KEY obeoneorg/simple-cors-proxy

# 带认证的请求示例
curl -H "X-Proxy-Token: YOUR_API_KEY" -H "X-Url-Destination: http://example.com" http://localhost:8080/proxy

请求头移除

如需移除特定请求头（如X-Forwarded-For），可使用x-headers-delete请求头或HEADERS_TO_DELETE环境变量，多值以逗号分隔：

shell
# 启动时指定需移除的头
docker run -d --name simple-cors-proxy -p 8080:8080 -e HEADERS_TO_DELETE=X-Forwarded-For,X-Forwarded-Host obeoneorg/simple-cors-proxy

🤝 贡献方式

欢迎贡献代码！如遇问题或有改进建议，请在https://github.com/obeone/simple-cors-proxy%E6%8F%90%E4%BA%A4issue%E6%88%96PR%E3%80%82