Codex
OpenAI's lightweight coding agent in a browser terminal
Deploy NowREADME
OpenAI's lightweight coding agent in a browser terminal.
Overview
This template runs Codex, OpenAI's terminal coding agent,
inside a container that exposes a browser terminal. You open a URL, authenticate, and get a bash
shell with the codex CLI already installed. Upstream describes it as a lightweight coding agent
that runs in your terminal; this template gives that terminal a URL and a disk.
The image is built from the Dockerfile in this directory: node:24-bookworm-slim (pinned by
digest) plus ttyd 1.7.7 (verified against a pinned SHA-256) and
@openai/codex pinned to an exact version. Nothing floats on latest, so a restart gives you the
same environment. ttyd carries one patch: its startup log prints credential: ** instead of your
sign-in encoded in base64, so reading the service's logs does not reveal the terminal password.
Versions before 0.8.3 logged it on every start, and upgrading does not remove those lines from the
log history: if you ran one, set a new ADMIN_PASSWORD before you upgrade.
What you get by hosting it
- An HTTPS URL for the terminal, with no port forwarding or tunnel to manage.
- A persistent volume mounted at
/data.HOMEis set to/data/home, so your CLI login, shell history, and any repositories you clone survive restarts, redeploys, and version upgrades. - The terminal credentials kept as service variables rather than baked into the image, so you can change them later without rebuilding anything. They are yours, not ours: the template ships no credential of its own, and both values are visible in the deploy form and in the service's variables.
- Deploys are health-gated: a container that does not answer is rolled back to the last healthy image instead of leaving you with a dead URL.
What you need before deploying
- A username and a password of your choosing for the terminal sign-in. There is no default: the deploy form starts with both fields empty and will not submit until you fill them.
- Optionally, an OpenAI API key: otherwise you sign in
from inside the terminal with
codex login.
Configuration
| Variable | Required | What it does |
|---|---|---|
ADMIN_USERNAME | yes | HTTP basic-auth username for the terminal. You choose it. |
ADMIN_PASSWORD | yes | HTTP basic-auth password for the terminal. You choose it. |
OPENAI_API_KEY | no | Authenticates the CLI without an interactive login. Leave blank to run codex login in the terminal instead. |
Both credentials are required and neither has a default, so the deploy form starts empty and refuses
to submit until you supply them. Together they must stay under 186 bytes (username:password):
past that, ttyd 1.7.7 starts normally and then answers 401 to everyone including you, so the
entrypoint stops the container instead of leaving you with an unreachable terminal.
Set by the template, not by you: HOME=/data/home (puts your home directory on the volume).
Pick the password like it guards a shell, because it does. What it protects is a root shell that can run anything and holds whatever API keys you gave it, so whoever has the URL and this password has all of that. Both fields can be changed later from the service's variables.
After deploy
- Open the service URL. The browser asks for HTTP basic auth: the
ADMIN_USERNAMEandADMIN_PASSWORDyou deployed with. - You land in a
bashshell in/data/home. - Run
codex. If you did not setOPENAI_API_KEY, runcodex loginfirst and follow the prompts. - That login persists. Because
HOMEis on the volume, the CLI's config survives restarts: you do not re-authenticate after every deploy. - Clone your repository into
/data/home(or anywhere under/data) so your work persists too. Files written outside/dataare lost when the container is replaced.
Links
- Architectures:
linux/amd64andlinux/arm64. The node base image, the ttyd release asset and the npm package are all available for both. - Upstream: https://github.com/openai/codex
- Package:
@openai/codex - ttyd: https://github.com/tsl0922/ttyd
- License: Apache-2.0 (upstream
openai/codex).
Services & Specs
- Image
- ghcr.io/insforge/insta-oss/templates/codex:0.8.3
- Port
- 7681
- Healthcheck
- /
Variables
You supply 2 variables before the first deploy.
Required
ADMIN_USERNAMEUsername for the browser terminal sign-in
ADMIN_PASSWORDPassword for the browser terminal sign-in
Optional (1)
OPENAI_API_KEYOpenAI API key. Leave blank and run `codex login` in the terminal instead