.. _enable_map:

Configure Maps
========================================

There is a map view on the :guilabel:`Video Sources`, :guilabel:`Episodes & Events`, and the :guilabel:`Search` tabs.
Maps are an integral part of the video analytics system and play an important role in ensuring security. The functionality of the maps in FindFace Multi allows the operator to quickly navigate the geographical location of the cameras and easily navigate the area where the events of interest take place.

To configure maps functionality in FindFace Multi, do the following:

#. Open the ``/opt/findface-multi/configs/findface-multi-legacy/ui-config.yaml`` configuration file.

   .. code::

      sudo vi /opt/findface-multi/configs/findface-multi-legacy/ui-config.yaml

#. Find the section ``MAP CONFIG EXAMPLE``.

   .. code:: yaml

      # MAP CONFIG EXAMPLE
      map:
        enabled: true
        default_zoom: 15
        default_center:
          lat: 55.7558
          lng: 37.6173
        maximum_objects_on_map: 250
        show_cameras_thumbnails: true
        providers:
          - id: default
            name: OSM
            type: tile
            url: https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png
          # - id: stamen
          #   name: Stamen Toner
          #   type: tile
          #   url: 'https://tiles.stadiamaps.com/tiles/stamen_toner/{z}/{x}/{y}.png'


   If necessary, configure the following parameters:

   * ``default_zoom``: default map zoom.
   * ``default_center``: default map center.
   * ``maximum_objects_on_map``: the maximum number of objects displayed on the map.
   * ``show_cameras_thumbnails``: enable/disable the camera's thumbnails on the :guilabel:`Video Source` tab in the map view mode.

#. (Optional) To integrate a new tile server, do the following:

   #. In the ``/opt/findface-multi/configs/findface-multi-legacy/ui-config.yaml`` configuration file, find the ``MAP CONFIG EXAMPLE → map → providers`` section and add the tile server configuration.

      .. code::

         sudo vi /opt/findface-multi/configs/findface-multi-legacy/ui-config.yaml

      .. code::

            # MAP CONFIG EXAMPLE
            map:
            ...
              providers:
                ...
                - id: provider_ID
                  name: my-server_name
                  type: my_type
                  url: 'https://my-server/tiles/{z}/{x}/{y}.png'
                ...

      .. tip::

            The ``/opt/findface-multi/configs/findface-multi-legacy/ui-config.yaml`` configuration file includes a commented-out example for the Stamen Toner tile service. Just uncomment it to use.

              .. code:: yaml

                map:
                  ...
                  providers:
                    ...
                    - id: stamen
                      name: Stamen Toner
                      type: tile
                      url: 'https://tiles.stadiamaps.com/tiles/stamen_toner/{z}/{x}/{y}.png'

   #. In the ``/opt/findface-multi/configs/findface-multi-ui/nginx-site.conf`` configuration file, find the ``server`` section and add the hostname of your server ``my-server.ru`` into the ``set $csp_policy`` section after ``*.tile.openstreetmap.org``.

    .. code::

       sudo vi /opt/findface-multi/configs/findface-multi-ui/nginx-site.conf

    .. code::

       server {
               ...
               set $csp_policy "default-src 'self'; img-src 'self' *.tile.openstreetmap.org my-server.ru blob: data:; media-src 'self' blob:; connect-src 'self' data:; style-src 'self' 'unsafe-inline'; frame-src 'self';  object-src 'self'; frame-ancestors 'self'";
               ...
       }


    .. tip::

       For the Stamen Toner service, add ``*.stadiamaps.com`` after ``*.tile.openstreetmap.org``.


#. Restart all FindFace Multi containers.

   .. code::

    cd /opt/findface-multi/
    sudo docker-compose restart

.. seealso::

  * :ref:`cameras`
  * :ref:`events`
  * :ref:`episodes`
  * :ref:`search-objects`