git.lirion.de

Of git, get, and gud

aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/README.md b/README.md
index cda17ce..27d5e18 100644
--- a/README.md
+++ b/README.md
@@ -11,3 +11,23 @@ Some examples:
Consider this repository examples for now. Some of this is still heavy WiP,
e.g. the KVM stuff is still too specific and not all dependencies required,
goal is to make this more abstract/generic and less redundant.
+
+## Content
+
+The directories *etc/systemd/system*, *etc/tmpfiles.d*, and *usr/local/[s]bin* should be
+self-explanatory. Therein, you'll find the following:
+* **freshclam(d):** Quickly written service and scripts to start and stop
+ ClamAV's freshclam as a daemon. The definition will update
+ the ClamAV database 4 times a day. No need for a timer as this
+ is simply a parameter passed on to freshclam. The script used
+ for administering this is called freshclamd, it does not
+ interfere with anything on a Fedora 28. Rename it if your
+ distro is different, a Debian user will not need this at all ;)
+* **kvm-\*:** Stuff I wrote for starting and stopping KVM networks and virtual
+ machines through systemd. Networks usually are covered by the
+ autostart function of KVM, and machines can be safely shut down
+ with libvirt-guests - but in this scenario I wanted to automate
+ through and integrate everything into systemd services, so,
+ well - here we are. Still under development, look at the
+ comments in the services - the starting and stopping of the VMs
+ is still insufficiently written.