.. /*  
    * This file is part of the SavaPage project <https://www.savapage.org>.
    * Copyright (c) 2026 Datraverse B.V.
    * Author: Rijk Ravestein.
    *
    * SPDX-FileCopyrightText: (c) 2020 Datraverse B.V. <info@datraverse.com>
    * SPDX-License-Identifier: CC-BY-SA-4.0
    *
    * For more information, please contact Datraverse B.V. at this
    * address: info@datraverse.com
    */

.. _app-migrating-data:

Migrate Data to New Server
--------------------------

The simplest way to migrate the data to the new server is to use the
backup and restore process.

1. Backup the data from the old system using the :ref:`Admin Web App <ch-webapp-admin-options-backups>`, 
   or see the instructions at :ref:`db-export and db-export-to <app-tools-savapage-db-export>` 
   for the command-line variant.

.. RST_HTML_NEWLINE

2. Copy the backup zip file created in the backup step onto the
   new server.

.. RST_HTML_NEWLINE
   
3. Stop the |PRODUCT_NAME| Server by running the stop script. See
   :ref:`Stopping and Starting the Server <app-tools-start-stop>`.

.. RST_HTML_NEWLINE
   
4. Restore the data from the old system into |PRODUCT_NAME| on the new server by
   following the :ref:`Database Import <app-tools-savapage-db-import>`
   instructions. The import commands need to be run as the ``savapage`` user.

.. RST_HTML_NEWLINE

5. Migrate the database :ref:`Encryption Keys <ch-security-encrypted-secrets>` 
   by copying the ``encryption.properties`` file at location 
   ``/opt/savapage/server/data/`` from the old server to the same
   location on the new server. Overwrite the existing file on the new
   server. Make sure this file is owned by ``savapage`` , and restrict access by executing: 

   .. code-block:: bash 

      sudo chown savapage:savapage encryption.properties
      sudo chmod 600 encryption.properties 

.. RST_HTML_NEWLINE

6. If present, migrate the :ref:`User Name Aliases <ch-auth-print-user-name-aliases>` and
   :ref:`Internal Groups <ch-webapp-admin-options-internal-groups>` by
   copying the ``username-aliases.txt`` and ``internal-groups.txt`` files
   at location ``/opt/savapage/server/data/conf/`` from the old server
   to the same location on the new server.
   
   If the alias file depends on users from a 
   :ref:`User Source on the local Unix system <ch-webapp-admin-options-user-source-unix>`, 
   be sure that these users also exist on the new server.

.. RST_HTML_NEWLINE

7. If present, migrate any messages in the email outbox by copying the files at location
   ``/opt/savapage/server/data/email-outbox/`` from the old server to
   the same location on the new server.

.. RST_HTML_NEWLINE
   
8. If present migrate the |RST_LINK_DOCUMENT_STORE| from the old server
   to the same location on the new server.

.. RST_HTML_NEWLINE
   
9. Migrate all customization files to the new server.
   See |RST_LINK_CUSTOMIZATION| and |RST_LINK_PPD_EXTENSIONS|.

.. RST_HTML_NEWLINE
   
10. Migrate all plug-in files to the new server (except for the ``lib/.jar`` 
    files already present on the new server). See |RST_LINK_PLUG_INS|.

.. RST_HTML_NEWLINE

11. Check if all essential files are migrated: see |RST_LINK_FILE_LOCATIONS|.
    Take special attention to |RST_LINK_ALTERNATIVE_FILE_LOCATIONS|.

.. RST_HTML_NEWLINE

12. Start the |PRODUCT_NAME| Server by running the start script. 
    See :ref:`Stopping and Starting the Server <app-tools-start-stop>`.

.. RST_HTML_NEWLINE

13. Check that all data has been migrated correctly and the system works as expected by comparing
    :ref:`Users <ch-webapp-admin-users>` and :ref:`Documents <ch-webapp-admin-doclog>` data 
    in the old and new |RST_LINK_ADMIN_WEBAPP|.