Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Central v2024.2 upgrade instructions #1858

Merged
merged 6 commits into from
Sep 30, 2024
Merged

Add Central v2024.2 upgrade instructions #1858

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f8de405
Add Central v2024.2 upgrade instructions
lognaturel Sep 25, 2024
b889d1c
Add link to S3-compatible storage configuration
lognaturel Sep 26, 2024
12a77d0
Narrow down configuration changes
lognaturel Sep 26, 2024
4865d9c
Escape .env
lognaturel Sep 26, 2024
d1703d8
Changes to SSL don't require rebuild
lognaturel Sep 30, 2024
91ffd9e
Match section title
lognaturel Sep 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions docs/central-upgrade.rst
View file
Open in desktop
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>`: 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 <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. 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 <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. 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 <central-install-digital-ocean-s3>`.

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