.. /*  
    * 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
    */

.. _app-tools-savapage-atom-feed:

Atom Feed Service
-----------------

SavaPage publishes system information of the past day in 
`Atom Syndication Format <https://en.wikipedia.org/wiki/Atom_(Web_standard)>`__. 
The info is meant for administrators and includes runtime status, statistics,
errors and warnings. The feed is available at URL path
:ref:`feed/admin/ <app-url-cheat-sheet>` and protected by Basic HTTP
Authentication. It can be enabled and configured with the properties
shown below.

.. list-table:: Atom Feed Configuration Properties
   :width: 100%
   :header-rows: 1
   
   * - Configuration property
     - Description
   * - feed.atom.admin.enable
     - Set to ``Y`` or ``N`` (default) to enable or disable.
   * - feed.atom.admin.username
     - Basic HTTP Authentication User name.
   * - feed.atom.admin.password
     - Basic HTTP Authentication User password.
   * - feed.atom.admin.schedule
     - Feed publication schedule according to the default 
       :ref:`Cron Trigger Expression <app-job-scheduling-cron>`
       ``"0 0 3 ? * 3-7"``. The previous feed is overwritten: 
       no history is held in |PRODUCT_NAME|. 
       See :ref:`Atom Feed Job <app-job-scheduling-atom-feed-job>`. |br|
       |br|
       A feed can be published ad hoc in the Admin Web App.
       See :ref:`Atom Feed <ch-webapp-admin-options-advanced-atom-feed>`.
   * - feed.atom.admin.uuid
     - Universally unique identifier of the Atom Feed (generated by |PRODUCT_NAME|).


See |RST_LINK_CONFIG_EDITOR| on how to change these properties.

.. note::

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

.. tip::

   `QuiteRSS <https://quiterss.org/>`__ is a open-source cross-platform
   RSS/Atom news feeds reader.