From 551bc1a4a8aa64305970ecd154e108d611730fc2 Mon Sep 17 00:00:00 2001 From: Luis Pater Date: Sun, 7 Sep 2025 12:26:08 +0800 Subject: [PATCH] Enhance README formatting and update .dockerignore --- .dockerignore | 2 -- README.md | 22 +++++++++++++++++----- README_CN.md | 22 +++++++++++++++++----- 3 files changed, 34 insertions(+), 12 deletions(-) diff --git a/.dockerignore b/.dockerignore index 30edabaf..1935a138 100644 --- a/.dockerignore +++ b/.dockerignore @@ -4,8 +4,6 @@ # Docker and CI/CD related files docker-compose.yml -docker-compose.override.yml -docker-compose.remote.yml .dockerignore .gitignore .goreleaser.yml diff --git a/README.md b/README.md index 10cff67d..454b47bd 100644 --- a/README.md +++ b/README.md @@ -530,11 +530,23 @@ docker run --rm -p 8317:8317 -v /path/to/your/config.yaml:/CLIProxyAPI/config.ya - **Option 1: Run using Pre-built Image (Recommended)**: Pulls the latest official image from the registry and starts the container. This is the easiest way to get started. - **Option 2: Build from Source and Run (For Developers)**: Builds the image from the local source code, tags it as `cli-proxy-api:local`, and then starts the container. This is useful if you are making changes to the source code. -4. To authenticate with providers, run the login command inside the container: - - **Gemini**: `docker compose exec cli-proxy-api /CLIProxyAPI/CLIProxyAPI -no-browser --login` - - **OpenAI (Codex)**: `docker compose exec cli-proxy-api /CLIProxyAPI/CLIProxyAPI -no-browser --codex-login` - - **Claude**: `docker compose exec cli-proxy-api /CLIProxyAPI/CLIProxyAPI -no-browser --claude-login` - - **Qwen**: `docker compose exec cli-proxy-api /CLIProxyAPI/CLIProxyAPI -no-browser --qwen-login` +4. To authenticate with providers, run the login command inside the container: + - **Gemini**: + ```bash + docker compose exec cli-proxy-api /CLIProxyAPI/CLIProxyAPI -no-browser --login + ``` + - **OpenAI (Codex)**: + ```bash + docker compose exec cli-proxy-api /CLIProxyAPI/CLIProxyAPI -no-browser --codex-login + ``` + - **Claude**: + ```bash + docker compose exec cli-proxy-api /CLIProxyAPI/CLIProxyAPI -no-browser --claude-login + ``` + - **Qwen**: + ```bash + docker compose exec cli-proxy-api /CLIProxyAPI/CLIProxyAPI -no-browser --qwen-login + ``` 5. To view the server logs: ```bash diff --git a/README_CN.md b/README_CN.md index 18a49323..1b89a51e 100644 --- a/README_CN.md +++ b/README_CN.md @@ -545,11 +545,23 @@ docker run --rm -p 8317:8317 -v /path/to/your/config.yaml:/CLIProxyAPI/config.ya - **选项 1:使用预构建的镜像运行 (推荐)**:从镜像仓库拉取最新的官方镜像并启动容器。这是最简单的开始方式。 - **选项 2:从源码构建并运行 (适用于开发者)**:从本地源代码构建镜像,将其标记为 `cli-proxy-api:local`,然后启动容器。如果您需要修改源代码,此选项很有用。 -4. 要在容器内运行登录命令进行身份验证: - - **Gemini**: `docker compose exec cli-proxy-api /CLIProxyAPI/CLIProxyAPI -no-browser --login` - - **OpenAI (Codex)**: `docker compose exec cli-proxy-api /CLIProxyAPI/CLIProxyAPI -no-browser --codex-login` - - **Claude**: `docker compose exec cli-proxy-api /CLIProxyAPI/CLIProxyAPI -no-browser --claude-login` - - **Qwen**: `docker compose exec cli-proxy-api /CLIProxyAPI/CLIProxyAPI -no-browser --qwen-login` +4. 要在容器内运行登录命令进行身份验证: + - **Gemini**: + ```bash + docker compose exec cli-proxy-api /CLIProxyAPI/CLIProxyAPI -no-browser --login + ``` + - **OpenAI (Codex)**: + ```bash + docker compose exec cli-proxy-api /CLIProxyAPI/CLIProxyAPI -no-browser --codex-login + ``` + - **Claude**: + ```bash + docker compose exec cli-proxy-api /CLIProxyAPI/CLIProxyAPI -no-browser --claude-login + ``` + - **Qwen**: + ```bash + docker compose exec cli-proxy-api /CLIProxyAPI/CLIProxyAPI -no-browser --qwen-login + ``` 5. 查看服务器日志: ```bash