From e54412944312c1babd66d6c8e1f315a87ac0d349 Mon Sep 17 00:00:00 2001
From: Chris Caron <lead2gold@gmail.com>
Date: Sun, 20 Aug 2023 10:54:33 -0400
Subject: [PATCH] Created Notify_rsysog (markdown)

---
 Notify_rsysog.md | 64 ++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 64 insertions(+)
 create mode 100644 Notify_rsysog.md

diff --git a/Notify_rsysog.md b/Notify_rsysog.md
new file mode 100644
index 0000000..67d0e54
--- /dev/null
+++ b/Notify_rsysog.md
@@ -0,0 +1,64 @@
+## Remote Syslog Notifications
+* **Source**: https://tools.ietf.org/html/rfc5424
+* **Icon Support**: No
+* **Message Format**: Text
+* **Message Limit**: 32768 Characters per message
+
+Remote Syslog is a way for network devices to send event messages to a logging server – usually known as a Syslog server. The Syslog protocol is supported by a wide range of devices and can be used to log different types of events.
+
+### Syntax
+Valid syntax is as follows:
+* `syslog://{host}`
+* `syslog://{host}:{port}`
+* `syslog://{host}/{facility}`
+* `syslog://{host}:{port}/{facility}`
+
+One might change the facility on a remote syslog (rsyslog) server from it's default like so:
+* `syslog://localhost/local5`
+
+### Parameter Breakdown
+| Variable    | Required | Description
+| ----------- | -------- | -----------
+| host        | No       | Query a remote Syslog server (rsyslog) by optionally specifying the hostname
+| port        | No       | The remote port associated with your rsyslog server provided.  By default if this value isn't sent port **514** is used by default.
+| facility    | No       | The facility to use, by default it is `user`. Valid options are **kern**, **user**, **mail**, **daemon**, **auth**, **syslog**, **lpr**, **news**, **uucp**, **cron**, **local0**, **local1**, **local2**, **local3**, **local4**, **local5**, **local6**,  and **local7**
+| logpid     | Yes      | Include PID as part of the log output.
+
+### Example
+Send a Remote Syslog notification
+```bash
+# The following sends a syslog notification to the `user` facility
+apprise -vv -t "Test Message Title" -b "Test Message Body" \
+   rsyslog://localhost
+```
+
+#### Internal RSyslog Test Server
+```bash
+# Setup a simple docker file that will run our our rsyslog server for us:
+cat << _EOF > dockerfile.syslog
+FROM ubuntu
+RUN apt update && apt install rsyslog -y
+RUN echo '\$ModLoad imudp\n \\
+\$UDPServerRun 514\n \\
+\$ModLoad imtcp\n \\
+\$InputTCPServerRun 514\n \\
+\$template RemoteStore, "/var/log/remote/%\$year%-%\$Month%-%\$Day%.log"\n \\
+:source, !isequal, "localhost" -?RemoteStore\n \\
+:source, isequal, "last" ~ ' > /etc/rsyslog.conf
+ENTRYPOINT ["rsyslogd", "-n"]
+_EOF
+
+# build it:
+docker build -t mysyslog -f dockerfile.syslog .
+
+# Now run it:
+docker run  --cap-add SYSLOG --restart always \
+  -v $(pwd)/log:/var/log \
+  -p 514:514 -p 514:514/udp --name rsyslog mysyslog
+
+# In another terminal window, you can look into a directory
+# relative to the location you ran the above command for a directory
+# called `log`
+You may need to adjust it's permissions, the log file will only get
+created after you send an apprise notification.
+```
\ No newline at end of file