参考 on bouine

CLI

Mon, 01 Jan 0001 00:00:00 +0000

Commands

bouine serve --config /etc/bouine/config.yaml
bouine config validate <file>
bouine config schema
bouine completion bash|zsh|fish
bouine purge <url> --token <token>
bouine ban host_regex=example.com path_regex=^/api --token <token>
bouine refresh <url> --token <token>
bouine cluster peers
bouine version

--server defaults to 127.0.0.1:9000. All commands default to port 9000 so --server is optional when running locally.

管理 API

Mon, 01 Jan 0001 00:00:00 +0000

Authentication

All write endpoints require a bearer token. See Authentication for full details on token resolution, environment variables, and config file setup.

Pass the token in requests:

curl -X POST http://127.0.0.1:9000/v1/purge \
 -H "Authorization: Bearer your-secret-token" \
 -H "Content-Type: application/json" \
 -d '{"url":"https://example.com/page"}'

Exempt endpoints (no token required)

These are always accessible without authentication — required for K8s probes and Prometheus scraping:

响应头

Mon, 01 Jan 0001 00:00:00 +0000

X-Cache

指示响应的返回方式。

值	描述
`HIT`	从缓存返回（新鲜）
`MISS`	从源站获取并已缓存
`STALE`	从缓存返回（过期，在 stale-while-revalidate 或 stale-if-error 窗口内）
`BYPASS`	绕过缓存（no-store、no-cache 或路由禁用缓存）
`REVALIDATED`	向源站的条件请求返回 304，从缓存返回并更新新鲜度

curl -sI http://localhost:8080/get | grep x-cache
# X-Cache: HIT

Age

缓存对象的年龄（秒），计算自原始响应的 Date 头加上在上游转发代理中花费的时间。每次缓存命中时更新。

Go SDK

Mon, 01 Jan 0001 00:00:00 +0000

The bouine Go SDK (pkg/bouineapi) provides typed methods for every admin API endpoint. It shares wire types with the Cobra CLI and the admin server, so there is no drift between the SDK and the API.