mirror of
https://github.com/mudler/LocalAI.git
synced 2026-05-17 13:10:23 -04:00
b1a99436c7
Adds a whitelabeling feature so an operator can replace the LocalAI
instance name, tagline, square logo, horizontal logo, and favicon from
the admin Settings page. Defaults fall back to the bundled assets so
existing installs are unaffected.
The public GET /api/branding endpoint is reachable pre-auth so the
login screen can render the configured branding before sign-in.
Mutating routes (POST/DELETE /api/branding/asset/:kind) remain
admin-only. Text fields (instance_name, instance_tagline) ride the
existing /api/settings flow; binary assets get a dedicated multipart
upload route that persists files under DynamicConfigsDir/branding/.
To prevent the Settings page's stale local state from clobbering an
upload on save, UpdateSettingsEndpoint preserves whatever the on-disk
asset filename fields are regardless of the body — /api/branding/asset/*
are the sole writers for those fields.
The MCP catalog gains get_branding and set_branding tools (text fields
only; file upload stays UI-only) plus a configure_branding skill prompt.
While wiring this up, the same restart-loss class of bug surfaced for
several existing fields whose RuntimeSettings entries were never read
by the startup loader. Fix loadRuntimeSettingsFromFile() to load:
- branding (instance_name, instance_tagline, *_file basenames)
- auto_upgrade_backends, prefer_development_backends
- localai_assistant_enabled
- open_responses_store_ttl
- the 7 existing AgentPool fields (enabled, default/embedding model,
chunking sizes, enable_logs, collection_db_path)
Also exposes 3 new AgentPool runtime settings (vector_engine,
database_url, agent_hub_url) via /api/settings + the Settings UI, with
the same load-on-startup wiring. The file watcher's manual-edit path
is intentionally not changed — the in-process API endpoints already
update appConfig directly, so the watcher is redundant for supported
flows and a separate refactor for everything else.
15 TDD specs cover the loader behaviour (1 branding + 11 adjacent + 3
new agent-pool); 2 specs cover the persistence helpers and the
clobber-prevention contract.
Assisted-by: claude-code:claude-opus-4-7
Signed-off-by: Ettore Di Giacinto <mudler@localai.io>
71 lines
3.2 KiB
Go
71 lines
3.2 KiB
Go
package localaitools
|
|
|
|
import (
|
|
"context"
|
|
|
|
"github.com/mudler/LocalAI/core/config"
|
|
"github.com/mudler/LocalAI/core/gallery"
|
|
"github.com/mudler/LocalAI/core/schema"
|
|
"github.com/mudler/LocalAI/core/services/modeladmin"
|
|
"github.com/mudler/LocalAI/pkg/vram"
|
|
)
|
|
|
|
// LocalAIClient is the surface tools depend on. It has two implementations:
|
|
//
|
|
// - inproc.Client (in-process; calls LocalAI services directly)
|
|
// - httpapi.Client (out-of-process; calls the LocalAI REST API)
|
|
//
|
|
// Tool handlers and the embedded skill prompts are agnostic to which
|
|
// implementation backs the client.
|
|
//
|
|
// Where the same shape already exists elsewhere in the codebase
|
|
// (config.Gallery, gallery.Metadata, schema.KnownBackend, vram.EstimateResult,
|
|
// modeladmin.Action/Capability) we surface it directly rather than maintain
|
|
// a parallel DTO — keeping the LLM-visible wire format aligned with the
|
|
// rest of LocalAI by construction.
|
|
type LocalAIClient interface {
|
|
// ---- Models / gallery (read) ----
|
|
GallerySearch(ctx context.Context, q GallerySearchQuery) ([]gallery.Metadata, error)
|
|
ListInstalledModels(ctx context.Context, capability Capability) ([]InstalledModel, error)
|
|
ListGalleries(ctx context.Context) ([]config.Gallery, error)
|
|
GetJobStatus(ctx context.Context, jobID string) (*JobStatus, error)
|
|
GetModelConfig(ctx context.Context, name string) (*ModelConfigView, error)
|
|
|
|
// ---- Models / gallery (write) ----
|
|
InstallModel(ctx context.Context, req InstallModelRequest) (jobID string, err error)
|
|
DeleteModel(ctx context.Context, name string) error
|
|
EditModelConfig(ctx context.Context, name string, patch map[string]any) error
|
|
ReloadModels(ctx context.Context) error
|
|
ImportModelURI(ctx context.Context, req ImportModelURIRequest) (*ImportModelURIResponse, error)
|
|
|
|
// ---- Backends ----
|
|
// ListBackends returns installed backends. The shape stays a thin
|
|
// localaitools.Backend rather than gallery.SystemBackend because the
|
|
// latter carries filesystem paths (RunFile, Metadata) the LLM
|
|
// shouldn't see.
|
|
ListBackends(ctx context.Context) ([]Backend, error)
|
|
// ListKnownBackends returns the same shape as REST /backends/known.
|
|
ListKnownBackends(ctx context.Context) ([]schema.KnownBackend, error)
|
|
InstallBackend(ctx context.Context, req InstallBackendRequest) (jobID string, err error)
|
|
UpgradeBackend(ctx context.Context, name string) (jobID string, err error)
|
|
|
|
// ---- System ----
|
|
SystemInfo(ctx context.Context) (*SystemInfo, error)
|
|
ListNodes(ctx context.Context) ([]Node, error)
|
|
VRAMEstimate(ctx context.Context, req VRAMEstimateRequest) (*vram.EstimateResult, error)
|
|
|
|
// ---- State ----
|
|
// ToggleModelState accepts modeladmin.ActionEnable / ActionDisable.
|
|
ToggleModelState(ctx context.Context, name string, action modeladmin.Action) error
|
|
// ToggleModelPinned accepts modeladmin.ActionPin / ActionUnpin.
|
|
ToggleModelPinned(ctx context.Context, name string, action modeladmin.Action) error
|
|
|
|
// ---- Branding / whitelabeling ----
|
|
// GetBranding returns the configured instance branding (name, tagline,
|
|
// asset URLs).
|
|
GetBranding(ctx context.Context) (*Branding, error)
|
|
// SetBranding updates the text branding fields. Asset uploads are not
|
|
// exposed over MCP — admins use the Settings UI for binary files.
|
|
SetBranding(ctx context.Context, req SetBrandingRequest) (*Branding, error)
|
|
}
|