The documentation here is for an unreleased version of Recyclarr.
Visit the documentation site for the Current Version instead.Migration System
Summary
The Migration System allows Recyclarr to perform automatic upgrade steps between releases. These steps, referred to as Migration Steps, handle breaking changes so you don't have to act manually. Most migration steps correspond to major releases.
When Migrations Run
Migrations run automatically each time the Recyclarr server starts, before it loads your configuration. When a CLI command starts a temporary server, migrations run before that command too.
A migration step that changes files logs what it changed, for example which directory it moved or deleted. If no migrations are needed, nothing is logged.
Failure & Recovery
When a Migration Step fails, processing of further steps is halted and the server exits with exit
code 1. The server log shows one fatal message in this form:
Server startup failed: Migration step failed: <step description>: <failure reason>
Possible fixes:
- <remediation step>
The possible fixes are one or more ways to resolve the problem, typically either performing the steps by hand or taking action to allow the migration to succeed the next time Recyclarr starts.