Updating
An update consists of four moves: fetch the new state, compare your own configuration against the template, back up, install. It runs along the same guided path as the initial setup, only in update mode.
The comparison with the template
Section titled “The comparison with the template”Before the update, the configuration of the instance is held against the supplied template. Only the names of the values are compared, no contents. Secrets therefore do not show up. Two things can be read from it:
- Values that appear only in the template are new. The template is commented throughout and states what a value is needed for. New values are almost always optional.
- Values that appear only in your configuration are either instance-specific or stem from an old version and can go.
Why always back up first
Section titled “Why always back up first”An update swaps program states underneath an existing database. If something goes wrong, the fastest way back is an archive from before. A backup takes seconds, a lost dataset costs days. Details under Backup and migration.
Update mode
Section titled “Update mode”In update mode the existing configuration stays untouched and no new secrets are generated. That is exactly what you want for an update: your keys and addresses stay as they are. At the same time all parts of the delivery are renewed together.
Why versions are pinned
Section titled “Why versions are pinned”The images are deliberately not set to latest but to a fixed, immutable version. The reason:
latest pulls a different state on every server and on every fetch. A release of Kisuno,
however, is a tested combination of the LibreChat version and the supplementary parts. Only
with a fixed version does every server run exactly the combination that was verified.
Checking after the update
Section titled “Checking after the update”Four points: sign-in to the chat, sign-in to the admin panel, a test question in the chat and a look at whether all services run stably. Configuration errors (for instance a YAML file that no longer matches the schema after an update) become visible in the process.
Rollback
Section titled “Rollback”A rollback resets the entire delivered state to the previous version, not individual files. Only together do the parts again form the combination that ran before. The configuration of the instance stays untouched.
Only if data is affected as well does the restore from the archive come into play. It is destructive, see Backup and migration. Try the rollback once on a test instance before you need it for the first time in an emergency.