.. SPDX-FileCopyrightText: Copyright 2012-  David Sommerseth <dazo@eurephia.org>
   SPDX-License-Identifier: GPL-2.0-only

   logactio documentation master file, created by
   sphinx-quickstart on Mon Sep 17 10:59:56 2012.

LogActio - simple log file watcher framework
============================================

LogActio is a simple framework for watching log files and do certain actions
when some predefined events happens.  It's modular by design and can make use
of external reporter modules to handle the actions.

The use case for logactio is on a running server where you want to alert
users and/or sys-admins when something unexpected happens.

Simple reporter modules using HTTP/HTTPS, SMTP, ntfy.sh notifications and
iptables/nftables IP blocking are bundled with logactio.

Source code
-----------

The LogActio project uses `Radicle <https://radicle.network/learn>`__ as the main
project forge.  Install the `Radicle toolchain <https://radicle.network/guides/getting-started>`__
and run this command:

::

   $ rad clone rad:z3L9dYEExJhof9DvqvgsMF88ZMySi

Alternatively, using just `git` - which does not give write access to the issue
or merge request ("patch") trackers.

::

   $ git clone https://rad.basenordic.org/logactio.git


To *view* the source code, issue and patch tracker in a web browser, visit
https://radicle.network/nodes/rad.basenordic.org/rad:z3L9dYEExJhof9DvqvgsMF88ZMySi.


Contents:

.. toctree::
   :maxdepth: 2

   installing
   configuration
   starting
..   writingreporters