xinyin025/one-api
1
0
Fork 0
mirror of https://github.com/songquanpeng/one-api.git synced 2025-09-19 18:16:38 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: update README with optional environment variables and their descriptions

Browse Source
This commit is contained in:
Laisky.Cai 2025-02-27 01:24:34 +00:00
parent 155a3aac73
commit 153472dc84
1 changed files with 19 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -49,11 +49,24 @@ oneapi:
options: options:
max-size: "10m" max-size: "10m"
environment: environment:
- ENFORCE_INCLUDE_USAGE=true # (optional) SESSION_SECRET set a fixed session secret so that user sessions won't be invalidated after server restart
- GLOBAL_API_RATE_LIMIT=1000 SESSION_SECRET: xxxxxxx
- GLOBAL_WEB_RATE_LIMIT=1000 # (optional) DEBUG enable debug mode
- FRONTEND_BASE_URL=https://oneapi.laisky.com DEBUG: true
- OPENROUTER_PROVIDER_SORT=throughput # (optional) DEBUG_SQL display SQL logs
DEBUG_SQL: true
# (optional) ENFORCE_INCLUDE_USAGE require upstream API responses to include usage field
ENFORCE_INCLUDE_USAGE: true
# (optional) GLOBAL_API_RATE_LIMIT maximum API requests per IP within three minutes, default is 1000
GLOBAL_API_RATE_LIMIT: 1000
# (optional) GLOBAL_WEB_RATE_LIMIT maximum web page requests per IP within three minutes, default is 1000
GLOBAL_WEB_RATE_LIMIT: 1000
# (optional) REDIS_CONN_STRING set REDIS cache connection
REDIS_CONN_STRING: redis://100.122.41.16:6379/1
# (optional) FRONTEND_BASE_URL redirect page requests to specified address, server-side setting only
FRONTEND_BASE_URL: https://oneapi.laisky.com
# (optional) OPENROUTER_PROVIDER_SORT set sorting method for OpenRouter Providers, default is throughput
OPENROUTER_PROVIDER_SORT: throughput
volumes: volumes:
- /var/lib/oneapi:/data - /var/lib/oneapi:/data
ports: ports:
@ -206,3 +219,4 @@ Supports two URL parameters: `thinking` and `reasoning_format`.
- [fix: channel test false negative #2065](https://github.com/songquanpeng/one-api/pull/2065) - [fix: channel test false negative #2065](https://github.com/songquanpeng/one-api/pull/2065)
- [fix: resolve "bufio.Scanner: token too long" error by increasing buff… #2128](https://github.com/songquanpeng/one-api/pull/2128) - [fix: resolve "bufio.Scanner: token too long" error by increasing buff… #2128](https://github.com/songquanpeng/one-api/pull/2128)
- [feat: Enhance VolcEngine channel support with bot model #2131](https://github.com/songquanpeng/one-api/pull/2131) - [feat: Enhance VolcEngine channel support with bot model #2131](https://github.com/songquanpeng/one-api/pull/2131)
- [fix: models api return models in deactivate channels #2150](https://github.com/songquanpeng/one-api/pull/2150)