airkjw/CLIProxyAPI
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Correct config in README.md

Browse Source
This commit is contained in:
Faisal Chaudhry
2025-07-08 23:28:55 -04:00
committed by GitHub
parent 589ae6d3aa
commit 9be56fe8e0
1 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+6 -6
View File
@@ -150,10 +150,10 @@ The server uses a YAML configuration file (`config.yaml`) located in the project
| Parameter | Type | Default | Description | | Parameter | Type | Default | Description |
|-------------------------------|----------|--------------------|----------------------------------------------------------------------------------------------| |-------------------------------|----------|--------------------|----------------------------------------------------------------------------------------------|
| `port` | integer | 8317 | The port number on which the server will listen | | `port` | integer | 8317 | The port number on which the server will listen |
| `auth_dir` | string | "~/.cli-proxy-api" | Directory where authentication tokens are stored. Supports using `~` for home directory | | `auth-dir` | string | "~/.cli-proxy-api" | Directory where authentication tokens are stored. Supports using `~` for home directory |
| `proxy-url` | string | "" | Proxy url, support socks5/http/https protocol, example: socks5://user:pass@192.168.1.1:1080/ | | `proxy-url` | string | "" | Proxy url, support socks5/http/https protocol, example: socks5://user:pass@192.168.1.1:1080/ |
| `debug` | boolean | false | Enable debug mode for verbose logging | | `debug` | boolean | false | Enable debug mode for verbose logging |
| `api_keys` | string[] | [] | List of API keys that can be used to authenticate requests | | `api-keys` | string[] | [] | List of API keys that can be used to authenticate requests |
| `generative-language-api-key` | string[] | [] | List of Generative Language API keys | | `generative-language-api-key` | string[] | [] | List of Generative Language API keys |
### Example Configuration File ### Example Configuration File
@@ -163,24 +163,24 @@ The server uses a YAML configuration file (`config.yaml`) located in the project
port: 8317 port: 8317
# Authentication directory (supports ~ for home directory) # Authentication directory (supports ~ for home directory)
auth_dir: "~/.cli-proxy-api" auth-dir: "~/.cli-proxy-api"
# Enable debug logging # Enable debug logging
debug: false debug: false
# API keys for authentication # API keys for authentication
api_keys: api-keys:
- "your-api-key-1" - "your-api-key-1"
- "your-api-key-2" - "your-api-key-2"
``` ```
### Authentication Directory ### Authentication Directory
The `auth_dir` parameter specifies where authentication tokens are stored. When you run the login command, the application will create JSON files in this directory containing the authentication tokens for your Google accounts. Multiple accounts can be used for load balancing. The `auth-dir` parameter specifies where authentication tokens are stored. When you run the login command, the application will create JSON files in this directory containing the authentication tokens for your Google accounts. Multiple accounts can be used for load balancing.
### API Keys ### API Keys
The `api_keys` parameter allows you to define a list of API keys that can be used to authenticate requests to your proxy server. When making requests to the API, you can include one of these keys in the `Authorization` header: The `api-keys` parameter allows you to define a list of API keys that can be used to authenticate requests to your proxy server. When making requests to the API, you can include one of these keys in the `Authorization` header:
``` ```
Authorization: Bearer your-api-key-1 Authorization: Bearer your-api-key-1