.. /*  
    * This file is part of the SavaPage project <https://www.savapage.org>.
    * Copyright (c) 2026 Datraverse B.V.
    * Author: Rijk Ravestein.
    *
    * SPDX-FileCopyrightText: (c) 2020 Datraverse B.V. <info@datraverse.com>
    * SPDX-License-Identifier: CC-BY-SA-4.0
    *
    * For more information, please contact Datraverse B.V. at this
    * address: info@datraverse.com
    */

.. _ch-user-client:

.. figure:: ../images/manual/savapage-logo-no-text-100px.png
   :width: 75px

|USER_CLIAPP|
=============

.. admonition:: |ADMONITION_TABLE_OF_CONTENTS|

   - :numref:`{number}. {name} <ch-user-client-intro>`
   - :numref:`{number}. {name} <ch-user-client-options>`
   - :numref:`{number}. {name} <ch-user-client-deployment>`


.. _ch-user-client-intro:

Introduction
------------

The |USER_CLIAPP| is a Java application for desktops and notebooks that
resides in the *system tray*.

According to the `Oracle Java
Documentation <https://docs.oracle.com/javase/tutorial/uiswing/misc/systemtray.html>`__:

*"The system tray is a specialized area of the desktop where users can
access currently running programs. This area may be referred to
differently on various operating systems. On Microsoft Windows, the
system tray is referred to as the Taskbar Status Area, while on the GNU
Network Object Model Environment (GNOME) Desktop it is referred to as
the Notification Area. On K Desktop Environment (KDE) this area is
referred to as the System Tray. However, on each system the tray area is
shared by all applications running on the desktop."*

The SavaPage |USER_CLIAPP| is provided as a notifier of personal user
events like:

-  A successful print to |PRODUCT_NAME|. See :ref:`SavaPage as
   Printer <ch-printer>`.

-  A |PROXYPRINTER| started printing one of your jobs. See :ref:`Proxy
   Printers <ch-webapp-admin-proxyprinters>`

A notification message is typically displayed near the SavaPage tray
icon in the form of a balloon (Windows) or message box (GNU/Linux,
macOS).

The :ref:`User Web App <ch-security-session-timeout>` opens for the
authenticated user at a double-click on the tray icon, a click in the
notification message or selecting the **Open Web App...** item from the tray
icon context menu. When the |USER_CLIAPP| is trusted as authentication
source no extra login is needed.

|USER_CLIAPP| authentication is explained in :ref:`User Client
Authentication <ch-webapp-admin-options-advanced-cliapp>`.

Client access can be restricted by IP address with these configuration
properties:

.. list-table:: User Client Access Configuration Properties 
   :width: 100%
   :widths: 40 60
   :header-rows: 1

   * - Configuration property
     - Description

   * - cliapp.ip-addresses-allowed 
     - A :ref:`CIDR Set <ch-install-on-linux-cidr-set>` of
       Client IP addresses that are allowed to use the User Client App
       (when void, all client addresses are allowed).

   * - cliapp.auth.ipaddresses-denied.enable
     - Enable (``Y``) or Disable (``N``) User Client Authentication for 
       clients that are denied for their IP address.

See |RST_LINK_CONFIG_EDITOR| on how to enter these properties.

.. note::

   :ref:`Rate Limiting <ch-security-rate-limiting>` is applied to login
   failures.

.. important::

   When using the |USER_CLIAPP| concurrently with the :ref:`User Web
   App <ch-webapp-user>` and :ref:`Proxy Print
   Authentication <ch-webapp-admin-devices-card-reader-proxy-print-auth>`
   you are strongly advised to use an external database like PostgreSQL.
   See :ref:`Using an External Database <ch-external-db>`.

.. warning::

   Java applications with system tray icons do not work properly with
   GNOME Shell. This is a persistent `Java
   bug <https://bugzilla.redhat.com/show_bug.cgi?id=1014448>`__ that is
   still not resolved. As a workaround, use the ``--anchor`` command
   line option for an alternative display.