Upgrading your SIPIS installation
=================================

.. _sipis-backup:

Backing Up
----------

We recommend that you create a full backup of your SIPIS machine
regularly.  When doing SIPIS upgrades (or when moving SIPIS to
a different machine) your backup needs to include at least
the following items:

*  Files from ``/etc/sipis/`` (usually ``sipis.key`` and ``Settings.xml``)
*  Your TLS certificates and keys.
*  The ``sipis`` database (it is unusable without ``sipis.key`` file).
*  Your username and password for Acrobits' repository (however, you can get a new one from Acrobits).

Configuration files version
----------------------------

Occassionally we make changes to a default configuration file.
In that case the upgrade process will ask you if you want to replace
the configuration file by the new version.  This is Debian's package manager asking you.
If this happens, you should answer *No* so that you *keep your currently-installed version*.

New version from the package will be installled with the suffix ``.dpkg-dist``. If you answered *Yes*, your version will be renamed by adding suffix ``.dpkg-old``.  In both cases you should check the differences between the old and new version to decide what settings you think are best for you.

Regular upgrading
-----------------

Regular upgrading means upgrading without moving between Debian versions.
This upgrade is usually as simple as running

.. code-block:: bash

   apt-get update && apt-get upgrade

The upgrade will stop SIPIS server, install a new version and start it again.

.. note::

   This upgrades all Debian packages. If you want to upgrade only SIPIS, run ``apt-get update && apt-get install sipis``.


  .. _pnm_server_notice:

  .. important::

     Make sure that you have only this server set up as NotificationServer in your Settings.xml file: ``<NotificationServer Name="*" Host="pnm.cloudsoftphone.com" Port="6552" Premium="No" RequiresTls="Yes" />``

Upgrading to version 4.x
------------------------

Version 4.x of SIPIS (released for Debian 12 Bookworm) uses a new database schema. If you upgrade SIPIS to version 4.x by installing the packages over the old ones, SIPIS will continue using the old schema but will not be able to use all the new features. To use the new features, you need to :ref:`upgrade the database schema manually using this guide<db-migrate>`.