.. _ska-tango-images-alarm-ng:

=========================
ska-tango-images-alarm-ng
=========================

This image contains `alarm-ng
<https://gitlab.elettra.eu/cs/gui/alarm-ng/>`_ from Elettra.  ``alarm-ng`` is a GUI
which can be used to receive alarms from your Tango control system.

Summary
-------

Release |version| of ska-tango-images provides the |alarm-ng-imgver| tag of
the ska-tango-images-alarm-ng OCI image.

The image uses the `debian official image <https://hub.docker.com/_/debian>`_ as a base image, using the
|alarm-ng-debian-version| tag.  This image uses the version of libtango provided
by debian.

Included Software
*****************

.. list-table::
   :header-rows: 1

   * - Package
     - Version
   * - alarm-ng
     - |alarm-ng-version|
   * - cumbia world installer
     - |cumbia-version|
   * - QWT
     - |qwt-version|

Usage Example
-------------

``alarm-ng`` is an X11 application and requires an X11 server to run.  The following
command will launch the ska-tango-images-alarm-ng image using a Linux host's
X11 server and connect to ``TANGO_HOST``:

.. code-block:: bash
   :substitutions:

    docker run --security-opt label=type:container_runtime_t \
       --net=host --user $(id -u):$(id -g) \
       -e TANGO_HOST=$TANGO_HOST -e DISPLAY=$DISPLAY -e XAUTHORITY="/Xauthority" \
       -v /tmp/.X11-unix:/tmp/.X11-unix:z -v ${XAUTHORITY:-$HOME/.Xauthority}:/Xauthority:ro \
       --rm |oci-registry|/ska-tango-images-alarm-ng:|alarm-ng-imgver|

For running on macOS, you must have an XQuartz server running with the "Allow
connections from the network clients" checked and you must provide your host IP
address in the DISPLAY.  For example,

.. code-block:: bash
   :substitutions:

   MY_IP_ADDRESS=$(scutil --nwi | grep 'address' | head -n1 | cut -d':' -f2 | tr -d ' ')
   docker run --net=host --user $(id -u):$(id -g) \
       -e TANGO_HOST=$TANGO_HOST -e DISPLAY="${MY_IP_ADDRESS}:0" -e XAUTHORITY="/Xauthority" \
       -v /tmp/.X11-unix:/tmp/.X11-unix:z -v ${XAUTHORITY:-$HOME/.Xauthority}:/Xauthority:ro \
       --rm |oci-registry|/ska-tango-images-alarm-ng:|alarm-ng-imgver|