Linux or macOS update
=====================

..  contents:: :local:


Introduction
------------

When updating from version 4.26.0 or newer to the latest version
on Linux and macOS,
you can use the included ``bin/update.sh`` script
providing as a parameter the latest SFTPPlus package for your OS.
This takes care of all the necessary steps
while backing up your current installation.
If you wish to rollback the update, the backed-up installation can be used
to revert to the previous version through the ``bin/rollback.sh`` script.

The following directories are used for backing up the existing installation
when updating to the latest version or rolling back to a previous version using
the provided shell scripts (assuming the default ``sftpplus-mft`` service name):

* ``/opt/sftpplus_backups/sftpplus-mft_UPDATE_AUTO_BACKUP``

* ``/opt/sftpplus_backups/sftpplus-mft_ROLLBACK_AUTO_BACKUP``

The ``/opt/sftpplus_backups`` path for automatic backups can be customized
in the ``bin/setup_helper.sh`` script from your SFTPPlus installation path,
provided that the new custom path for automatic backups contains no spaces
and resides on a filesystem supporting file permissions and capabilities.

In the case that you need to rollback to a backup other than one
automatically saved by the ``bin/update.sh`` script, you can provide
the path to its directory as a parameter to the ``bin/rollback.sh`` script.

..  note::
    Regardless of the chosen updating procedure,
    check if any custom paths are used for the installation.
    Documentation instructions use default paths and may
    need to be modified accordingly.


Consult the :doc:`Server Release Notes<../release-notes>`,
as it contains detailed information on the steps required
for upgrading between major versions.

If not noted otherwise in the release notes, the ``bin/update.sh`` script can
also be used for performing an upgrade to the next major version of SFTPPlus.


Manual update or upgrade
------------------------

Before updating or upgrading a SFTPPlus installation to the latest version,
stop its system service.

Then, ensure you have a backup copy of the server configuration file.

Extract and copy the new files over the existing installation sub-directory.

Review the filesystem permissions.

Once all files are copied and their permissions are reviewed,
you can start the SFTPPlus service.

To find out more about the latest version and any relevant changes
between your version and the latest release, please consult
the :doc:`Server Release Notes<../release-notes>`.
