.. _mmmsg_installation:

Installation Guide
==================

.. contents::
   :local:
   :depth: 3

Requirements
------------

You run MMMSG service you need the following:

1. A reasonably recent server with Debian 11 Bullseye and enough disk space.
2. Hostname for the server and TLS certificate for it.

.. _mmmsg-adding-repo:

Adding Repository
-----------------

.. note::

    These instructions are same as for our :ref:`SIPIS repository<sipis-adding-repo>`.

Add our key and repository to Debian:

1. Execute the following command to install our public key:

 .. code-block:: bash

   wget -O - https://dist.acrobits.cz/debian/acrobits.gpg.key | apt-key add -

 The fingerprint for our key is **1DB8 E683 A6F4 919B BFF1  6A7C FFCC BAF7 9FF5 CF45**

2. Create a new file ``/etc/apt/sources.list.d/Acrobits.list`` with the following content::

    deb http://username:password@dist.acrobits.cz/debian bullseye main

  .. note::
     
      You will get a username and password from Acrobits representative.

  .. note::
     
     If you have SIPIS installation, you can use the same username and password.

3. Run ``apt-get update``

Installing mmmsg
-----------------
Run 

 .. code-block:: bash

     apt-get install mmmsg2

Configuring MMMSG
-----------------

The configuration file is ``/etc/acrobits/mmmsg2/Settings.xml``.
You need to replace mmmsg.example.com with domain name of your server as a base url.

The other settings are set to sensible defaults and can be kept as they are.

Setting up TLS
----------------

MMMSG service by default listens on port 8920 without encryption.  We recommend you use TLS proxy, either stunnel or nginx and we describe their configuration in this document.

Nginx as a TLS proxy
....................

Install nginx (``apt-get install nginx``) and copy the file ``/usr/share/doc/mmmsg2/nginx-config.conf`` into ``/etc/nginx/sites-enabled/mmmsg.conf``.  Edit it and change the parameters ``ssl_certificate`` and ``ssl_certificate_key`` so that they point to certificate and key pair for your hostname. Also change ``server_name`` parameter to your server's hostname.  Then reload nginx configuration (``systemctl reload nginx.service``).

.. note

    Keep the settings ``proxy_request_buffering`` and ``proxy_buffering`` turned ``off``.

Running the service
-------------------

To start the service run the following command:
  .. code-block:: bash

     systemctl start mmmsg2.service

.. note::

    To make the service start automatically on computer start run
    ``systemctl enable mmmsg2.service``

To stop the service run:
  .. code-block:: bash
  
    systemctl stop mmmsg2.service