Documentation
¶
Overview ¶
Package dashboard serves the admin SPA and its backing JSON API.
@title llm-router API @version 0.8.0 @description OpenAI-compatible plus Anthropic-compatible LLM routing gateway. @description Public AI surface (/v1, BearerAuth or x-api-key alias): @description chat/completions, completions, embeddings, images/generations, @description images/edits, images/variations, audio/speech, @description audio/transcriptions (multipart or JSON input_audio), @description audio/translations, moderations, videos submit/poll/content, @description messages, messages/count_tokens, messages/batches, complete, @description models list/retrieve (TokenRules-filtered; Anthropic shape @description when anthropic-version is present), responses (+cancel, @description input_items, compact, input_tokens), conversations (+items), @description assistants, threads (+messages, runs, cancel, @description submit_tool_outputs). Derivative-client aliases (Mistral @description random_seed/output_dimension, Ollama options/format, @description OpenRouter reasoning envelope) translate at the edge; no @description separate paths. Deprecated upstream flags are ignored: prior @description generation endpoints stay first-class, never deprecated:true. @description Dashboard surface (/api/llm-router, SessionAuth) is unchanged.
@securityDefinitions.apikey BearerAuth @in header @name Authorization @description Router token as "Bearer llmr_*".
@securityDefinitions.apikey SessionAuth @in cookie @name llmr_session @description Dashboard login session cookie.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func EffectiveBootstrapped ¶ added in v0.1.2
EffectiveBootstrapped is the bootstrap state the SPA acts on: the real database state, or true under NoAuth where no account is required. Single source of truth for the middleware and the status endpoint so the gate and the reported state can never diverge.
Types ¶
type Handler ¶
type Handler struct {
// contains filtered or unexported fields
}
Handler serves the admin dashboard.
func (*Handler) SetDevRedirect ¶
SetDevRedirect configures the handler to 302-redirect any browser navigation that would otherwise fall through to the embedded SPA (i.e. everything not matched by a more specific route in Register) to origin instead, preserving path and query.
This exists because `make start` never runs a real `vite build` — the embedded build/web directory is just a placeholder stub so the //go:embed directive has something to embed. Without this, hitting the dashboard port directly in dev (or any /login, /bootstrap navigation not proxied to the dev server) serves that meaningless placeholder instead of the actual UI, which is only running on WEB_PORT in dev. Production builds never call this, so it has no effect there.
type Params ¶ added in v0.1.2
type Params struct {
AdminSvc *admin.Service
ProviderSvc *provider.Service
CredSvc *credential.Service
TokenSvc *token.Service
ModelInfoSvc *modelinfo.Service
MetricsSvc *metrics.Service
VirtualSvc *virtual.Service
RouterSvc *router.Service
ConfigSvc *configsvc.Service
LuaSvc *luaplugin.Service
RepoSvc *pluginrepo.Service
ProxySvc *proxypool.Service
MaintSvc *maintenance.Service
Logger *slog.Logger
// NoAuth skips session checks: dashboard APIs serve without login.
NoAuth bool
}
Params carries every dependency of the dashboard Handler in one value, so adding a service touches one struct instead of every call site.