commit:     33db6ad55a866b9944d8038e036c7dce65e26eea
Author:     Robin H. Johnson <robbat2 <AT> gentoo <DOT> org>
AuthorDate: Tue Mar 12 18:05:47 2024 +0000
Commit:     Robin H. Johnson <robbat2 <AT> gentoo <DOT> org>
CommitDate: Tue Mar 12 18:05:47 2024 +0000
URL:        https://gitweb.gentoo.org/proj/fifo-cronolog.git/commit/?id=33db6ad5

doc: add README & AUTHORS

Signed-off-by: Robin H. Johnson <robbat2 <AT> gentoo.org>

 AUTHORS   |  2 ++
 README.md | 22 ++++++++++++++++++++++
 2 files changed, 24 insertions(+)

diff --git a/AUTHORS b/AUTHORS
new file mode 100644
index 0000000..2ca8fed
--- /dev/null
+++ b/AUTHORS
@@ -0,0 +1,2 @@
+Christian Ruppert <id...@gentoo.org>
+Robin H. Johnson <robb...@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"
+```

Reply via email to