{"meta":{"title":"后端服务设置","intro":"在服务器端应用程序中运行Copilot SDK-API、Web 后端、微服务和后台辅助角色。 CLI 作为一个无头服务器运行，你的后端代码通过网络连接到它。","product":"GitHub Copilot","breadcrumbs":[{"href":"/zh/enterprise-cloud@latest/copilot","title":"GitHub Copilot"},{"href":"/zh/enterprise-cloud@latest/copilot/how-tos","title":"操作方法"},{"href":"/zh/enterprise-cloud@latest/copilot/how-tos/copilot-sdk","title":"Copilot SDK"},{"href":"/zh/enterprise-cloud@latest/copilot/how-tos/copilot-sdk/setup","title":"设置 Copilot SDK"},{"href":"/zh/enterprise-cloud@latest/copilot/how-tos/copilot-sdk/setup/backend-services","title":"后端服务"}],"documentType":"article"},"body":"# 后端服务设置\n\n在服务器端应用程序中运行Copilot SDK-API、Web 后端、微服务和后台辅助角色。 CLI 作为一个无头服务器运行，你的后端代码通过网络连接到它。\n\n<!-- markdownlint-disable GHD046 GHD005 -->\n\n<!-- Suppressed: GHD046 (outdated release terminology), GHD005 (hardcoded data variable) -->\n\n**最适合：** Web 应用后端、API 服务、内部工具、CI/CD 集成、任何服务器端工作负载。\n\n## 工作原理\n\n与生成 CLI 子进程的 SDK 相反，可以在 **无外设服务器模式下**独立运行 CLI。 后端使用 `Connection` 选项（`URIConnection`）通过 TCP 与其建立连接。\n\n![图示：显示所述过程的流程图。](/assets/images/help/copilot/copilot-sdk/setup-backend-services-diagram-0.png)\n\n**主要特征：**\n\n* CLI 作为常驻服务器进程运行（不是为每个请求单独启动的）\n* SDK 通过 TCP 进行连接 — CLI 和应用可以在不同的容器中运行\n* 多个 SDK 客户端可以共享一个 CLI 服务器\n* 适用于任何身份验证方法（GitHub令牌、env vars、BYOK）\n\n对于多用户服务器模式，请使用 `mode: \"empty\"` 配置 SDK 客户端，为每个会话传递用户凭据，并为每个会话显式允许工具。 有关完整模式，请参阅 [多租户与服务器部署](/zh/enterprise-cloud@latest/copilot/how-tos/copilot-sdk/setup/multi-tenancy) 。\n\n## 体系结构：自动管理与外部 CLI\n\n![图示：显示所述过程的流程图。](/assets/images/help/copilot/copilot-sdk/setup-backend-services-diagram-1.png)\n\n## 步骤 1：以无头模式启动 CLI\n\n将 CLI 作为后台服务器运行：\n\n```bash\n# Start with a specific port\ncopilot --headless --port 4321\n\n# Or let it pick a random port (prints the URL)\ncopilot --headless\n# Output: Listening on http://localhost:52431\n```\n\n默认情况下，无头服务器仅接受来自环回 (`127.0.0.1`) 的连接。 若要接受来自其他主机的连接（例如来自您网络中的另一台计算机），请使用 `--host` 绑定到非环回地址：\n\n```bash\ncopilot --headless --host 0.0.0.0 --port 4321\n```\n\n对于生产，请将其作为系统服务或在容器中运行。\n\n> \\[!NOTE]\n> Copilot CLI 没有正式预构建的 Docker 映像。 可以从 [GitHub 版本生成自己的版本](https://github.com/github/copilot-cli/releases)：\n\n```dockerfile\nFROM debian:bookworm-slim\nARG COPILOT_VERSION=1.0.7\nRUN apt-get update \\\n    && apt-get install -y --no-install-recommends ca-certificates wget \\\n    && ARCH=$(dpkg --print-architecture) \\\n    && case \"${ARCH}\" in amd64) COPILOT_ARCH=\"x64\" ;; arm64) COPILOT_ARCH=\"arm64\" ;; *) echo \"Unsupported: ${ARCH}\" && exit 1 ;; esac \\\n    && wget -q \"https://github.com/github/copilot-cli/releases/download/v${COPILOT_VERSION}/copilot-linux-${COPILOT_ARCH}.tar.gz\" \\\n    && tar -xzf \"copilot-linux-${COPILOT_ARCH}.tar.gz\" \\\n    && mv copilot /usr/local/bin/ \\\n    && rm \"copilot-linux-${COPILOT_ARCH}.tar.gz\" \\\n    && apt-get purge -y wget && apt-get autoremove -y && rm -rf /var/lib/apt/lists/*\nENTRYPOINT [\"copilot\"]\n```\n\n```bash\n# Build the image\ndocker build --build-arg COPILOT_VERSION=1.0.7 -t copilot-cli:latest .\n\n# For remote deployments (Kubernetes, ACI, etc.), push to your registry\ndocker tag copilot-cli:latest your-registry/copilot-cli:latest\ndocker push your-registry/copilot-cli:latest\n```\n\n```bash\n# Docker — must bind to 0.0.0.0 so the container's published port is reachable\ndocker run -d --name copilot-cli \\\n    -p 4321:4321 \\\n    -e COPILOT_GITHUB_TOKEN=\"$TOKEN\" \\\n    copilot-cli:latest \\\n    --headless --host 0.0.0.0 --port 4321\n\n# systemd\n[Service]\nExecStart=/usr/local/bin/copilot --headless --port 4321\nEnvironment=COPILOT_GITHUB_TOKEN=your-token\nRestart=always\n```\n\n## 步骤 2：连接 SDK\n\n<div class=\"ghd-codetabs\">\n<div class=\"ghd-codetab\" data-lang=\"typescript\" data-label=\"TypeScript\"><div class=\"ghd-codetab-fallback-label\" role=\"heading\" aria-level=\"3\">TypeScript</div>\n\n```typescript\nimport { CopilotClient, RuntimeConnection } from \"@github/copilot-sdk\";\n\nconst client = new CopilotClient({\n    connection: RuntimeConnection.forUri(\"localhost:4321\"),\n    mode: \"empty\",\n});\n\nconst session = await client.createSession({\n    sessionId: `user-${userId}-${Date.now()}`,\n    model: \"gpt-5.4\",\n    availableTools: [\"custom:*\"],\n    gitHubToken: user.githubToken,\n});\n\nconst response = await session.sendAndWait({ prompt: req.body.message });\nres.json({ content: response?.data.content });\n```\n\n</div>\n\n<div class=\"ghd-codetab\" data-lang=\"python\" data-label=\"Python\"><div class=\"ghd-codetab-fallback-label\" role=\"heading\" aria-level=\"3\">Python</div>\n\n```python\nfrom copilot import CopilotClient, RuntimeConnection\nfrom copilot.session import PermissionHandler\n\nclient = CopilotClient(\n    connection=RuntimeConnection.for_uri(\"localhost:4321\"),\n)\nawait client.start()\n\nsession = await client.create_session(on_permission_request=PermissionHandler.approve_all, model=\"gpt-5.4\", session_id=f\"user-{user_id}-{int(time.time())}\")\n\nresponse = await session.send_and_wait(message)\n```\n\n</div>\n\n<div class=\"ghd-codetab\" data-lang=\"go\" data-label=\"Go\"><div class=\"ghd-codetab-fallback-label\" role=\"heading\" aria-level=\"3\">Go</div>\n\n```golang\nclient := copilot.NewClient(&copilot.ClientOptions{\n    Connection: copilot.URIConnection{URL: \"localhost:4321\"},\n})\nclient.Start(ctx)\ndefer client.Stop()\n\nsession, _ := client.CreateSession(ctx, &copilot.SessionConfig{\n    SessionID: fmt.Sprintf(\"user-%s-%d\", userID, time.Now().Unix()),\n    Model:     \"gpt-5.4\",\n})\n\nresponse, _ := session.SendAndWait(ctx, copilot.MessageOptions{Prompt: message})\n```\n\n</div>\n\n<div class=\"ghd-codetab\" data-lang=\"dotnet\" data-label=\".NET\"><div class=\"ghd-codetab-fallback-label\" role=\"heading\" aria-level=\"3\">.NET</div>\n\n```csharp\nvar client = new CopilotClient(new CopilotClientOptions\n{\n    Connection = RuntimeConnection.ForUri(\"localhost:4321\"),\n});\n\nawait using var session = await client.CreateSessionAsync(new SessionConfig\n{\n    SessionId = $\"user-{userId}-{DateTimeOffset.UtcNow.ToUnixTimeSeconds()}\",\n    Model = \"gpt-5.4\",\n});\n\nvar response = await session.SendAndWaitAsync(\n    new MessageOptions { Prompt = message });\n```\n\n</div>\n\n<div class=\"ghd-codetab\" data-lang=\"java\" data-label=\"Java\"><div class=\"ghd-codetab-fallback-label\" role=\"heading\" aria-level=\"3\">Java</div>\n\n```java\nimport com.github.copilot.CopilotClient;\nimport com.github.copilot.rpc.*;\n\nvar userId = \"user1\";\nvar message = \"Hello!\";\n\nvar client = new CopilotClient(new CopilotClientOptions()\n    .setCliUrl(\"localhost:4321\")\n);\n\ntry {\n    client.start().get();\n\n    var session = client.createSession(new SessionConfig()\n        .setSessionId(String.format(\"user-%s-%d\", userId, System.currentTimeMillis() / 1000))\n        .setModel(\"gpt-5.4\")\n        .setOnPermissionRequest(PermissionHandler.APPROVE_ALL)\n    ).get();\n\n    var response = session.sendAndWait(new MessageOptions()\n        .setPrompt(message)).get();\n} finally {\n    client.stop().get();\n}\n```\n\n</div>\n\n</div>\n\n## 后端服务的身份验证\n\n### 环境变量令牌\n\n最简单的方法 - 在 CLI 服务器上设置令牌：\n\n![图示：显示所述过程的流程图。](/assets/images/help/copilot/copilot-sdk/setup-backend-services-diagram-2.png)\n\n```bash\n# All requests use this token\nexport COPILOT_GITHUB_TOKEN=\"gho_service_account_token\"\ncopilot --headless --port 4321\n```\n\n### 每用户令牌 (OAuth)\n\n创建会话时传递单个用户令牌。 完整流程请参阅 [GitHub OAuth 设置](/zh/enterprise-cloud@latest/copilot/how-tos/copilot-sdk/setup/github-oauth)。\n\n```typescript\nconst client = new CopilotClient({\n    connection: RuntimeConnection.forUri(\"localhost:4321\"),\n    mode: \"empty\",\n});\n\n// Your API receives user tokens from your auth layer\napp.post(\"/chat\", authMiddleware, async (req, res) => {\n    const session = await client.createSession({\n        sessionId: `user-${req.user.id}-chat`,\n        model: \"gpt-5.4\",\n        availableTools: [\"custom:*\"],\n        gitHubToken: req.user.githubToken,\n    });\n\n    const response = await session.sendAndWait({\n        prompt: req.body.message,\n    });\n\n    res.json({ content: response?.data.content });\n});\n```\n\n### BYOK （无GitHub身份验证）\n\n使用您自己的 API 密钥来访问模型服务提供商。 有关详细信息，请参阅“[BYOK （自带密钥）](/zh/enterprise-cloud@latest/copilot/how-tos/copilot-sdk/auth/byok)”。\n\n```typescript\nconst client = new CopilotClient({\n    connection: RuntimeConnection.forUri(\"localhost:4321\"),\n});\n\nconst session = await client.createSession({\n    model: \"gpt-5.4\",\n    provider: {\n        type: \"openai\",\n        baseUrl: \"https://api.openai.com/v1\",\n        apiKey: process.env.OPENAI_API_KEY,\n    },\n});\n```\n\n## 常见后端模式\n\n### 使用 Express 的 Web API\n\n![图示：显示所述过程的流程图。](/assets/images/help/copilot/copilot-sdk/setup-backend-services-diagram-3.png)\n\n```typescript\nimport express from \"express\";\nimport { CopilotClient, RuntimeConnection } from \"@github/copilot-sdk\";\n\nconst app = express();\napp.use(express.json());\n\n// Single shared CLI connection for multi-user server mode\nconst client = new CopilotClient({\n    connection: RuntimeConnection.forUri(process.env.CLI_URL || \"localhost:4321\"),\n    mode: \"empty\",\n});\n\napp.post(\"/api/chat\", async (req, res) => {\n    const { sessionId, message } = req.body;\n\n    // Create or resume session\n    let session;\n    try {\n        session = await client.resumeSession(sessionId);\n    } catch {\n        session = await client.createSession({\n            sessionId,\n            model: \"gpt-5.4\",\n            availableTools: [\"custom:*\"],\n            gitHubToken: req.user.githubToken,\n        });\n    }\n\n    const response = await session.sendAndWait({ prompt: message });\n    res.json({\n        sessionId,\n        content: response?.data.content,\n    });\n});\n\napp.listen(3000);\n```\n\n### 后台工作者\n\n```typescript\nimport { CopilotClient, RuntimeConnection } from \"@github/copilot-sdk\";\n\nconst client = new CopilotClient({\n    connection: RuntimeConnection.forUri(process.env.CLI_URL || \"localhost:4321\"),\n});\n\n// Process jobs from a queue\nasync function processJob(job: Job) {\n    const session = await client.createSession({\n        sessionId: `job-${job.id}`,\n        model: \"gpt-5.4\",\n    });\n\n    const response = await session.sendAndWait({\n        prompt: job.prompt,\n    });\n\n    await saveResult(job.id, response?.data.content);\n    await session.disconnect();  // Clean up after job completes\n}\n```\n\n### Docker Compose 部署\n\n```yaml\nversion: \"3.8\"\n\nservices:\n  copilot-cli:\n    image: copilot-cli:latest  # See \"Step 1\" above for how to build this image\n    command: [\"--headless\", \"--host\", \"0.0.0.0\", \"--port\", \"4321\"]\n    environment:\n      - COPILOT_GITHUB_TOKEN=${COPILOT_GITHUB_TOKEN}\n    ports:\n      - \"4321:4321\"\n    restart: always\n    volumes:\n      - session-data:/root/.copilot/session-state\n\n  api:\n    build: .\n    environment:\n      - CLI_URL=copilot-cli:4321\n    depends_on:\n      - copilot-cli\n    ports:\n      - \"3000:3000\"\n\nvolumes:\n  session-data:\n```\n\n![图示：显示所述过程的流程图。](/assets/images/help/copilot/copilot-sdk/setup-backend-services-diagram-4.png)\n\n## 健康检查\n\n监视 CLI 服务器的运行状况：\n\n```typescript\n// Periodic health check\nasync function checkCLIHealth(): Promise<boolean> {\n    try {\n        const status = await client.getStatus();\n        return status !== undefined;\n    } catch {\n        return false;\n    }\n}\n```\n\n## 会话清理\n\n后端服务应主动清理会话，以避免资源泄漏：\n\n```typescript\n// Clean up expired sessions periodically\nasync function cleanupSessions(maxAgeMs: number) {\n    const sessions = await client.listSessions();\n    const now = Date.now();\n\n    for (const session of sessions) {\n        const age = now - new Date(session.createdAt).getTime();\n        if (age > maxAgeMs) {\n            await client.deleteSession(session.sessionId);\n        }\n    }\n}\n\n// Run every hour\nsetInterval(() => cleanupSessions(24 * 60 * 60 * 1000), 60 * 60 * 1000);\n```\n\n## 局限性\n\n| Limitation               | 详细信息                                                                                          |\n| ------------------------ | --------------------------------------------------------------------------------------------- |\n| **单 CLI 服务器 = 单一故障点**    | 请参阅 [缩放和多租户](/zh/enterprise-cloud@latest/copilot/how-tos/copilot-sdk/setup/scaling) 了解 HA 模式。 |\n| **SDK 和 CLI 之间没有内置身份验证** | 确保网络路径安全（同一主机、VPC 等）                                                                          |\n| **本地磁盘上的会话状态**           | 挂载持久化存储，确保容器重启后数据不丢失                                                                          |\n| **30 分钟空闲超时**            | 无活动的会话会被自动清理                                                                                  |\n\n## 何时继续\n\n| 需要                                                                                            | 下一篇指南 |\n| --------------------------------------------------------------------------------------------- | ----- |\n| 多个 CLI 服务器/高可用性                                                                               |       |\n| [缩放和多租户](/zh/enterprise-cloud@latest/copilot/how-tos/copilot-sdk/setup/scaling)               |       |\n| 并发用户场景下的 SDK 隔离                                                                               |       |\n| [多租户与服务器部署](/zh/enterprise-cloud@latest/copilot/how-tos/copilot-sdk/setup/multi-tenancy)      |       |\n| 用户的 GitHub 账户身份验证                                                                             |       |\n| [GitHub OAuth 设置](/zh/enterprise-cloud@latest/copilot/how-tos/copilot-sdk/setup/github-oauth) |       |\n| 你自己的模型密钥                                                                                      |       |\n| [BYOK （自带密钥）](/zh/enterprise-cloud@latest/copilot/how-tos/copilot-sdk/auth/byok)              |       |\n\n## 后续步骤\n\n* **[多租户与服务器部署](/zh/enterprise-cloud@latest/copilot/how-tos/copilot-sdk/setup/multi-tenancy)**：为并发用户配置 SDK 隔离\n* **[缩放和多租户](/zh/enterprise-cloud@latest/copilot/how-tos/copilot-sdk/setup/scaling)**：处理更多用户，添加冗余\n* **[会话恢复和持久性](/zh/enterprise-cloud@latest/copilot/how-tos/copilot-sdk/features/session-persistence)**：重启后恢复会话\n* **[GitHub OAuth 设置](/zh/enterprise-cloud@latest/copilot/how-tos/copilot-sdk/setup/github-oauth)**：添加用户身份验证"}