Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Dashboard Configuration

Configure the HTTP API and web dashboard.

Basic setup

[dashboard]
port = 3210
token = "${AKSHI_TOKEN}"

Full options

[dashboard]
port = 3210
bind_address = "127.0.0.1"
token = "${AKSHI_TOKEN}"
auth = true
cors_origins = ["http://127.0.0.1:3210"]
rate_limit = 300
rate_limit_burst = 50
sse_keepalive_secs = 15

Field reference

FieldTypeDefaultDescription
portinteger3210HTTP listen port
bind_addressstring127.0.0.1Bind address
tokenstringauto-generatedAPI authentication token
authbooleantrueEnable authentication
cors_originsstring[]["http://127.0.0.1:3210"]Allowed CORS origins
rate_limitinteger300Requests per minute
rate_limit_burstinteger50Burst request limit
sse_keepalive_secsinteger15SSE keepalive ping interval

Disabling authentication

For local development only:

[dashboard]
auth = false

Never disable auth on a network-accessible interface.

CORS for external dashboards

If you host the dashboard UI separately:

[dashboard]
cors_origins = ["https://dashboard.example.com", "http://localhost:5173"]

Rate limiting

Rate limits apply per source IP. When exceeded, the API returns 429 Too Many Requests with a Retry-After header. Adjust limits based on your client count and monitoring frequency.