From 300df402cd60f4e0049e526d7ce4adc81620b8bd Mon Sep 17 00:00:00 2001 From: tbphp Date: Mon, 25 Aug 2025 08:49:10 +0800 Subject: [PATCH] docs: Add Contributing --- README.md | 11 +++++++++-- README_EN.md | 11 +++++++++-- 2 files changed, 18 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 8050d27f..8da3dad6 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ [![Release](https://img.shields.io/github/v/release/tbphp/gpt-load)](https://github.com/tbphp/gpt-load/releases) ![Go Version](https://img.shields.io/badge/Go-1.23+-blue.svg) -![License](https://img.shields.io/badge/license-MIT-green.svg) +[![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE) 一个高性能、企业级的 AI 接口透明代理服务，专门为需要集成多种 AI 服务的企业和开发者设计。采用 Go 语言开发，具备智能密钥管理、负载均衡和完善的监控功能，专为高并发生产环境而设计。 @@ -224,9 +224,10 @@ GPT-Load 会自动从环境变量中读取代理设置，用于向上游 AI 服 | 配置项 | 字段名 | 默认值 | 分组可覆盖 | 说明 | | ------------ | ------------------------------------ | --------------------------- | ---------- | -------------------------------------- | | 项目地址 | `app_url` | `http://localhost:3001` | ❌ | 项目基础 URL | +| 全局代理密钥 | `proxy_keys` | 初始值为环境配置的 AUTH_KEY | ❌ | 全局生效的代理认证密钥，多个用逗号分隔 | | 日志保留天数 | `request_log_retention_days` | 7 | ❌ | 请求日志保留天数，0 为不清理 | | 日志写入间隔 | `request_log_write_interval_minutes` | 1 | ❌ | 日志写入数据库周期（分钟） | -| 全局代理密钥 | `proxy_keys` | 初始值为环境配置的 AUTH_KEY | ❌ | 全局生效的代理认证密钥，多个用逗号分隔 | +| 启用日志详情 | `enable_request_body_logging` | false | ✅ | 是否在请求日志中记录完整的请求体和响应体内容，启用会增加内存和存储占用 | **请求设置：** @@ -453,6 +454,12 @@ response = client.messages.create( +## 贡献 + +感谢所有为 GPT-Load 做出贡献的开发者们！ + +[![Contributors](https://contrib.rocks/image?repo=tbphp/gpt-load)](https://github.com/tbphp/gpt-load/graphs/contributors) + ## 许可证 MIT 许可证 - 详情请参阅 [LICENSE](LICENSE) 文件。 diff --git a/README_EN.md b/README_EN.md index acdb0cd7..f9bc5fa4 100644 --- a/README_EN.md +++ b/README_EN.md @@ -4,7 +4,7 @@ [![Release](https://img.shields.io/github/v/release/tbphp/gpt-load)](https://github.com/tbphp/gpt-load/releases) ![Go Version](https://img.shields.io/badge/Go-1.23+-blue.svg) -![License](https://img.shields.io/badge/license-MIT-green.svg) +[![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE) A high-performance, enterprise-grade AI API transparent proxy service designed specifically for enterprises and developers who need to integrate multiple AI services. Built with Go, featuring intelligent key management, load balancing, and comprehensive monitoring capabilities, designed for high-concurrency production environments. @@ -224,9 +224,10 @@ Supported Proxy Protocol Formats: | Setting | Field Name | Default | Group Override | Description | | ------------------ | ------------------------------------ | ----------------------- | -------------- | -------------------------------------------- | | Project URL | `app_url` | `http://localhost:3001` | ❌ | Project base URL | +| Global Proxy Keys | `proxy_keys` | Initial value from `AUTH_KEY` | ❌ | Globally effective proxy keys, comma-separated | | Log Retention Days | `request_log_retention_days` | 7 | ❌ | Request log retention days, 0 for no cleanup | | Log Write Interval | `request_log_write_interval_minutes` | 1 | ❌ | Log write to database cycle (minutes) | -| Global Proxy Keys | `proxy_keys` | Initial value from `AUTH_KEY` | ❌ | Globally effective proxy keys, comma-separated | +| Enable Request Body Logging | `enable_request_body_logging` | false | ✅ | Whether to log complete request and response body content in request logs | **Request Settings:** @@ -453,6 +454,12 @@ response = client.messages.create( +## Contributing + +Thanks to all the developers who have contributed to GPT-Load! + +[![Contributors](https://contrib.rocks/image?repo=tbphp/gpt-load)](https://github.com/tbphp/gpt-load/graphs/contributors) + ## License MIT License - see [LICENSE](LICENSE) file for details.