From f8de405eca4cf69a43c23d8c06927e205bd61927 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?H=C3=A9l=C3=A8ne=20Martin?= Date: Wed, 25 Sep 2024 10:55:43 +0200 Subject: [PATCH] Add Central v2024.2 upgrade instructions --- docs/central-upgrade.rst | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/docs/central-upgrade.rst b/docs/central-upgrade.rst index 945bd3387..abbb06ca3 100644 --- a/docs/central-upgrade.rst +++ b/docs/central-upgrade.rst @@ -10,6 +10,7 @@ Start by reviewing upgrade notes for all versions between your current version a Upgrade notes ------------- +* :ref:`Central v2024.2 `: configuration no longer requires rebuild, consider using S3 storage * Central v2023.5, v2024.1: no upgrade notes * :ref:`Central v2023.4 `: improve email delivery * :ref:`Central v2023.3 `: clean up old database if needed @@ -91,6 +92,33 @@ You'll be asked to confirm the removal of all dangling images. Agree by typing t Version-specific upgrade instructions -------------------------------------- +.. _central-upgrade-2024.2: + +Upgrading to Central v2024.2 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +There are no required special steps related to this upgrade. However, there are some optional changes that you may want to know about or opt into. + +1. Configuration no longer requires rebuilding +********************************************** + +If you make changes to your `.env` file to configure Central as described in the :doc:`setup instructions `, you no longer have to rebuild Central for the changes to take effect. Instead, a stop and restart is now enough: + +.. code-block:: bash + + $ docker compose stop + $ docker compose up -d + +2. File data can be stored in S3-compatible storage +*************************************************** + +By default, Central stores all of its data in a database, including files like images attached to submissions. If you have or plan on collecting a lot of files, you may prefer to store these in separate storage to reduce load on the database and possibly reduce hosting costs. See instructions on how to opt in. + +3. Docker images now published +******************************* + +If you use your own infrastructure for orchestrating the different components needed to run Central, you may prefer to use published Docker images. You can now find these `on GHCR `_. + .. _central-upgrade-2023.4: Upgrading to Central v2023.4