.. _Web UI:

Web UI
======

Scout includes a web-based management interface for editing settings and managing the
servlet filter installation without touching configuration files directly.

Accessing the UI
----------------

Open the following URL in a browser, replacing ``<your-server>`` with the hostname or IP
address of your AntMedia server:

.. code-block::

   http://<your-server>:5080/rest/scout/ui/

Dashboard
---------

The **Dashboard** provides an overview of Scout status — license validity, plugin version,
and configured application count — and includes the **Reload Configuration** button.

Configuration Hot Reload
^^^^^^^^^^^^^^^^^^^^^^^^^

After making configuration changes, you can reload the configuration without restarting
AntMedia Server:

1. Click **"Reload Configuration"** on the Dashboard
2. Review the warning about active streams
3. Click **"Reload"** to confirm

**Behaviour:**

- Active streams continue with their existing configuration
- New streams use the reloaded configuration
- No interruption to ongoing streams

Global Settings
---------------

The **Global Settings** page lets you configure settings that apply across all applications:

- **License Key** — your Scout license key.
- **Delivery** — the default delivery mode:

  - **HTTP Response Headers only** — attach ``CMSD-Static:`` header to matching responses.
  - **Manifest body only** — inject ``#EXT-X-CMSD-STATIC:`` tag (HLS) or
    ``<SupplementalProperty>`` element (DASH) into manifest responses.
  - **Both headers and manifest body** — apply both injection methods simultaneously.

- **Scope** — which request types receive CMSD data:

  - **Manifests and segments** — annotate all ``.m3u8``, ``.mpd``, ``.ts``, and ``.m4s``
    requests.
  - **Manifests only** — annotate only ``.m3u8`` and ``.mpd`` requests.
  - **Segments only** — annotate only ``.ts`` and ``.m4s`` requests.

Application Settings
--------------------

Each AntMedia application appears in the left sidebar. Applications that do not yet have
Scout's servlet filter installed are shown in a lighter color.

Click an application to open its settings page.

- **Enabled** — toggle Scout on or off for this application. Setting this to ``false``
  and saving removes the application's configuration section entirely.
- **Delivery** and **Scope** — same as global settings, but scoped to this application
  only. Leave at the default to inherit the global value.

Filter Management
^^^^^^^^^^^^^^^^^^

Each application settings page shows a **Servlet Filter** section indicating whether the
``ScoutFilter`` servlet filter is currently installed in that application's ``web.xml``:

- **Install Filter** — adds ``ScoutFilter`` to the application's ``WEB-INF/web.xml``
  and restarts the application automatically. The filter intercepts HLS and DASH requests
  and injects CMSD data. This is required for Scout to annotate responses.
- **Remove Filter** — removes the filter from ``web.xml`` and restarts the application.
  Scout will stop annotating responses for this application.

.. note::
   The filter install and remove operations edit ``web.xml`` in place and trigger an
   application reload. The application will be briefly unavailable during the restart.