CodexApp/README.html at main · Robert-GitHubUserName/CodexApp · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>OpenAI Codex CLI Docker Setup</title>
    <style>
        body {
            font-family: Arial, sans-serif;
            line-height: 1.6;
            margin: 20px;
            background-color: #121212;
            color: #e0e0e0;
        }
        pre {
            background: #1e1e1e;
            padding: 10px;
            border: 1px solid #333;
            border-radius: 5px;
            overflow-x: auto;
            color: #dcdcdc;
        }
        code {
            font-family: Consolas, Monaco, "Andale Mono", "Ubuntu Mono", monospace;
            background: none;
            color: #dcdcdc;
        }
        h1, h2, h3 {
            color: #ffffff;
        }
        blockquote {
            margin: 10px 0;
            padding: 10px;
            background: #2a2a2a;
            border-left: 5px solid #555;
        }
        .copy-btn {
            position: absolute;
            top: 10px;
            right: 10px;
            background: #007bff;
            color: white;
            border: none;
            padding: 5px 10px;
            border-radius: 3px;
            cursor: pointer;
            font-size: 12px;
        }
        .copy-btn:hover {
            background: #0056b3;
        }
        .hljs {
            background: none;
            color: #dcdcdc;
        }
        .hljs-keyword, .hljs-selector-tag, .hljs-literal, .hljs-section, .hljs-link {
            color: #569cd6;
        }
        .hljs-string, .hljs-title, .hljs-name, .hljs-type, .hljs-attribute, .hljs-symbol, .hljs-bullet {
            color: #d69d85;
        }
        .hljs-comment {
            color: #6a9955;
        }
        .code-block {
            position: relative;
            margin-bottom: 1.5em;
        }
    </style>
    <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.7.0/highlight.min.js"></script>
    <script>
        document.addEventListener("DOMContentLoaded", () => {
            document.querySelectorAll("pre code").forEach((block) => {
                hljs.highlightElement(block);
            });
        });

        function copyToClipboard(button, codeId) {
            const code = document.getElementById(codeId).innerText;
            navigator.clipboard.writeText(code).then(() => {
                button.innerText = "Copied!";
                setTimeout(() => (button.innerText = "Copy"), 2000);
            });
        }
    </script>
</head>
<body>
    <h1>OpenAI Codex CLI Docker Setup</h1>
    <p>This repository demonstrates how to run the OpenAI Codex CLI inside a Docker container with your local Windows folder mounted for development. It uses an <code>.env</code> file to securely provide your API key and includes <code>.gitignore</code> and <code>.dockerignore</code> to keep secrets and unnecessary files out of version control.</p>    <h2>Project Structure</h2>
    <div class="code-block">
        <pre id="code1"><code class="plaintext">C:\CodexApp
├── Dockerfile
├── docker-compose.yml
├── .env
├── .gitignore
└── .dockerignore
        </code></pre>
        <button class="copy-btn" onclick="copyToClipboard(this, 'code1')">Copy</button>
    </div>

    <h2>1. Prerequisites</h2>
    <ul>
        <li><a href="https://www.docker.com/products/docker-desktop" target="_blank">Docker Desktop</a> installed and running on Windows</li>
        <li>A valid OpenAI API key</li>
    </ul>    <h2>2. Create the <code>.env</code> file</h2>
    <p>In <code>C:\CodexApp\.env</code>, add:</p>
    <div class="code-block">
        <pre id="code2"><code class="env">OPENAI_API_KEY=sk-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
        </code></pre>
        <button class="copy-btn" onclick="copyToClipboard(this, 'code2')">Copy</button>
    </div>

    <blockquote>
        <strong>Note:</strong>
        <ul>
            <li>Never commit the <code>.env</code> file to Git.</li>
            <li>Rotate or revoke your key by updating this file.</li>
        </ul>
    </blockquote>

    <h2>3. Add Git and Docker ignores</h2>
    <h3><code>.gitignore</code></h3>
    <div class="code-block">
        <pre id="code3"><code class="plaintext"># Ignore Node modules
node_modules/

# Ignore environment files
.env

# Ignore Docker Compose overrides
docker-compose.override.yml
        </code></pre>
        <button class="copy-btn" onclick="copyToClipboard(this, 'code3')">Copy</button>
    </div>

    <h3><code>.dockerignore</code></h3>
    <div class="code-block">
        <pre id="code4"><code class="plaintext"># Exclude secrets and VCS from build context
.env
.git
node_modules
        </code></pre>
        <button class="copy-btn" onclick="copyToClipboard(this, 'code4')">Copy</button>
    </div>    <h2>4. Write the <code>Dockerfile</code></h2>
    <p>Create <code>C:\CodexApp\Dockerfile</code> with:</p>
    <div class="code-block">
        <pre id="code5"><code class="dockerfile">FROM node:22-slim

# Set working directory inside container
WORKDIR /usr/src/app

# Install the Codex CLI globally
RUN npm install -g @openai/codex

# Default to bash for interactive use
CMD ["bash"]
        </code></pre>
        <button class="copy-btn" onclick="copyToClipboard(this, 'code5')">Copy</button>
    </div>    <h2>5. Write the <code>docker-compose.yml</code></h2>
    <p>Create <code>C:\CodexApp\docker-compose.yml</code>:</p>
    <div class="code-block">
        <pre id="code6"><code class="yaml">version: "3.9"

services:
  codex:
    build: .
    volumes:
      - C:\\CodexApp:/usr/src/app    # Mount local Windows folder
    working_dir: /usr/src/app
    env_file:
      - .env                       # Load OPENAI_API_KEY from .env
    tty: true                      # Keep the shell open for interaction
        </code></pre>
        <button class="copy-btn" onclick="copyToClipboard(this, 'code6')">Copy</button>
    </div>

    <h2>6. Build and Run</h2>    <ol>
        <li>Open PowerShell and navigate to your project folder:
            <div class="code-block">
                <pre id="code7"><code class="powershell">cd C:\CodexApp
                </code></pre>
                <button class="copy-btn" onclick="copyToClipboard(this, 'code7')">Copy</button>
            </div>
        </li>
        <li>Build the Docker image:
            <div class="code-block">
                <pre id="code8"><code class="powershell">docker-compose build
                </code></pre>
                <button class="copy-btn" onclick="copyToClipboard(this, 'code8')">Copy</button>
            </div>
        </li>
        <li>Start an interactive shell session in the container:
            <div class="code-block">
                <pre id="code9"><code class="powershell">docker-compose run codex
                </code></pre>
                <button class="copy-btn" onclick="copyToClipboard(this, 'code9')">Copy</button>
            </div>
            <ul>
                <li>You will be at <code>/usr/src/app</code> inside the container.</li>
                <li>Try verifying your key:
                    <div class="code-block">
                        <pre id="code10"><code class="bash">echo $OPENAI_API_KEY
                        </code></pre>
                        <button class="copy-btn" onclick="copyToClipboard(this, 'code10')">Copy</button>
                    </div>
                </li>
                <li>Run Codex commands:
                    <div class="code-block">
                        <pre id="code11"><code class="bash">codex "Explain what this script does"
                        </code></pre>
                        <button class="copy-btn" onclick="copyToClipboard(this, 'code11')">Copy</button>
                    </div>
                </li>
            </ul>
        </li>
        <li>Run one-off Codex commands without entering the shell:
            <div class="code-block">
                <pre id="code12"><code class="powershell">docker-compose run codex codex "Generate a Node.js HTTP server"
                </code></pre>
                <button class="copy-btn" onclick="copyToClipboard(this, 'code12')">Copy</button>
            </div>
        </li>
    </ol>

    <h2>7. Tips and Notes</h2>
    <ul>
        <li><strong>Editing Locally:</strong> Any edits you make in <code>C:\Working</code> are immediately available inside the container.</li>
        <li><strong>Safety:</strong> Secrets never get baked into the image or committed to Git.</li>
        <li><strong>Extensibility:</strong> You can add other services (databases, caches) to the <code>docker-compose.yml</code> later.</li>
    </ul>

    <hr>
    <p>Happy coding with OpenAI Codex in Docker!</p>
</body>
</html>