.. _installation_prerequisites:

Prerequisites
=============

Open Notificaties is most often deployed as a Docker container. While the
`container images <https://hub.docker.com/r/openzaak/open-notificaties/>`_ contain all the
necessary dependencies, Open Notificaties does require extra service to deploy the full stack.
These dependencies and their supported versions are documented here.

The ``docker-compose.yml`` (not suitable for production usage!) in the root of the
repository also describes these dependencies.

PostgreSQL
----------

.. warning::

   Since Open Notificaties version 1.10.0, PostgreSQL version 14 or higher is required. Attempting
   to deploy this version of Open Notificaties with PostgreSQL 13 or lower will result in errors!

Open Notificaties currently only supports PostgreSQL as datastore.

The supported versions in the table below are tested in the CI pipeline.

================ =========== ======= ======= ======= =======
Postgres version 13 or lower 14      15      16      17
================ =========== ======= ======= ======= =======
Supported?       |cross|     |check| |check| |check| |check|
================ =========== ======= ======= ======= =======

.. warning:: Open Notificaties only supports maintained versions of PostgreSQL. Once a version is
   `EOL <https://www.postgresql.org/support/versioning/>`_, support will
   be dropped in the next release.

Redis
-----

Open Notificaties uses Redis as a cache backend, especially relevant for admin sessions, and as
task queue broker.

Supported versions: 5, 6, 7.

.. |check| unicode:: U+2705 .. ✅
.. |cross| unicode:: U+274C .. ❌