* Overview

Syslogrelay provides system log forwarding facility for confined
environments, such as docker containers.  It listens for incoming
system log messages on the UNIX socket file /dev/log and forwards them
to the specified remote server.

The relayed messages are normalized to make sure they comply with the
RFC 3164.  In particular, hostname is added if necessary.  This is
important in docker environments, since otherwise the collector would
insert the IP address of the container or gateway in place of the
missing hostname, and neither IP is informative enough to identify the
container where the message originated.

Messages can be relayed using traditional UDP (the default), TCP and
TLS over TCP.

* Documentation

The manual page syslogrelay(8) is provided.  It is installed during
normal installation process (see below).  An online copy is available
at <http://puszcza.gnu.org.ua/software/syslogrelay>.

* Installation

The only prerequisite is POSIX thread library.  If you plan to use
TLS over TCP channel, you will also need GnuTLS, version 3.4.0 or
newer (available from https://www.gnutls.org).  The configure script
uses pkg-config to determine whether GnuTLS is present or not.

The usual build sequence is:

  ./configure
  make
  make install

The configure script understands a number of generic options that
allow you to select the installation prefix or particular installation
directories and the like.  For a detailed discussion of these, please
refer to:

https://www.gnu.org/software/autoconf/manual/html_node/Running-configure-Scripts.html

The only package-specific option is:

  --with-default-channel=URL

It defines the URL of the default output channel to use.  If not
given, file:///var/log/messages will be used.  Refer to the
documentation (syslogrelay(8)) for a discussion of output channel URLs.

* Bug reports and contacts

Send bug reports and suggestions to <gray@gnu.org>.  Be sure to
mention "syslogrelay" somewhere in the Subject line.

The project Git repository is at <http://git.gnu.org.ua/syslogrelay.git>.


* Copyright information:

Copyright (C) 2022 Sergey Poznyakoff

   Permission is granted to anyone to make or distribute verbatim copies
   of this document as received, in any medium, provided that the
   copyright notice and this permission notice are preserved,
   thus giving the recipient permission to redistribute in turn.

   Permission is granted to distribute modified versions
   of this document, or of portions of it,
   under the above conditions, provided also that they
   carry prominent notices stating who last changed them.


Local Variables:
mode: outline
paragraph-separate: "[ 	]*$"
version-control: never
End:
