Skip to content

Commit def2398

Browse files
authored
Add Central v2024.2 upgrade instructions (#1858)
1 parent 4171421 commit def2398

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

docs/central-upgrade.rst

+28
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ Start by reviewing upgrade notes for all versions between your current version a
1010
Upgrade notes
1111
-------------
1212

13+
* :ref:`Central v2024.2 <central-upgrade-2024.2>`: changes to ``.env`` and SSL no longer require rebuilding, consider using S3 storage
1314
* Central v2023.5, v2024.1: no upgrade notes
1415
* :ref:`Central v2023.4 <central-upgrade-2023.4>`: improve email delivery
1516
* :ref:`Central v2023.3 <central-upgrade-2023.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
9192
Version-specific upgrade instructions
9293
--------------------------------------
9394

95+
.. _central-upgrade-2024.2:
96+
97+
Upgrading to Central v2024.2
98+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
99+
100+
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.
101+
102+
1. Changes to ``.env`` and SSL no longer require rebuilding
103+
************************************************************
104+
105+
If you make changes to your ``.env`` file or your SSL certificates to configure Central as described in the :doc:`setup and configuration instructions <central-install-digital-ocean>`, you no longer have to rebuild Central for the changes to take effect. Instead, a stop and restart is now enough:
106+
107+
.. code-block:: bash
108+
109+
$ docker compose stop
110+
$ docker compose up -d
111+
112+
2. Files can be stored in S3-compatible storage
113+
************************************************
114+
115+
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 <central-install-digital-ocean-s3>`.
116+
117+
3. Docker images now published
118+
*******************************
119+
120+
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 <https://github.com/orgs/getodk/packages?tab=packages&repo_name=central>`_.
121+
94122
.. _central-upgrade-2023.4:
95123

96124
Upgrading to Central v2023.4

0 commit comments

Comments
 (0)