config-file/config-reference.md +92 −15
128 description:128 description:
129 "Local Markdown policy instructions for automatic review. Managed `guardian_policy_config` takes precedence. Blank values are ignored.",129 "Local Markdown policy instructions for automatic review. Managed `guardian_policy_config` takes precedence. Blank values are ignored.",
130 },130 },
131 {
132 key: "auto_review.extra_policy",
133 type: "string",
134 description:
135 "Additional local Markdown policy for automatic review, included alongside the main policy. Managed `guardian_extra_policy` takes precedence. Blank values are ignored.",
136 },
131 {137 {
132 key: "allow_login_shell",138 key: "allow_login_shell",
133 type: "boolean",139 type: "boolean",
166 },172 },
167 {173 {
168 key: "windows.sandbox",174 key: "windows.sandbox",
169175 type: "unelevated | elevated", type: "unelevated | elevated | mxc",
170 description:176 description:
171 "Windows-only native sandbox mode when running Codex natively on Windows.",177 "Windows-only native sandbox mode when running Codex natively on Windows.",
172 },178 },
173 {
174 key: "windows.sandbox_private_desktop",
175 type: "boolean",
176 description:
177 "Run the final sandboxed child process on a private desktop by default on native Windows. Set `false` only for compatibility with the older `Winsta0\\\\Default` behavior.",
178 },
179 {179 {
180 key: "browser_use.allow_history_access",180 key: "browser_use.allow_history_access",
181 type: "boolean",181 type: "boolean",
1884 description:1884 description:
1885 "Managed Markdown policy instructions for automatic review. This takes precedence over local `[auto_review].policy`. Blank values are ignored.",1885 "Managed Markdown policy instructions for automatic review. This takes precedence over local `[auto_review].policy`. Blank values are ignored.",
1886 },1886 },
1887 {
1888 key: "guardian_extra_policy",
1889 type: "string",
1890 description:
1891 "Additional managed Markdown policy for automatic review, included alongside the main policy. This takes precedence over local `[auto_review].extra_policy`. Blank values are ignored.",
1892 },
1893 {
1894 key: "additional_developer_instructions",
1895 type: "string",
1896 description:
1897 "Managed developer instructions added as a separate developer message. Codex rejects instructions that exceed a limit of 10,000 estimated tokens, including context markers.",
1898 },
1899 {
1900 key: "auto_review",
1901 type: "table",
1902 description: "Managed automatic-review requirements.",
1903 },
1904 {
1905 key: "auto_review.required_on_models",
1906 type: "array<string>",
1907 description:
1908 "Model slugs that must use automatic review. Slugs must be non-empty, omit provider namespaces, and have no surrounding whitespace. Lists from multiple requirements sources are combined.",
1909 },
1910 {
1911 key: "auto_review.ignore_rules",
1912 type: "array<string>",
1913 description:
1914 "Full model slugs for which Codex ignores `allow` prefix rules in command execution policy. Match the slug exactly, including its provider namespace when present; unlike `required_on_models`, this does not accept a namespace-free alias. Deny and network rules still apply.",
1915 },
1887 {1916 {
1888 key: "allowed_permission_profiles",1917 key: "allowed_permission_profiles",
1889 type: "table<boolean>",1918 type: "table<boolean>",
1908 description:1937 description:
1909 "Require Codex service traffic to use a supported data residency. Currently accepts `us`.",1938 "Require Codex service traffic to use a supported data residency. Currently accepts `us`.",
1910 },1939 },
1940 {
1941 key: "model_provider",
1942 type: "string",
1943 description:
1944 "Enforce the model provider ID, overriding local and session configuration.",
1945 },
1946 {
1947 key: "model_providers",
1948 type: "map<string, table>",
1949 description:
1950 "Managed model provider definitions. Each entry replaces the complete configured provider with the same ID; fields aren't merged with the user's definition. Providers with other IDs remain available.",
1951 },
1952 {
1953 key: "model_providers.<id>",
1954 type: "table",
1955 description:
1956 "Complete managed provider definition. Uses the same provider fields as `config.toml`, including `name`, `base_url`, authentication, and transport settings.",
1957 },
1911 {1958 {
1912 key: "models",1959 key: "models",
1913 type: "table",1960 type: "table",
1963 key: "windows.allowed_sandbox_implementations",2010 key: "windows.allowed_sandbox_implementations",
1964 type: "array<string>",2011 type: "array<string>",
1965 description:2012 description:
19662013 "Allowed native Windows sandbox implementations for `windows.sandbox` (`elevated` and `unelevated`). The list must not be empty. When both are allowed and no mode is selected, Codex prefers `elevated`.", "Allowed legacy native Windows sandbox implementations (`elevated` and `unelevated`). The list must not be empty. When both are allowed and no mode is selected, Codex prefers `elevated`. This list does not restrict the `mxc` sandbox when it is available.",
1967 },
1968 {
1969 key: "windows.sandbox_private_desktop",
1970 type: "boolean",
1971 description:
1972 "Enforce whether the native Windows sandbox starts its child process on a private desktop.",
1973 },2014 },
1974 {2015 {
1975 key: "remote_sandbox_config",2016 key: "remote_sandbox_config",
2055 description:2096 description:
2056 "Set to `false` in `requirements.toml` to disable the built-in browser pane that users open and control directly.",2097 "Set to `false` in `requirements.toml` to disable the built-in browser pane that users open and control directly.",
2057 },2098 },
2099 {
2100 key: "features.in_app_chat",
2101 type: "boolean",
2102 description:
2103 "Set to `false` to hide ChatGPT and ChatGPT Work conversation screens and related cloud automation UI in the ChatGPT desktop app. This setting does not block ChatGPT Voice or stop existing cloud tasks. Setting it to `true` does not bypass account, workspace-permission, or rollout checks.",
2104 },
2105 {
2106 key: "features.in_app_dictation",
2107 type: "boolean",
2108 description:
2109 "Set to `false` to disable in-app dictation in the desktop app. Setting it to `true` does not bypass other availability checks.",
2110 },
2111 {
2112 key: "features.in_app_local_automation",
2113 type: "boolean",
2114 description:
2115 "Set to `false` to disable local scheduled tasks in the desktop app. Setting it to `true` does not bypass other availability checks.",
2116 },
2058 {2117 {
2059 key: "features.browser_use",2118 key: "features.browser_use",
2060 type: "boolean",2119 type: "boolean",
2106 description:2165 description:
2107 "Pin remote plugin catalog availability on or off for managed users.",2166 "Pin remote plugin catalog availability on or off for managed users.",
2108 },2167 },
2168 {
2169 key: "features.realtime_conversation",
2170 type: "boolean",
2171 description:
2172 "Set to `false` to disable the experimental `/voice` command in the Codex CLI. Do not rely on this setting to block [ChatGPT Voice](https://learn.chatgpt.com/docs/features/voice) in the desktop app or app-server voice sessions. Setting it to `true` does not bypass client or rollout checks.",
2173 },
2109 {2174 {
2110 key: "features.computer_use",2175 key: "features.computer_use",
2111 type: "boolean",2176 type: "boolean",
2392 description:2457 description:
2393 "Map-shaped administrator domain policy for sandboxed networking. Supports exact hosts, `*.example.com` for subdomains only, `**.example.com` for apex plus subdomains, and global `*` allow rules; prefer scoped rules because `*` broadly opens public outbound access. `deny` wins on conflicts. Do not combine this with `experimental_network.allowed_domains` or `experimental_network.denied_domains`.",2458 "Map-shaped administrator domain policy for sandboxed networking. Supports exact hosts, `*.example.com` for subdomains only, `**.example.com` for apex plus subdomains, and global `*` allow rules; prefer scoped rules because `*` broadly opens public outbound access. `deny` wins on conflicts. Do not combine this with `experimental_network.allowed_domains` or `experimental_network.denied_domains`.",
2394 },2459 },
2460 {
2461 key: "experimental_network.domains.<pattern>",
2462 type: "allow | deny",
2463 description:
2464 "Allow or deny sandboxed network access for the matching domain pattern. A deny rule wins when several patterns match.",
2465 },
2395 {2466 {
2396 key: "experimental_network.allowed_domains",2467 key: "experimental_network.allowed_domains",
2397 type: "array<string>",2468 type: "array<string>",
2414 key: "experimental_network.unix_sockets",2485 key: "experimental_network.unix_sockets",
2415 type: "map<string, allow | deny>",2486 type: "map<string, allow | deny>",
2416 description:2487 description:
24172488 "Administrator-managed Unix socket policy for sandboxed networking.", "Administrator-managed Unix socket allowlist for sandboxed networking on macOS. Paths must be absolute.",
2489 },
2490 {
2491 key: "experimental_network.unix_sockets.<path>",
2492 type: "allow | deny",
2493 description:
2494 "On macOS, `allow` adds an absolute Unix socket path to the allowlist; `deny` leaves it out. A `deny` entry cannot block a socket when allow-all Unix sockets is enabled.",
2418 },2495 },
2419 {2496 {
2420 key: "experimental_network.allow_local_binding",2497 key: "experimental_network.allow_local_binding",