renamed readme
authorAndrew Lorimer <andrew@charles.cortex>
Sun, 17 Mar 2019 09:17:02 +0000 (20:17 +1100)
committerAndrew Lorimer <andrew@charles.cortex>
Sun, 17 Mar 2019 09:17:02 +0000 (20:17 +1100)
README.md [new file with mode: 0644]
readme.md [deleted file]
diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..f4416b8
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+# logparse
+
+([source](https://git.lorimer.id.au/logparse.git/)) // written by [Andrew Lorimer](https://lorimer.id.au)
+
+This is a utility to analyse medium-term logs (up to around 30 days old) on servers. It summarises notable events and statistics reported from several programs. At the moment, logparse can interface with:
+
+- sshd (number of logins, list users & clients)
+- sudo (number of sessions, users, commands)
+- cron (list commands)
+- [nameget](https://git.lorimer.id.au/scripts.git/tree/nameget.sh) (list successful/failed downloads)
+- apache (list requests, clients, user agents, bytes transferred, errors)
+- smbd (number of logins, list users & clients)
+- postfix (list recipients and bytes sent)
+- zfs (srub data, usage data)
+- lmsensors (system, CPU, per-core, per-disk)
+- du (specify paths to show usage and change since last analysis)
+
+Support for further services and custom scripts is planned.
+
+logparse is also integrated with systemd logrotate to optionally rotate logs only after they have been summarised, and the user may choose to get an email (requires postfix) or a static HTML page with the log summary. As an added feature, IP addresses from ssh/samba/apache may be resolved to either hostnames or FQDNs.
+
+Configuration is through the file `/etc/logparse.conf`, in yaml format.
+
+Note that logparse must be run as root (preferably as a cron job). This is required for temperature reading and for writing to `/var/log/`.
diff --git a/readme.md b/readme.md
deleted file mode 100644 (file)
index f4416b8..0000000
--- a/readme.md
+++ /dev/null
@@ -1,24 +0,0 @@
-# logparse
-
-([source](https://git.lorimer.id.au/logparse.git/)) // written by [Andrew Lorimer](https://lorimer.id.au)
-
-This is a utility to analyse medium-term logs (up to around 30 days old) on servers. It summarises notable events and statistics reported from several programs. At the moment, logparse can interface with:
-
-- sshd (number of logins, list users & clients)
-- sudo (number of sessions, users, commands)
-- cron (list commands)
-- [nameget](https://git.lorimer.id.au/scripts.git/tree/nameget.sh) (list successful/failed downloads)
-- apache (list requests, clients, user agents, bytes transferred, errors)
-- smbd (number of logins, list users & clients)
-- postfix (list recipients and bytes sent)
-- zfs (srub data, usage data)
-- lmsensors (system, CPU, per-core, per-disk)
-- du (specify paths to show usage and change since last analysis)
-
-Support for further services and custom scripts is planned.
-
-logparse is also integrated with systemd logrotate to optionally rotate logs only after they have been summarised, and the user may choose to get an email (requires postfix) or a static HTML page with the log summary. As an added feature, IP addresses from ssh/samba/apache may be resolved to either hostnames or FQDNs.
-
-Configuration is through the file `/etc/logparse.conf`, in yaml format.
-
-Note that logparse must be run as root (preferably as a cron job). This is required for temperature reading and for writing to `/var/log/`.