.. _installation_index:

Installation
============

There are several ways to install Open Notificaties. A scalable solution is to use
:ref:`Kubernetes<deployment_kubernetes>`.

Before you begin
----------------

* Check the :ref:`minimum system requirements<installation_hardware>` for the target
  machine(s).
* Make sure the target machine(s) have access to the Internet.
* The target machine(s) should be reachable via at least a local DNS entry:

  * `Open Zaak`_: ``open-zaak.<organization.local>``
  * Open Notificaties: ``open-notificaties.<organization.local>``

  The machine(s) do not need to be publically accessible and do not need a public DNS
  entry. In some cases, you might want this but it's not recommended. The same machine
  can be used for both `Open Zaak`_ and Open Notificaties.

* If you want to use `NLX`_, make sure you have a publicaly available domain name, for
  example ``nlx.<organization.com>``, where your NLX-inway is accessible to the outside
  world.


.. _`Open Zaak`: https://github.com/open-zaak/open-zaak
.. _`NLX`: https://nlx.io/

Guides
------

.. toctree::
   :maxdepth: 1

   hardware
   prerequisites
   deployment/kubernetes
   configuration/index
   observability/index
   self_signed

Post-install checklist
----------------------

After Open Notificaties has been installed successfully, go through the following
checklist to see if the software works as expected:

**Check configuration**

Check the configuration page for Open Notificaties, accessible at the url
``https://open-notificaties.gemeente.nl/view-config/``.
This page will indicate whether certain settings are properly configured.