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.

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

ODK Central: v2024.1 upgrade notes info about data dir migration #1741

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
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
89 changes: 89 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.1 <central-upgrade-2024.1>`: TBC
* Central v2023.5: 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,94 @@ You'll be asked to confirm the removal of all dangling images. Agree by typing t
Version-specific upgrade instructions
--------------------------------------

.. _central-upgrade-2024.1:

Upgrading to Central v2024.1
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

#. **Determine if there is data in your data directory**:

.. code-block:: bash

$ ls /data/transfer

.. note::

This is typically located under `/data/transfer`.

#. **Decide on your data migration strategy:**

.. dropdown:: ``Migrate data to your code directory (recommended)``
:icon: file-code

#. Shut down the Central services:

.. code-block:: bash

docker compose down

#. Move the data (ensure you are in the getodk/central repo directory):

.. code-block:: bash

$ mkdir data
$ sudo mv /data/transfer ./data/

#. Restart the Central services:

.. code-block:: bash

docker compose up -d

.. dropdown:: ``Keep the data under /data/transfer``
:icon: file-code

#. Open the ``.env`` file for editing:

.. code-block:: bash

$ nano .env

#. Update the ``DATA_DIR`` variable:

.. code-block:: bash

DATA_DIR=/data/transfer

#. Restart your Central services:

.. code-block:: bash

docker compose up -d

.. dropdown:: ``Migrate data elsewhere on your system``
:icon: file-code

#. Shut down the Central services:

.. code-block:: bash

docker compose down

#. Move the existing data directory:

.. code-block:: bash

mkdir -p /opt/other/dir
sudo mv /data/transfer /opt/other/dir/

#. Update the ``DATA_DIR`` variable:

.. code-block:: bash

DATA_DIR=/opt/other/dir/transfer

#. Restart the Central services:

.. code-block:: bash

docker compose up -d

.. _central-upgrade-2023.4:

Upgrading to Central v2023.4
Expand Down