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 1/6] 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 From b889d1c4c4c67aab61f468fb531d7bb9fb9e6eb6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?H=C3=A9l=C3=A8ne=20Martin?= Date: Thu, 26 Sep 2024 18:10:39 +0200 Subject: [PATCH 2/6] Add link to S3-compatible storage configuration --- docs/central-upgrade.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/central-upgrade.rst b/docs/central-upgrade.rst index abbb06ca3..a3c831a71 100644 --- a/docs/central-upgrade.rst +++ b/docs/central-upgrade.rst @@ -109,10 +109,10 @@ If you make changes to your `.env` file to configure Central as described in the $ docker compose stop $ docker compose up -d -2. File data can be stored in S3-compatible storage -*************************************************** +2. Files 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. +By default, Central stores all of its data in a database, including files like XLSForm definitions and 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 :ref:`configuring S3-compatible storage `_. 3. Docker images now published ******************************* From 12a77d0efb4736ebc9cb896721ba24045e943feb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?H=C3=A9l=C3=A8ne=20Martin?= Date: Thu, 26 Sep 2024 19:06:30 +0200 Subject: [PATCH 3/6] Narrow down configuration changes --- docs/central-upgrade.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/central-upgrade.rst b/docs/central-upgrade.rst index a3c831a71..36df5d7dc 100644 --- a/docs/central-upgrade.rst +++ b/docs/central-upgrade.rst @@ -99,10 +99,10 @@ 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 +1. Changes to .env no longer require 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: +If you make changes to your `.env` file to configure Central as described in the :doc:`setup and configuration 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 From 4865d9ce0f9374712739f3fe97a35f10d352eced Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?H=C3=A9l=C3=A8ne=20Martin?= Date: Thu, 26 Sep 2024 21:12:37 +0200 Subject: [PATCH 4/6] Escape .env --- docs/central-upgrade.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/central-upgrade.rst b/docs/central-upgrade.rst index 36df5d7dc..84c4b6be7 100644 --- a/docs/central-upgrade.rst +++ b/docs/central-upgrade.rst @@ -99,7 +99,7 @@ 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. Changes to .env no longer require rebuilding +1. Changes to `.env` no longer require rebuilding ********************************************** If you make changes to your `.env` file to configure Central as described in the :doc:`setup and configuration instructions `, you no longer have to rebuild Central for the changes to take effect. Instead, a stop and restart is now enough: From d1703d8678ed36233333049e329b245385d70770 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?H=C3=A9l=C3=A8ne=20Martin?= Date: Mon, 30 Sep 2024 11:48:54 -0700 Subject: [PATCH 5/6] Changes to SSL don't require rebuild --- docs/central-upgrade.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/central-upgrade.rst b/docs/central-upgrade.rst index 84c4b6be7..ff280da62 100644 --- a/docs/central-upgrade.rst +++ b/docs/central-upgrade.rst @@ -99,10 +99,10 @@ 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. Changes to `.env` no longer require rebuilding -********************************************** +1. Changes to `.env` and SSL no longer require rebuilding +************************************************************ -If you make changes to your `.env` file to configure Central as described in the :doc:`setup and configuration instructions `, you no longer have to rebuild Central for the changes to take effect. Instead, a stop and restart is now enough: +If you make changes to your `.env` file or your SSL certificates to configure Central as described in the :doc:`setup and configuration 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 From 91ffd9e6d186fcb7de4efeabf20e407e84f35854 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?H=C3=A9l=C3=A8ne=20Martin?= Date: Mon, 30 Sep 2024 12:27:48 -0700 Subject: [PATCH 6/6] Match section title --- docs/central-upgrade.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/central-upgrade.rst b/docs/central-upgrade.rst index ff280da62..5da31cd05 100644 --- a/docs/central-upgrade.rst +++ b/docs/central-upgrade.rst @@ -10,7 +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 +* :ref:`Central v2024.2 `: changes to ``.env`` and SSL no longer require rebuilding, 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 @@ -99,10 +99,10 @@ 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. Changes to `.env` and SSL no longer require rebuilding +1. Changes to ``.env`` and SSL no longer require rebuilding ************************************************************ -If you make changes to your `.env` file or your SSL certificates to configure Central as described in the :doc:`setup and configuration instructions `, you no longer have to rebuild Central for the changes to take effect. Instead, a stop and restart is now enough: +If you make changes to your ``.env`` file or your SSL certificates to configure Central as described in the :doc:`setup and configuration 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 @@ -112,7 +112,7 @@ If you make changes to your `.env` file or your SSL certificates to configure Ce 2. Files can be stored in S3-compatible storage ************************************************ -By default, Central stores all of its data in a database, including files like XLSForm definitions and 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 :ref:`configuring S3-compatible storage `_. +By default, Central stores all of its data in a database, including files like XLSForm definitions and 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 :ref:`configuring S3-compatible storage `. 3. Docker images now published *******************************