Files
ComfyUI-Lora-Manager/docs/library-switching.md
T
Will Miao 1a6b0f78a3 chore(libraries): deprecate multi-library support ahead of removal
Warn at startup (log + dismissible startup message) when settings.json
contains more than one library, marking the feature as deprecated while
keeping it fully functional. Removal is planned for one of the next
releases, at which point all libraries' folder paths will be merged into
a single library. Multiple folder roots within one library remain fully
supported and unaffected.

- SettingsManager: add _warn_if_multi_library() invoked from
  _migrate_to_library_registry
- Settings UI: label the Active Library selector as deprecated and note
  the removal plan in its help text (en.json)
- Docs: add deprecation banners to multi_library_design.md and
  library-switching.md
- Remove dead code: SettingsManager.update_active_library_paths had no
  call sites
2026-10-09 11:10:04 +08:00

2.1 KiB

Library Switching and Preview Routes

Deprecated: Multi-library support (and therefore library switching) is deprecated and will be removed in an upcoming release. The dynamic preview route described here will remain — it also serves single-library installations.

Library switching no longer requires restarting the backend. The preview thumbnails shown in the UI are now served through a dynamic endpoint that resolves files against the folders registered for the active library at request time. This allows the multi-library flow to update model roots without touching the aiohttp router, so previews remain available immediately after a switch.

How the dynamic preview endpoint works

  • config.get_preview_static_url() now returns /api/lm/previews?path=<encoded> for any preview path. The raw filesystem location is URL encoded so that it can be passed through the query string without leaking directory structure in the route itself.【F:py/config.py†L398-L404】
  • PreviewRoutes exposes the /api/lm/previews handler which validates the decoded path against the directories registered for the current library. The request is rejected if it falls outside those roots or if the file does not exist.【F:py/routes/preview_routes.py†L5-L21】【F:py/routes/handlers/preview_handlers.py†L9-L48】
  • Config keeps an up-to-date cache of allowed preview roots. Every time a library is applied the cache is rebuilt using the declared LoRA, checkpoint and embedding directories (including symlink targets). The validation logic checks preview requests against this cache.【F:py/config.py†L51-L68】【F:py/config.py†L180-L248】【F:py/config.py†L332-L346】

Both the ComfyUI runtime (LoraManager.add_routes) and the standalone launcher (StandaloneLoraManager.add_routes) register the new preview routes instead of mounting a static directory per root. Switching libraries therefore works without restarting the application, and preview URLs generated before or after a switch continue to resolve correctly.【F:py/lora_manager.py†L21-L82】【F:standalone.py†L302-L315】