You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: expand README with config sharing, MCP notes, and more examples
- Add detailed usage examples (full-auto, quiet mode)
- Document ~/.codex folder structure and custom instructions
- Add MCP support section with limitations and workarounds
- Clarify OAuth two-step login process with port exposure
- Update docker-compose to mount ~/.codex from host
- Add shell alias convenience section
- Add Docker-in-Docker sandbox mode docs
|`OPENAI_API_BASE`| No | Custom API endpoint (for proxies) |
279
+
|`OPENAI_API_BASE`| No | Custom API endpoint |
139
280
140
281
*Required unless using OAuth login
141
282
@@ -145,6 +286,36 @@ docker run -it --rm \
145
286
|------|---------|
146
287
| 1455 | OAuth callback for `codex login`|
147
288
289
+
## Utility Commands
290
+
291
+
```bash
292
+
# Check version
293
+
docker run --rm ungb/codex codex --version
294
+
295
+
# Show help
296
+
docker run --rm ungb/codex codex --help
297
+
298
+
# View configuration
299
+
docker run --rm \
300
+
-v ~/.codex:/home/coder/.codex \
301
+
ungb/codex \
302
+
cat /home/coder/.codex/config.json
303
+
```
304
+
305
+
## Sandbox Mode
306
+
307
+
Codex recommends Docker for sandboxing. When you run Codex inside this container, it's already isolated from your host system.
308
+
309
+
For nested Docker (Docker-in-Docker), mount the Docker socket:
310
+
311
+
```bash
312
+
docker run -it --rm \
313
+
-v $(pwd):/workspace \
314
+
-v /var/run/docker.sock:/var/run/docker.sock \
315
+
-e OPENAI_API_KEY=$OPENAI_API_KEY \
316
+
ungb/codex
317
+
```
318
+
148
319
## Building Locally
149
320
150
321
```bash
@@ -157,8 +328,6 @@ docker build -t codex .
157
328
158
329
### Permission Denied on Mounted Files
159
330
160
-
The container runs as user `coder` (UID 1000). If you have permission issues:
161
-
162
331
```bash
163
332
# Run with your user ID
164
333
docker run -it --rm \
@@ -170,8 +339,6 @@ docker run -it --rm \
170
339
171
340
### Git Operations Failing
172
341
173
-
Ensure SSH keys are mounted and git is configured:
174
-
175
342
```bash
176
343
docker run -it --rm \
177
344
-v $(pwd):/workspace \
@@ -188,22 +355,25 @@ Ensure port 1455 is exposed:
188
355
```bash
189
356
docker run -it --rm \
190
357
-p 1455:1455 \
191
-
-v $(pwd):/workspace \
192
-
-v codex-config:/home/coder/.codex \
358
+
-v ~/.codex:/home/coder/.codex \
193
359
ungb/codex \
194
360
codex login
195
361
```
196
362
197
-
## Sandbox Mode
363
+
## Shell Alias (Convenience)
198
364
199
-
Codex supports running in sandbox mode using Docker. When you run Codex inside this container, it's already isolated. For nested Docker support (Docker-in-Docker), mount the Docker socket:
0 commit comments