aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 15 insertions, 5 deletions
diff --git a/README.md b/README.md
index 1fd4fae..92725fe 100644
--- a/README.md
+++ b/README.md
@@ -24,15 +24,22 @@ followed by:
This will place an executable at `/usr/bin/udp514-journal`,
documentation can be found in `/usr/share/doc/udp514-journal/`.
-Additionally a systemd unit file is installed to
-`/usr/lib/systemd/system/udp514-journal.service`.
+Additionally systemd unit files `udp514-journal.service` and
+`udp514-journal.socket` are installed to
+`/usr/lib/systemd/system/`.
Usage
-----
-Just run `udp514-journal` or start a systemd unit with
-`systemctl start udp514-journal`. Make sure UDP port 514 is not blocked
-in your firewall.
+Just run `udp514-journal` or start a systemd unit with:
+
+ systemctl start udp514-journal.socket
+
+Make sure UDP port 514 is not blocked in your firewall.
+
+To enable it permanently to make it start on system boot run:
+
+ systemctl enable --now udp514-journal.socket
Use `journalctl` to view the logs:
@@ -70,3 +77,6 @@ URL:
Mirror:
[eworm.de](https://git.eworm.de/cgit.cgi/udp514-journal/)
[GitLab.com](https://gitlab.com/eworm-de/udp514-journal#udp514-journal)
+
+---
+[⬆️ Go back to top](#top)