aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRobin H. Johnson <robbat2@gentoo.org>2024-03-12 11:05:47 -0700
committerRobin H. Johnson <robbat2@gentoo.org>2024-03-12 11:05:47 -0700
commit33db6ad55a866b9944d8038e036c7dce65e26eea (patch)
tree93ba377abf6a080812ee3d86ac237620c60ff963
parentbuild: cleanup Makefile (diff)
downloadfifo-cronolog-33db6ad55a866b9944d8038e036c7dce65e26eea.tar.gz
fifo-cronolog-33db6ad55a866b9944d8038e036c7dce65e26eea.tar.bz2
fifo-cronolog-33db6ad55a866b9944d8038e036c7dce65e26eea.zip
doc: add README & AUTHORS
Signed-off-by: Robin H. Johnson <robbat2@gentoo.org>
-rw-r--r--AUTHORS2
-rw-r--r--README.md22
2 files changed, 24 insertions, 0 deletions
diff --git a/AUTHORS b/AUTHORS
new file mode 100644
index 0000000..2ca8fed
--- /dev/null
+++ b/AUTHORS
@@ -0,0 +1,2 @@
+Christian Ruppert <idl0r@gentoo.org>
+Robin H. Johnson <robbat2@gentoo.org>
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7ec95e7
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+fifo-cronolog
+-------------
+This is a little tool that connects a named pipe/FIFO into the stdin of `cronolog`.
+
+This is useful for cases where the logging destination cannot be specified as a
+program. It was originally written to do logging from Squid, but later re-used
+for Nginx & other tools.
+
+Cronolog's canonical example, in an Apache configuration
+```
+TransferLog "|/www/sbin/cronolog /www/logs/%Y/%m/%d/access.log"
+```
+
+Is converted into:
+1. Fifo-cronolog as (via your init system, so it gets restarted):
+```
+fifo-cronolog /run/apache-access.pid /run/apache-access.fifo /www/logs/%Y/%m/%d/access.log
+```
+2. Apache configuration:
+```
+TransferLog "/run/apache-access.fifo"
+```