From 72cef71ff8211dc8cfd7e670f15d3c4cdb285156 Mon Sep 17 00:00:00 2001 From: Haitao Pan Date: Fri, 10 Apr 2026 08:46:04 +0800 Subject: [PATCH] docs: add bridge config example --- README.md | 7 ++++++- example/config.yaml | 42 ++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 48 insertions(+), 1 deletion(-) create mode 100644 example/config.yaml diff --git a/README.md b/README.md index ee8e14c..e294bfa 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,12 @@ - ACP stdio bridge entrypoint - Go helper runtime packages used by the ACP bridge - Unit tests for bridge routing, RPC contracts, mounts, runtime dispatch, and provider sync -- Architecture notes and public ingress topology docs in [docs/architecture/acp-forwarding-topology.md](/Users/shenlan/workspaces/cloud-neutral-toolkit/xworkmate-bridge/docs/architecture/acp-forwarding-topology.md) + +## ACP Forwarding Topology + +This repository exposes one bridge entrypoint and forwards to four verified public targets. The full Mermaid diagram lives in [docs/architecture/acp-forwarding-topology.md](/Users/shenlan/workspaces/cloud-neutral-toolkit/xworkmate-bridge/docs/architecture/acp-forwarding-topology.md). + +Example provider sync config: [example/config.yaml](/Users/shenlan/workspaces/cloud-neutral-toolkit/xworkmate-bridge/example/config.yaml) ## Compatibility diff --git a/example/config.yaml b/example/config.yaml new file mode 100644 index 0000000..9934424 --- /dev/null +++ b/example/config.yaml @@ -0,0 +1,42 @@ +# Example configuration for xworkmate-bridge public ingress and provider sync. +# The bridge itself validates inbound requests with: +# Authorization: Bearer ${ACP_AUTH_TOKEN} +# Each external provider can also carry its own outbound Authorization header. + +bridge: + listenAddr: 127.0.0.1:8787 + authToken: ${ACP_AUTH_TOKEN} + allowedOrigins: + - https://xworkmate.svc.plus + - http://localhost:* + - http://127.0.0.1:* + +providers: + - providerId: openclaw + label: OpenClaw + endpoint: wss://openclaw.svc.plus + authorizationHeader: Bearer ${OPENCLAW_AUTH_TOKEN} + enabled: true + + - providerId: codex + label: Codex + endpoint: https://acp-server.svc.plus/codex/acp/rpc + authorizationHeader: Bearer ${CODEX_AUTH_TOKEN} + enabled: true + + - providerId: opencode + label: OpenCode + endpoint: https://acp-server.svc.plus/opencode/acp/rpc + authorizationHeader: Bearer ${OPENCODE_AUTH_TOKEN} + enabled: true + + - providerId: gemini + label: Gemini + endpoint: https://acp-server.svc.plus/gemini/acp/rpc + authorizationHeader: Bearer ${GEMINI_AUTH_TOKEN} + enabled: true + +notes: + - The bridge reads its own auth token from ACP_AUTH_TOKEN. + - The provider catalog is normally synced through xworkmate.providers.sync. + - session.message should resend routing on follow-up turns for codex and opencode.