# Updating RustSearch

Update the existing plugin in place. Do not uninstall it.

Upload the new KPZ, open Configuration → Update RustSearch and copy the current
bundle's SSH command. Replace INSTANCE with the intended Koha instance name.
Run as the normal administrator with sudo access; the web page does not execute
server updates.

Use --check-only to inspect prerequisites and engine compatibility. Use --update
when updating the engine and plugin. It builds and tests the bundled executable,
backs up the deployment, installs matching components and verifies native search.
Compatible same-schema updates retain existing indexes. Index migrations are a
separate operation described in the relevant release notes. Preserve printed
backup paths and logs. Expect a brief search interruption during the switch.

A KPZ upload alone does not replace the engine executable. Use --existing-engine
only when the release instructions do not require a new executable: it refreshes
the plugin, worker and Koha integration while retaining the current engine and
indexes. Engine changes are not applied in that mode. It is not a transactional
engine replacement; completed steps may remain installed if a later step fails.

The updater preserves the effective service account, index paths, native port and
enabled optional features. Optional components stay disabled unless explicitly
enabled. Follow version-specific requirements and validate staff/OPAC searches,
indexing status and enabled features afterward. Production engines and indexes
must remain on schema 7 or newer. Backups of installation files do not undo catalog
edits. Retain the current SearchEngine selection through a compatible update.