コンテンツにスキップ

サーバーとランタイムの構成

サーバー設定は、ローカル プロキシがリッスンする方法、リモート トラフィックを保護する方法、リソースを管理する方法、およびプロバイダー要求に関するヘルパー機能を実行する方法を制御します。

フィールド タイプ デフォルト 意味
port number 10100 プロキシリッスンポート。
hostname? string "127.0.0.1" バインドアドレス。非ループバック バインドには OPENCODEX_API_AUTH_TOKEN が必要です。
proxy? string 送信 HTTP(S) プロキシ URL または ${ENV_VAR}。これらの変数が設定されていない場合にのみ、HTTP_PROXY / HTTPS_PROXY に適用されます。ループバックは NO_PROXY に残ります。
stallTimeoutSec? number 300 response.incomplete より前にアップストリーム データがない秒数。最小 1。
connectTimeoutMs? number 200000 試行ごとの DNS/TCP/TLS/最終ヘッダーの期限。本体が生成される前に終了します。
shutdownTimeoutMs? number 5000 アクティブなターンが中止される前の正常な排出期限。
websockets? boolean false 応答 WebSocket パスとして supports_websockets をアドバタイズします。 False は HTTP/SSE を維持します。
corsAllowOrigins? string[] [] 追加の正確な CORS 起点。ループバック起点は常に許可されます。
apiKeys? OcxApiKey[] [] 生成された ocx_… 資格情報は、非ループバック バインドでの管理およびデータ プレーン認証によって受け入れられました。ダッシュボードで管理。
storageCleanupPolicy? StorageCleanupPolicy 無効 アーカイブされたセッションのクリーンアップ ポリシーをオプトインします。暗黙的に有効になることはありません。
appOwnedMemoryBudgetMb? number 256 排除可能なアプリ所有のログ、キャッシュ、BLOB、および継続ペイロードの MiB の上限。範囲は 64 ~ 4096。 RSSキャップではありません。
codexAutoStart? boolean true Codex を起動する前に、Codex シムで ocx ensure を実行させます。 False を指定すると、操作が行われないことが保証されます。
codexShimAutoRestore? boolean true 完了した外部 Codex アップデートによってインストールされたシムが置き換えられた後、インストールされているシムを復元します。環境オプトアウト: OPENCODEX_CODEX_SHIM_AUTO_RESTORE=0
syncResumeHistory? boolean true Codex App 履歴の互換性を元に戻すことができます。元のメタデータは ocx stop / ocx restore によってバックアップおよび復元されます。
shadowCallIntercept? { enabled?: boolean; model?: string; sourceModels?: string[] } オフ 認識された Codex ヘルパー/シャドウ呼び出しを、少ない労力で選択したモデルにリダイレクトします。デフォルトのソースプレフィックスは gpt-5.4-mini および gpt-5.6-luna です。
webSearchSidecar? OcxWebSearchSidecarConfig 使用可能な場合はオン Web 検索サイドカー オプション。
visionSidecar? OcxVisionSidecarConfig 使用可能な場合はオン 画像説明サイドカー オプション。
images? OcxImagesConfig OpenAI の自動選択 Codex image_gen のスタンドアロン イメージ リレー オプション。

バックアップ サポートが存在する前に古い開発ビルドで再開履歴メタデータが変更された場合は、ocx recover-history --legacy-openai を実行してネイティブ プロバイダーの回復を強制します。

デフォルトの 127.0.0.1 バインドはループバックのみです。 0.0.0.0 などの非ループバック アドレスには、/api/* とデータ プレーンの両方でトークン認証が必要です。開始する前にトークンをエクスポートします。

Terminal window
export OPENCODEX_API_AUTH_TOKEN="your-secret-token"
ocx start

プロキシは、この変数がないとリモート バインドを拒否します。バックグラウンド サービスの場合は、ocx service install の前にエクスポートして、launchd、systemd、またはタスク スケジューラがそれを受信できるようにします。クライアントは以下を送信する必要があります:

x-opencodex-api-key: your-secret-token
エンドポイント Authorization: Bearer x-opencodex-api-key x-api-key
/v1/responses 受け入れられません 必須 受け入れられません
/v1/chat/completions 受け入れられません 必須 受け入れられません
/v1/messages 受け入れられました 受け入れられました 受け入れられました
/v1/models 受け入れられました 受け入れられました 受け入れられました

応答とチャット完了では、Codex Direct パススルーの可能性のために Authorization を予約しているため、そこでは専用のアドミッション ヘッダーのみが受け入れられます。ダッシュボードで生成された apiKeys は、起動後に環境トークンを置き換える可能性があります。候補は一定時間内に比較されます。

リモート使用にはリモート バインドは必要ありません。ループバックを維持して転送します。

Terminal window
ssh -L 20100:localhost:10100 you@remote

任意のローカル ポートが機能します。ホストが localhost127.0.0.1、または ::1 に解決されるリクエストは、ポートに関係なくループバックのままであるため、http://localhost:20100/v1 が機能します。そのベース URL をクライアントに設定します。 ocx は、デフォルトのローカル 127.0.0.1 アドレスのみを管理対象クライアント設定に書き込みます。

プロバイダー OAuth コールバックは、固定リモート ポートでリッスンします。リモート マシンにログインするか、そのポートも転送します。

Terminal window
ssh -L 20100:localhost:10100 -L 1455:localhost:1455 you@remote

storageCleanupPolicy はデフォルトでは無効になっています。有効にすると、アーカイブされたバイト数が trigger.archivedBytesOver を超えた後、startupdailyweekly、または manual で実行されます。 target.reduceToBytes または target.removeOldestPercent のいずれかに向かって最も古いアーカイブが選択されます。 mode のデフォルトは quarantine です。 permanent は、明示的な破壊的な選択としてのみ使用してください。ポリシーは lastRun および nextRun を維持します。 [ストレージ] ページまたは GET/PUT /api/storage/cleanup-policy で設定します。 POST /api/storage/cleanup-policy/run を使用して手動実行をトリガーします。

これらの設定は、/v1/messagesocx claude ランチャー、および Claude ダッシュボード ページを制御します。

キー タイプ デフォルト 説明
claudeCode.bodyStallSec? number 90 合計時間ではなく、読み取り保留中のネイティブ パススルー ボディの非アクティブ バジェット (秒単位)。最小 1。正確には 0 が無効になります。
claudeCode.bodyMaxBytes? number 67108864 ストリーミングおよびバッファリングされた応答の累積的なネイティブ パススルー ボディ キャップ。まさに 0 が無効になります。
claudeCode.authMode? "proxy" | "subscription" 自動 起動による ANTHROPIC_AUTH_TOKEN の処理方法。起動ごとに認証を自動検出します。明示的な値は決してオーバーライドされません。
claudeCode.authModeMigratedAt? string 設定を解除する 内部のワンタイムアップグレードマーカー。手動で設定しないでください。
claudeCode.subagentEffort? "low" | "medium" | "high" | "xhigh" | "max" 継承 生成された ~/.claude/agents/ocx-*.md に書き込まれる作業量。 Codex のガイダンスおよびプロキシの上限とは別のものです。 ocx claude を通じて再起動して再生成します。

自動認証では、保存されているクロード認証が見つかった場合はサブスクリプションが選択され、見つからない場合はプロキシが選択され、検出が決定的でない場合は警告付きのサブスクリプションが選択されます。 クロードコード認証モードを参照してください。

Codex は、タイトルやコミット メッセージなどのタスクに小さなヘルパー モデルを使用します。 shadowCallIntercept を有効にして、認識されたソース モデル プレフィックスを別の構成済みモデルにリダイレクトします。交換作業は少ない労力で実行されます。クライアントが異なるヘルパー ID を使用する場合にのみ、sourceModels を設定します。

{
"shadowCallIntercept": {
"enabled": true,
"model": "gpt-5.5",
"sourceModels": ["gpt-5.4-mini", "gpt-5.6-luna"]
}
}
フィールド タイプ デフォルト 意味
provider? string OpenAI の自動選択 /v1/images/generations および /v1/images/edits の明示的なカスタム API キー openai-responses プロバイダー。レジストリで管理されている ID は拒否されます。
timeoutMs? number 300000 1 つのスタンドアロン イメージ リクエストのリクエスト全体のタイムアウト。

プロバイダーが見つからない、無効になっている、互換性がない、または使用可能なキーがない場合、明示的な選択は失敗して閉じられます。別の有料アップストリームにフォールバックすることはありません。エンドポイントは、Codex が期待する OpenAI Images API パスと応答形状を実装する必要があります。

webSearchSidecar (OcxWebSearchSidecarConfig)

Section titled “webSearchSidecar (OcxWebSearchSidecarConfig)”
フィールド タイプ デフォルト 意味
enabled? boolean 使用可能な場合はオン マスタースイッチ。
backend? "openai" | "anthropic" 自動 明示的な勝利。それ以外の場合は使用可能な保存された Anthropic OAuth は anthropic を選択し、次に openai を選択します。
model? string バックエンド依存 OpenAI の場合は gpt-5.6-luna、Anthropic の場合は claude-sonnet-5。従来の明示的な gpt-5.4-mini は開始時に移行されます。
reasoning? string low サイドカーの取り組み。 minimal は Web 検索で拒否されます。
maxSearchesPerTurn? number 3 メインモデルのターンごとに許可される実際の検索。
routedModelStallTimeoutMs? number 200000 設定ファイルのみのルーテッド モデルの raw ボディの非アクティブ期限。整数 1 ~ 2147483647。空でないすべてのチャンクがリセットされます。
timeoutMs? number 60000 1 つのホストされた検索の期限。

OpenAI バックエンドには、ChatGPT ログインと有効な ChatGPT forward プロバイダーが必要です。クロードインバウンドのルーティングされたリプレイは、メインの ChatGPT 認証を内部リクエストに挿入します。 Anthropic バックエンドは、有効な Anthropic OAuth プロバイダーからのアクティブに保存された資格情報を使用します。使用可能なアカウントがない、明示的に選択された Anthropic バックエンドは、フォールバックせずに失敗して閉じられます。 Anthropic executor は、ネイティブの web_search_20250305 ツールを使用します。

検索は 4 つのクロック (ベース stallTimeoutSecconnectTimeoutMs、ルーテッド モデルの非アクティビティ、ホスト型検索のタイムアウト) によって制御されます。有効なブリッジ ウォッチドッグは、最大プラス 30 秒です。ルート ストールは非アクティブ ガードであり、総生成期限ではありません。

フィールド タイプ デフォルト 意味
enabled? boolean 使用可能な場合はオン マスターイメージと説明のスイッチ。
backend? "openai" | "anthropic" 自動 Web 検索と同じ、明示的優先、人間認証情報を意識した選択。
model? string バックエンド依存 OpenAI の場合は gpt-5.4-mini、Anthropic の場合は claude-sonnet-5
maxDescriptionsPerTurn? number 8 新しい説明のキャッシュミスはメインターンごとに許可されます。 0 は通話を無効にします。無効な値にはデフォルトが使用されます。
timeoutMs? number 45000 サイドカーのフェッチタイムアウト。

Vision は、プロバイダーの noVisionModels のモデルに送信された画像に対してのみアクティブになります。 OpenAI には、検索と同じログイン/転送要件があります。明示的に選択された Anthropic は、使用可能な認証情報がないと失敗します。成功した data: 記述では、バックエンド、モデル、詳細、画像バイト、および正規化されたメッセージ コンテキストをキーとした境界付きキャッシュが使用されます。ヒットと同じターンの重複は制限を消費しません。リモート https: イメージと失敗した説明、または空の説明はキャッシュされません。

Anthropic OAuth サイドカーは、opencodex の既存のクロード コード OAuth フィンガープリントを再利用します。対象のアカウントとワークロードをソークテストします。