{"meta":{"title":"バックエンド サービスのセットアップ","intro":"サーバー側アプリケーション (API、Web バックエンド、マイクロサービス、バックグラウンド ワーカー) で Copilot SDK を実行します。 CLI は、バックエンド コードがネットワーク経由で接続するヘッドレス サーバーとして実行されます。","product":"GitHub Copilot","breadcrumbs":[{"href":"/ja/copilot","title":"GitHub Copilot"},{"href":"/ja/copilot/how-tos","title":"方法"},{"href":"/ja/copilot/how-tos/copilot-sdk","title":"Copilot SDK"},{"href":"/ja/copilot/how-tos/copilot-sdk/setup","title":"Copilot SDK を設定する"},{"href":"/ja/copilot/how-tos/copilot-sdk/setup/backend-services","title":"バックエンド サービス"}],"documentType":"article"},"body":"# バックエンド サービスのセットアップ\n\nサーバー側アプリケーション (API、Web バックエンド、マイクロサービス、バックグラウンド ワーカー) で Copilot SDK を実行します。 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\nSDK が CLI 子プロセスを生成する代わりに、 **ヘッドレス サーバー モード**で 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 クライアントが 1 つの CLI サーバーを共有できる\n* 任意の認証方法 (GitHub トークン、env vars、BYOK) で動作します\n\nマルチユーザー サーバー モードの場合は、 `mode: \"empty\"`を使用して SDK クライアントを構成し、セッションごとにユーザー資格情報を渡し、セッションごとにツールを明示的に許可します。 完全なパターンについては [、AUTOTITLE](/ja/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\nCLI をバックグラウンド サーバーとして実行します。\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 イメージはありません。\n> [GitHub releases](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セッションの作成時に個々のユーザー トークンを渡します。 完全なフローについては [、AUTOTITLE](/ja/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 (独自のキーを持ち込む)](/ja/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\nCLI サーバーの正常性を監視します。\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| 制限事項                        | 詳細情報                                                                                   |\n| --------------------------- | -------------------------------------------------------------------------------------- |\n| **単一 CLI サーバー = 単一障害点**     | HA パターンについては [スケーリングとマルチテナント](/ja/copilot/how-tos/copilot-sdk/setup/scaling) を参照してください |\n| **SDK と CLI の間に組み込みの認証がない** | ネットワーク パス (同じホスト、VPC など) をセキュリティで保護する                                                  |\n| **ローカル ディスク上のセッション状態**      | コンテナーの再起動用に永続ストレージをマウントする                                                              |\n| **30 分間の無操作タイムアウト**         | アクティビティのないセッションは自動クリーンアップされます                                                          |\n\n## 次に進むタイミング\n\n| 必要                                                                         | 次のガイドへ |\n| -------------------------------------------------------------------------- | ------ |\n| 複数の CLI サーバー/高可用性                                                          |        |\n| [スケーリングとマルチテナント](/ja/copilot/how-tos/copilot-sdk/setup/scaling)            |        |\n| 同時実行ユーザーの SDK 分離                                                           |        |\n| [マルチテナントとサーバーの展開](/ja/copilot/how-tos/copilot-sdk/setup/multi-tenancy)     |        |\n| ユーザー向け GitHub アカウント認証                                                      |        |\n| [GitHub OAuth のセットアップ](/ja/copilot/how-tos/copilot-sdk/setup/github-oauth) |        |\n| 独自のモデル キー                                                                  |        |\n| [BYOK (独自のキーを持ち込む)](/ja/copilot/how-tos/copilot-sdk/auth/byok)             |        |\n\n## 次のステップ\n\n* **[マルチテナントとサーバーの展開](/ja/copilot/how-tos/copilot-sdk/setup/multi-tenancy)**: 同時実行ユーザーの SDK 分離を構成する\n* **[スケーリングとマルチテナント](/ja/copilot/how-tos/copilot-sdk/setup/scaling)**: より多くのユーザーを処理し、冗長性を追加する\n* **[セッションの再開と永続化](/ja/copilot/how-tos/copilot-sdk/features/session-persistence)**: 再起動の間にセッションを再開する\n* **[GitHub OAuth のセットアップ](/ja/copilot/how-tos/copilot-sdk/setup/github-oauth)**: ユーザー認証を追加する"}