Add Upgrade Notes

This commit is contained in:
asonix 2023-12-08 22:21:20 -06:00
parent c5c4759c89
commit 605b5ac00d

View file

@ -11,6 +11,7 @@
### Changes ### Changes
- [Improved Animation Support](#improved-animation-support) - [Improved Animation Support](#improved-animation-support)
- [Media Configuration](#media-configuration)
- [Improved Collision Resistance](#improved-collision-resistance) - [Improved Collision Resistance](#improved-collision-resistance)
- [Optional Video Transcoding](#optional-video-transcoding) - [Optional Video Transcoding](#optional-video-transcoding)
- [Library API Changes](#library-api-changes) - [Library API Changes](#library-api-changes)
@ -49,6 +50,25 @@
## Upgrade Notes ## Upgrade Notes
The upgrade from pict-rs 0.4 to 0.5 might take some time. Any uploads that have not had their
metadata extracted will be processed during this migration. In order to reduce the time required the
migration, pict-rs version 0.4.6 can be run first, and the `/internal/prepare_upgrade` endpoint can
be hit. This will tell pict-rs to extract the required metadata for the 0.5 upgrade in the
background while 0.4 is still running, enabling the upgrade to 0.5 to proceed much faster after it
completes. More information about this endpoint can be found in the
[0.4.6 release document](./0.4.6.md)
If you're running the provided docker container with default configuration values, the 0.5 container
can be pulled and launched with no changes. There is a migration from the 0.4 database format to the
0.5 database format that will occur automatically on first launch. This is also the process that
will extract metadata for any uploads that have not had their metadata extracted yet.
If you have any custom configuration, note that some media-related configuration values have been
moved. See [Media Configuration](#media-configuration) below.
More information can be found in the
[pict-rs readme](https://git.asonix.dog/asonix/pict-rs#04-to-05-migration-guide).
## Descriptions ## Descriptions
@ -61,6 +81,9 @@
### Improved Animation Support ### Improved Animation Support
### Media Configuration
### Improved Collision Resistance ### Improved Collision Resistance