gronod
9e26d7fe9c
Align the add-on packaging with its upstream components (openai-oauth and @openai/codex, both Apache-2.0).
59 lines
2.3 KiB
Markdown
59 lines
2.3 KiB
Markdown
# OpenAI Codex Proxy
|
|
|
|
<img src="logo.png" alt="OpenAI Codex Proxy" width="128" height="128">
|
|
|
|
Local OpenAI-compatible API endpoint backed by your ChatGPT account's Codex
|
|
OAuth login — packaged as a Home Assistant add-on.
|
|
|
|
Point any OpenAI-compatible integration (for example an OpenAI conversation
|
|
integration in Home Assistant) at this add-on and it answers through your
|
|
ChatGPT Plus/Pro account instead of paid API credits.
|
|
|
|
## Features
|
|
|
|
* OpenAI-compatible endpoints: `/v1/responses`, `/v1/chat/completions`,
|
|
`/v1/models`, and `/v1/images/*`
|
|
* Exposes the Codex models your ChatGPT account can actually use
|
|
* Streaming responses, tool calls, and reasoning traces
|
|
* Local API key required on every request — generated automatically on first
|
|
start (no open proxy on your LAN)
|
|
* Optional per-request JSON logging for troubleshooting
|
|
* OAuth tokens refresh automatically and persist in `/share/auth.json`
|
|
|
|
## Requirements
|
|
|
|
* A ChatGPT account (Plus or Pro recommended for Codex access)
|
|
* A Codex `auth.json` file, generated on a desktop machine with
|
|
`npx @openai/codex login` and copied to this Home Assistant machine's
|
|
`/share` folder
|
|
|
|
## Installation
|
|
|
|
1. Add this repository to Home Assistant
|
|
(**Settings → Add-ons → Add-on Store → ⋮ → Repositories**):
|
|
`https://git.i3omb.com/gronod/ha-gronod-addons`
|
|
2. Copy your `auth.json` to `/share/auth.json` (Samba or SSH add-on)
|
|
3. Install **OpenAI Codex Proxy** and start it
|
|
4. Copy the generated local API key from the add-on log and configure your
|
|
OpenAI-compatible integration with base URL
|
|
`http://<home-assistant-host>:10531/v1`
|
|
|
|
See [DOCS.md](DOCS.md) for the step-by-step guide, option reference, and
|
|
troubleshooting.
|
|
|
|
## Credits
|
|
|
|
This add-on wraps [openai-oauth](https://github.com/EvanZhouDev/openai-oauth)
|
|
by [@EvanZhouDev](https://github.com/EvanZhouDev) — an unofficial,
|
|
community-maintained project that exposes ChatGPT Codex OAuth sessions as an
|
|
OpenAI-compatible API. Login uses OpenAI's
|
|
[@openai/codex](https://github.com/openai/codex) CLI.
|
|
|
|
## License
|
|
|
|
© 2026 Gordon Bolton. Apache License 2.0 — see `LICENCE.md`, matching the
|
|
licenses of the upstream components this add-on wraps:
|
|
[openai-oauth](https://github.com/EvanZhouDev/openai-oauth) (Apache-2.0) and
|
|
[@openai/codex](https://github.com/openai/codex) (Apache-2.0).
|
|
Use is subject to OpenAI's Terms of Use and your ChatGPT plan's rate limits.
|