Skip to content

v1.2.0 - WebUI Management and Agent Compatibility

Choose a tag to compare

@maiphucgiang maiphucgiang released this 13 Sep 06:33

WebUI management and agent compatibility

codebuddy2api 1.2.0 adds a built-in management console and improves compatibility with coding-agent clients, while keeping existing OpenAI and Anthropic client URLs unchanged.

Highlights

  • Built-in WebUI at /dashboard: add domestic or international accounts through browser login or .info/ZIP imports, manage credentials and models, and inspect requests, failures and historical statistics. Published Docker images include the frontend.
  • Model and credential controls: public model IDs/aliases, enable/disable switches, and strict region/product/account bindings. Unavailable bindings never silently fall back to other accounts; the UI distinguishes manual disabling, authentication circuit breakers and model-level cooldowns.
  • Persistent, authenticated management: use the gateway API key to establish an HttpOnly management session. Credentials remain official .info files; settings and metadata use control.sqlite3, and audits use a separate logs.sqlite3. Detail cleanup preserves historical aggregates; clearing all logs and statistics requires confirmation and key verification.
  • Safer agent context handling: preserve real user instructions mixed with injected harness context in Chat and Responses, normalize developer messages to system without mutating the caller's payload, and support optional WorkBuddy CLI-template adaptation with bounded non-streaming content-filter fallback.
  • Simpler documentation: both READMEs now focus on starting the gateway, signing in to the WebUI and connecting clients. Deployment, client examples, routing rules, request limits and troubleshooting live in bilingual guides under docs/.

External contributions

Thank you to the community contributors whose work is included in this release:

  • @Good-design-999#3: preserve user text when harness metadata shares the same message. This contribution was incorporated through a local integration commit and strengthened with bounded context parsing and regression coverage.
  • @moshouhot#5: normalize developer to system for upstream compatibility, fixing the role-triggered 11128 rejection affecting pi and other OpenAI-compatible clients. The merged fix preserves the original payload and includes nine regression tests.

Upgrade notes

  • Keep /v1/chat/completions, /v1/responses, /v1/messages and /v1/models. No /cn or /intl prefixes or new region parameters are required.
  • Set a nonempty CODEBUDDY2API_KEY to use the WebUI and management APIs. Clients use the same key. Empty-key inference retains its legacy behavior, but management is locked; management Cookies do not authorize inference requests.
  • Stop the gateway and back up the entire writable auth/ data directory and existing .env before upgrading. Mount the whole data directory on local storage, not individual SQLite files, and do not share it between instances. Credentials are not migrated into SQLite.
  • Startup precedence remains explicit CLI flags > environment > persisted WebUI settings > defaults. The UI marks externally controlled options as locked; settings marked for restart require a manual restart.
  • Models and multipliers depend on each account's own catalog. Existing zero-multiplier preference, cooldowns and no account-switch replay after an upstream POST remain in place.

Docker

docker pull ghcr.io/maiphucgiang/codebuddy2api:1.2.0

For published-image Compose deployments, set CODEBUDDY2API_IMAGE=ghcr.io/maiphucgiang/codebuddy2api:1.2.0 in your existing .env, configure the API key, then run:

docker compose pull
docker compose up -d --no-build

For the source-build workflow used by the template, run docker compose build followed by docker compose up -d instead.

Images support linux/amd64 and linux/arm64. Stable image tags are 1.2.0, 1.2, 1 and latest; edge follows main.

Documentation

Validation

  • Release-commit CI and tag CI passed: Python regressions, WebUI checks and browser tests, and multi-platform image builds.
  • CodeQL completed for Python, JavaScript/TypeScript and Actions on the release commit. The separate default-branch alert check found 0 unresolved code-scanning alerts.
  • Published linux/amd64 and linux/arm64 image metadata reports version 1.2.0 and revision e7caf5293adc8eb61c8a59f9e0028459cc0918cb. Tags 1.2.0, 1.2, 1 and latest share manifest sha256:b2080d09f5f6d807e302ad75bb87491156a8f55eae5d536208c7654d9b3224c2.
  • A network-isolated smoke test of the published image verified application version, /health, the bundled dashboard/assets, model listing, and unauthenticated versus authenticated management access. No real credentials or upstream requests were used.

Full changelog: v1.1.2...v1.2.0

For personal learning only. Use only subscriptions and accounts you are authorized to access.