Skip to content

fix: support split web/api domains in usage-doc examples #982

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ding113 merged 4 commits into from
Apr 14, 2026
Merged

fix: support split web/api domains in usage-doc examples #982

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d0102dc
fix: support split web/api domains in usage-doc examples
xuesongjun Mar 29, 2026
c7105e3
fix: address review feedback on split-domain PR
xuesongjun Apr 11, 2026
9f0fe89
fix: add NEXT_PUBLIC_API_BASE_URL to .env.example
xuesongjun Apr 11, 2026
a31e9ad
Merge branch 'dev' into fix/usage-doc-split-domain
xuesongjun Apr 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .env.example
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
# 管理员令牌（请务必更改此值以确保安全性）
ADMIN_TOKEN=change-me

# API 域名（分域部署时配置，Web UI 与 API 使用不同域名时需要设置）
# 用于 usage-doc 页面生成正确的客户端配置示例
# 单域名部署无需设置，留空则自动使用当前站点域名
# NEXT_PUBLIC_API_BASE_URL=https://api.example.com

# 自动迁移控制（生产环境默认开启）
# 设置为 false 可禁用自动迁移
AUTO_MIGRATE=true
Expand Down
40 changes: 21 additions & 19 deletions src/app/[locale]/usage-doc/page.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,8 @@ interface UsageDocContentProps {
export function UsageDocContent({ origin }: UsageDocContentProps) {
const t = useTranslations("usage");
const resolvedOrigin = origin || t("ui.currentSiteAddress");
// 优先使用显式配置的 API 域名，兼容 Web/UI 与 API 分域部署
const apiOrigin = (process.env.NEXT_PUBLIC_API_BASE_URL?.trim() ?? "").replace(/\/$/, "") || resolvedOrigin;
Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector bot Apr 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Badge Resolve API origin from runtime config, not build-time env

This value is read inside a "use client" component, so process.env.NEXT_PUBLIC_API_BASE_URL is baked into the JS bundle at build time instead of read from container runtime env. In the default deployment path (docker-compose.yaml uses prebuilt ghcr.io/ding113/claude-code-hub:latest with .env injected at runtime), setting NEXT_PUBLIC_API_BASE_URL in .env will not change apiOrigin, so split-domain users still see incorrect examples unless they rebuild the image with that value.

Useful? React with 👍 / 👎.

const CLI_CONFIGS = getCLIConfigs(t);

/**
Expand Down Expand Up @@ -492,7 +494,7 @@ npm --version`}
code={`{
"env": {
"ANTHROPIC_AUTH_TOKEN": "your-api-key-here",
"ANTHROPIC_BASE_URL": "${resolvedOrigin}",
"ANTHROPIC_BASE_URL": "${apiOrigin}",
"CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC": "1"
},
"permissions": {
Expand Down Expand Up @@ -522,13 +524,13 @@ npm --version`}
<p>{t("claudeCode.configuration.envVars.windows.temporary")}</p>
<CodeBlock
language="powershell"
code={`$env:ANTHROPIC_BASE_URL = "${resolvedOrigin}"
code={`$env:ANTHROPIC_BASE_URL = "${apiOrigin}"
$env:ANTHROPIC_AUTH_TOKEN = "your-api-key-here"`}
/>
<p>{t("claudeCode.configuration.envVars.windows.permanent")}</p>
<CodeBlock
language="powershell"
code={`[System.Environment]::SetEnvironmentVariable("ANTHROPIC_BASE_URL", "${resolvedOrigin}", [System.EnvironmentVariableTarget]::User)
code={`[System.Environment]::SetEnvironmentVariable("ANTHROPIC_BASE_URL", "${apiOrigin}", [System.EnvironmentVariableTarget]::User)
[System.Environment]::SetEnvironmentVariable("ANTHROPIC_AUTH_TOKEN", "your-api-key-here", [System.EnvironmentVariableTarget]::User)`}
/>
<p className="text-sm text-muted-foreground">
Expand All @@ -540,7 +542,7 @@ $env:ANTHROPIC_AUTH_TOKEN = "your-api-key-here"`}
<p>{t("claudeCode.configuration.envVars.unix.temporary")}</p>
<CodeBlock
language="bash"
code={`export ANTHROPIC_BASE_URL="${resolvedOrigin}"
code={`export ANTHROPIC_BASE_URL="${apiOrigin}"
export ANTHROPIC_AUTH_TOKEN="your-api-key-here"`}
/>
<p>{t("claudeCode.configuration.envVars.unix.permanent")}</p>
Expand All @@ -549,7 +551,7 @@ export ANTHROPIC_AUTH_TOKEN="your-api-key-here"`}
</p>
<CodeBlock
language="bash"
code={`echo 'export ANTHROPIC_BASE_URL="${resolvedOrigin}"' >> ${shellConfigFile}
code={`echo 'export ANTHROPIC_BASE_URL="${apiOrigin}"' >> ${shellConfigFile}
echo 'export ANTHROPIC_AUTH_TOKEN="your-api-key-here"' >> ${shellConfigFile}
source ${shellConfigFile}`}
/>
Expand Down Expand Up @@ -585,7 +587,7 @@ echo $ANTHROPIC_AUTH_TOKEN`}
<p>{t("claudeCode.configuration.verification.expectedOutput")}</p>
<CodeBlock
language="text"
code={`${resolvedOrigin}
code={`${apiOrigin}
sk_xxxxxxxxxxxxxxxxxx`}
/>
<blockquote className="space-y-2 rounded-lg border-l-2 border-amber-500/50 bg-amber-50/50 dark:bg-amber-950/20 px-4 py-3">
Expand Down Expand Up @@ -676,7 +678,7 @@ rmcp_client = true

[model_providers.cch]
name = "cch"
base_url = "${resolvedOrigin}/v1"
base_url = "${apiOrigin}/v1"
wire_api = "responses"
requires_openai_auth = true

Expand Down Expand Up @@ -722,7 +724,7 @@ rmcp_client = true

[model_providers.cch]
name = "cch"
base_url = "${resolvedOrigin}/v1"
base_url = "${apiOrigin}/v1"
wire_api = "responses"
env_key = "CCH_API_KEY"
requires_openai_auth = true
Expand Down Expand Up @@ -830,7 +832,7 @@ source ${shellConfigFile}`}
<p>{t("gemini.configuration.configFile.step2.content")}</p>
<CodeBlock
language="bash"
code={`GOOGLE_GEMINI_BASE_URL=${resolvedOrigin}
code={`GOOGLE_GEMINI_BASE_URL=${apiOrigin}
GEMINI_API_KEY=your-api-key-here
GEMINI_MODEL=gemini-3-pro-preview`}
/>
Expand Down Expand Up @@ -892,14 +894,14 @@ GEMINI_MODEL=gemini-3-pro-preview`}
<p>{t("gemini.configuration.envVars.windows.powershell")}</p>
<CodeBlock
language="powershell"
code={`$env:GOOGLE_GEMINI_BASE_URL="${resolvedOrigin}"
code={`$env:GOOGLE_GEMINI_BASE_URL="${apiOrigin}"
$env:GEMINI_API_KEY="your-api-key-here"
$env:GEMINI_MODEL="gemini-2.5-pro"`}
/>
<p>{t("gemini.configuration.envVars.windows.cmd")}</p>
<CodeBlock
language="cmd"
code={`set GOOGLE_GEMINI_BASE_URL=${resolvedOrigin}
code={`set GOOGLE_GEMINI_BASE_URL=${apiOrigin}
set GEMINI_API_KEY=your-api-key-here
set GEMINI_MODEL=gemini-3-pro-preview`}
/>
Expand All @@ -912,7 +914,7 @@ set GEMINI_MODEL=gemini-3-pro-preview`}
<p>{t("gemini.configuration.envVars.macosLinux.title")}</p>
<CodeBlock
language="bash"
code={`export GOOGLE_GEMINI_BASE_URL="${resolvedOrigin}"
code={`export GOOGLE_GEMINI_BASE_URL="${apiOrigin}"
export GEMINI_API_KEY="your-api-key-here"
export GEMINI_MODEL="gemini-2.5-pro"`}
/>
Expand Down Expand Up @@ -1091,7 +1093,7 @@ gemini`}
npm: "@ai-sdk/anthropic",
name: "Claude via cch",
options: {
baseURL: `${resolvedOrigin}/v1`,
baseURL: `${apiOrigin}/v1`,
apiKey: "{env:CCH_API_KEY}",
},
models: {
Expand All @@ -1104,7 +1106,7 @@ gemini`}
npm: "@ai-sdk/openai",
name: "GPT via cch",
options: {
baseURL: `${resolvedOrigin}/v1`,
baseURL: `${apiOrigin}/v1`,
apiKey: "{env:CCH_API_KEY}",
store: false,
setCacheKey: true,
Expand Down Expand Up @@ -1133,7 +1135,7 @@ gemini`}
npm: "@ai-sdk/google",
name: "Gemini via cch",
options: {
baseURL: `${resolvedOrigin}/v1beta`,
baseURL: `${apiOrigin}/v1beta`,
apiKey: "{env:CCH_API_KEY}",
},
models: {
Expand Down Expand Up @@ -1243,14 +1245,14 @@ gemini`}
{
"model_display_name": "Sonnet 4.5 [cch]",
"model": "claude-sonnet-4-5-20250929",
"base_url": "${resolvedOrigin}",
"base_url": "${apiOrigin}",
"api_key": "your-api-key-here",
"provider": "anthropic"
},
{
"model_display_name": "GPT-5.2 [cch]",
"model": "gpt-5.2",
"base_url": "${resolvedOrigin}/v1",
"base_url": "${apiOrigin}/v1",
"api_key": "your-api-key-here",
"provider": "openai"
}
Expand Down Expand Up @@ -1505,7 +1507,7 @@ source ~/.${os === "macos" ? "zshrc" : "bashrc"}`}
echo $env:${envKeyName}

${t("snippets.comments.testNetworkConnection")}
Test-NetConnection -ComputerName ${resolvedOrigin.replace("https://", "").replace("http://", "")} -Port 443`}
Test-NetConnection -ComputerName ${apiOrigin.replace("https://", "").replace("http://", "")} -Port 443`}
/>
) : (
<CodeBlock
Expand All @@ -1514,7 +1516,7 @@ Test-NetConnection -ComputerName ${resolvedOrigin.replace("https://", "").replac
echo $${envKeyName}

${t("snippets.comments.testNetworkConnection")}
curl -I ${resolvedOrigin}`}
curl -i ${apiOrigin}/v1/messages`}
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist bot Mar 29, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

high

This update to the Unix network test is a great improvement. However, the corresponding test for Windows (on line 1510) was not updated. It still uses resolvedOrigin and a basic TCP check (Test-NetConnection).

For consistency and to provide an equivalent test, the Windows command should be updated to:

  1. Use apiOrigin.
  2. Use Invoke-WebRequest to test the /v1/messages endpoint, similar to this curl command.

Consider replacing the Test-NetConnection command with Invoke-WebRequest:

Invoke-WebRequest -Uri "${apiOrigin}/v1/messages" -UseBasicParsing

/>
)}
</div>
Expand Down