Skip to content

Commit

Permalink
Add Central v2024.2 upgrade instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
lognaturel committed Sep 25, 2024
1 parent 4171421 commit f8de405
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions docs/central-upgrade.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Start by reviewing upgrade notes for all versions between your current version a
Upgrade notes
-------------

* :ref:`Central v2024.2 <central-upgrade-2024.2>`: configuration no longer requires rebuild, consider using S3 storage
* Central v2023.5, v2024.1: no upgrade notes
* :ref:`Central v2023.4 <central-upgrade-2023.4>`: improve email delivery
* :ref:`Central v2023.3 <central-upgrade-2023.3>`: clean up old database if needed
Expand Down Expand Up @@ -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 <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:

.. 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 <https://github.com/orgs/getodk/packages?tab=packages&repo_name=central>`_.

.. _central-upgrade-2023.4:

Upgrading to Central v2023.4
Expand Down

0 comments on commit f8de405

Please sign in to comment.