Mit einem Gateway verbinden
Verbinden Sie Codex mit einem LLM-Gateway. Verwenden Sie dazu die Gateway-URL, den Modellalias und die Zugangsdaten oder den Token-Resolver, die Ihre Organisation bereitstellt.
Auf eine vorhandene Konfiguration prüfen
Prüfen Sie vor dem Hinzufügen von Einstellungen, ob Ihr Administrator Codex bereits konfiguriert hat.
- Prüfen Sie für die CLI das ausgewählte Profil und führen Sie
codex doctoraus. Verwenden Sie nach dem Start/status, um das aktive Modell und den aktiven Anbieter zu bestätigen. - Prüfen Sie für die macOS-App
~/.codex/config.tomloder die verwaltete Konfiguration, die Ihre Organisation bereitstellt. - Prüfen Sie für die Windows-App
%USERPROFILE%\.codex\config.tomloder die Systemkonfiguration, die Ihre Organisation bereitstellt.
Wenn der erwartete Gateway-Anbieter und das erwartete Modell bereits aktiv sind, fahren Sie mit Verbindung überprüfen fort.
Gateway-Verbindungsdaten einholen
Installieren Sie die Codex CLI oder die von Ihrer Organisation freigegebene Desktop-App. Wenn Sie Codex selbst konfigurieren möchten, holen Sie diese Werte bei Ihrem Gateway-Team ein:
- Die HTTPS-Basis-URL des Gateways einschließlich ihres API-Pfads, etwa
https://gateway.example.com/v1. - Den zu verwendenden Modellnamen und die Anbieter-ID.
- Ihre Gateway-Zugangsdaten mit begrenztem Berechtigungsumfang und die zugehörige Umgebungsvariable oder einen installierten Token-Resolver und dessen Konfiguration.
- Eine gegebenenfalls erforderliche Modellkatalogdatei und ihren absoluten lokalen Pfad.
Anbieter konfigurieren
Öffnen Sie config.toml unter ~/.codex/config.toml auf macOS oder Linux beziehungsweise unter
%USERPROFILE%\.codex\config.toml auf Windows.
Fügen Sie dieses Beispiel in Ihre vorhandene Konfiguration ein und ersetzen Sie URL und Modell
durch die Werte Ihres Administrators. Fügen Sie keine zweite Definition eines
vorhandenen Schlüssels oder einer vorhandenen Tabelle hinzu. Dieses Beispiel verwendet gpt-6-sol; verwenden Sie es ohne benutzerdefinierten
Katalog nur, wenn Ihr Administrator bestätigt, dass Ihre Codex-Version
das Modell erkennt und dessen mitgelieferte Metadaten zum Gateway passen.
model = "gpt-6-sol"
model_provider = "enterprise-gateway"
web_search = "disabled"
[model_providers.enterprise-gateway]
name = "Organization Gateway"
base_url = "https://gateway.example.com/v1"
wire_api = "responses"
env_key = "CODEX_GATEWAY_API_KEY"Wenn Ihr Administrator einen Modellkatalog bereitstellt, speichern Sie ihn lokal und fügen Sie
model_catalog_json vor der ersten TOML-Tabelle hinzu. Verwenden Sie dabei den absoluten Pfad der Datei.
Benutzerdefinierte Aliasse benötigen passende Katalogmetadaten. Beispiel:
model_catalog_json = "/etc/codex/gateway-models.json"Verwenden Sie den Modellnamen und den Katalog, die Ihr Administrator zusammen bereitstellt. Fügen Sie nur dann einen Katalogpfad hinzu, wenn die Datei an diesem Speicherort vorhanden ist.
enterprise-gateway ist eine beispielhafte Anbieter-ID. Verwenden Sie dieselbe ID in
model_provider, [model_providers.<id>] und [model_providers.<id>.auth].
Dieses Beispiel deaktiviert die Websuche
für den ersten Verbindungstest; Ihr Administrator sollte die Unterstützung dieser Funktion prüfen,
bevor er sie aktiviert.
Stellen Sie Ihre Gateway-Zugangsdaten als CODEX_GATEWAY_API_KEY in der
Umgebung des Prozesses bereit, der Codex startet. Nutzen Sie dazu den Mechanismus Ihrer Organisation
zur Bereitstellung von Geheimnissen. Speichern Sie die Zugangsdaten weder in TOML noch in einem Repository. Eine Variable,
die in einem Terminal gesetzt wurde, ist für eine vom Desktop gestartete App möglicherweise nicht verfügbar.
Einen benutzerdefinierten Authentifizierungsheader verwenden
Wenn Ihr Gateway einen Header wie X-API-Key anstelle eines Bearer-Tokens erfordert,
ersetzen Sie env_key in der Anbietertabelle durch:
env_http_headers = { "X-API-Key" = "CODEX_GATEWAY_API_KEY" }Verwenden Sie genau den Headernamen, den Ihr Administrator vorgibt. Codex liest den Wert aus
der benannten Umgebungsvariable; speichern Sie die Zugangsdaten nicht in der Konfigurationsdatei.
Weitere Informationen finden Sie in der Konfigurationsreferenz zu
model_providers.<id>.env_http_headers.
Einen Zugangsdaten-Helfer Ihrer Organisation verwenden
Wenn Ihr Administrator eine befehlsbasierte Authentifizierung bereitstellt, verwenden Sie den von ihm installierten
Helfer und dessen Konfiguration anstelle von env_key. Konfigurieren Sie nicht beide Mechanismen.
Der Helfer muss auf Ihrem Computer vorhanden sein; Codex installiert ihn nicht. Ersetzen Sie beispielsweise
die Beispieleinstellung env_key durch diese Tabelle und verwenden Sie den Resolver-Pfad sowie die
Argumente, die Ihr Administrator bereitstellt:
[model_providers.enterprise-gateway.auth]
command = "/usr/local/bin/fetch-codex-gateway-token"
args = ["print-token"]
timeout_ms = 30000
refresh_interval_ms = 300000Die Referenz zur Authentifizierung bei benutzerdefinierten Anbietern definiert den Befehl, die Argumente, das Zeitlimit, das Aktualisierungsintervall und die Vorgaben für die Token-Ausgabe. Fragen Sie Ihren Administrator, wie Sie Ihre Anmeldung erneuern können, wenn der Helfer kein Token mehr abrufen kann.
Verwenden Sie aufgelöste absolute Pfade für ausführbare Helferdateien und Katalogdateien.
CLI konfigurieren
Die CLI liest unter macOS oder Linux standardmäßig ~/.codex/config.toml. Führen Sie nach dem Speichern
der Anbietereinstellungen codex aus. Verwenden Sie innerhalb von WSL die Linux-Konfiguration und
Linux-Pfade, sofern CODEX_HOME nicht auf einen anderen Speicherort verweist.
macOS-App konfigurieren
Die macOS-App liest dieselbe ~/.codex/config.toml. Starten Sie nach dem Speichern der Anbietereinstellungen die App neu. Wenn Sie für die Zugangsdaten eine Umgebungsvariable verwenden,
stellen Sie sicher, dass sie für den App-Prozess verfügbar ist.
Windows-App konfigurieren
Tragen Sie die Anbietereinstellungen in %USERPROFILE%\.codex\config.toml ein und starten Sie anschließend
die App neu. Verwenden Sie für die befehlsbasierte Authentifizierung den von Ihrem
Administrator installierten Resolver. Ersetzen Sie beispielsweise die Unix-Authentifizierungstabelle durch:
[model_providers.enterprise-gateway.auth]
command = 'C:\Program Files\OpenAI\Codex\fetch-codex-gateway-token.exe'
args = ["print-token"]
timeout_ms = 30000
refresh_interval_ms = 300000In TOML unter Windows bleiben Backslashes in literalen Zeichenfolgen mit einfachen Anführungszeichen erhalten. Ersetzen Sie
auch Unix-Katalogpfade, beispielsweise durch
'C:\ProgramData\OpenAI\Codex\models.json', und verwenden Sie dabei den tatsächlichen Pfad, den Ihr
Administrator bereitgestellt hat.
Konfigurieren Sie MCP server und Plugins separat. Zugangsdaten für ein Modell-Gateway berechtigen nicht zum Zugriff auf Ihre Tools oder verbundenen Systeme.
Verbindung überprüfen
Starten Sie den Client nach Änderungen an der Konfiguration neu. Starten Sie in der CLI codex
und prüfen Sie mit /status das aktive Modell und den aktiven Anbieter. Prüfen Sie in der Desktop-App
das ausgewählte Modell und die Konfiguration.
Senden Sie diesen Prompt in einer neuen Aufgabe:
Reply with exactly: gateway-okDie erwartete Antwort ist gateway-ok. Eine Antwort allein belegt nicht, über welche Route sie verarbeitet wurde: Bitten Sie
Ihren Administrator zu bestätigen, dass das Gateway Ihren Nutzer, den Modellalias
und die vorgesehene Upstream-Route protokolliert hat. Identifizieren Sie das Modell nicht, indem Sie es nach seinem Namen fragen.
Damit ist eine erste Verbindung überprüft. Administratoren sollten außerdem die Prüfungen zur Einführung für Streaming, Tools und Folgerunden durchführen.
Verbindungsprobleme beheben
| Symptom | Was Sie prüfen sollten |
|---|---|
| Der erwartete Anbieter ist nicht aktiv. | Prüfen Sie das ausgewählte Profil und die Rangfolge der Konfigurationen. Stellen Sie sicher, dass sich Schlüssel der obersten Ebene nicht innerhalb einer Anbietertabelle befinden. |
| Die Authentifizierung schlägt fehl. | Prüfen Sie, ob die Zugangsdatenvariable den Client-Prozess erreicht oder ob der installierte Helfer ein aktuelles Token abrufen kann. Bitten Sie den Administrator, zwischen Gateway-Authentifizierung und Upstream-Authentifizierung zu unterscheiden. |
| Das Modell wird nicht gefunden. | Bestätigen Sie den bereitgestellten Modellnamen und bitten Sie den Administrator, dessen Route zu prüfen. |
| Das Modell verwendet unerwartete Fähigkeiten. | Bitten Sie den Administrator zu prüfen, ob die Katalogmetadaten zum Modell hinter dem Alias passen. |
| Streaming stockt oder Folgerunden schlagen fehl. | Bitten Sie den Gateway-Verantwortlichen, die Proxy-Pufferung, das abschließende response.completed-Ereignis und die Gateway-Kompatibilität zu prüfen. |
| Ein Katalog- oder Helferpfad funktioniert nicht. | Stellen Sie sicher, dass die Datei unter dem konfigurierten absoluten Pfad in der Umgebung vorhanden ist, in der Codex ausgeführt wird. |
Wenn Sie Hilfe anfordern, fügen Sie die Fehlermeldung bei und entfernen Sie zuvor Tokens und vertrauliche Prompts daraus.
Eine vorhandene Gateway-Bereitstellung verwenden
Wenn Ihre Organisation bereits ein Gateway mit einem anderen Programmiertool verwendet, können Sie möglicherweise dessen Netzwerkpfad, Protokollierung und Anbieterzugriff wiederverwenden. Arbeiten Sie mit Ihrem Gateway-Team zusammen, um eine Codex-Verbindung zu konfigurieren und zu testen:
- Ermitteln Sie die vorhandene Gateway-URL, den Zugangsdatenmechanismus, erforderliche Header, Modellrouten und die Methode zur Bereitstellung der Konfiguration.
- Bitten Sie Ihr Gateway-Team zu bestätigen, dass das Gateway das von Codex erforderliche API-Verhalten unterstützt, und eine Codex-Modellroute zu konfigurieren.
- Besorgen Sie sich von Ihrem Gateway-Team Gateway-Zugangsdaten mit begrenztem Berechtigungsumfang oder einen Zugangsdaten-Helfer, den Modellnamen und einen gegebenenfalls erforderlichen Modellkatalog.
- Konfigurieren Sie Codex mit diesen Werten.
- Überprüfen Sie die Verbindung in der CLI oder Desktop-App, die Sie verwenden möchten. Lassen Sie Ihr Gateway-Team die Prüfungen für Streaming, Tools und Folgerunden durchführen.
- Folgen Sie nach einem erfolgreichen Pilotversuch der Anleitung Codex über ein Gateway bereitstellen, um die Konfiguration an weitere Entwickler zu verteilen.
Die Migrationscheckliste für Administratoren und die Zuordnung der Konfigurationseinstellungen finden Sie unter Eine vorhandene Gateway-Bereitstellung wiederverwenden.