aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorYunchih Chen <yunchih.cat@gmail.com>2017-12-01 11:20:42 +0800
committerYunchih Chen <yunchih.cat@gmail.com>2017-12-01 11:20:42 +0800
commit1336440f83216c58e2558fd07fec307422051cd6 (patch)
treed634e707b5eb1d3aeaaf97bee8affcd933bd472e
parentecd23b3efbbf338ef54447cad1c24cfcce8b785b (diff)
downloadnfcollect-1336440f83216c58e2558fd07fec307422051cd6.tar
nfcollect-1336440f83216c58e2558fd07fec307422051cd6.tar.gz
nfcollect-1336440f83216c58e2558fd07fec307422051cd6.tar.bz2
nfcollect-1336440f83216c58e2558fd07fec307422051cd6.tar.lz
nfcollect-1336440f83216c58e2558fd07fec307422051cd6.tar.xz
nfcollect-1336440f83216c58e2558fd07fec307422051cd6.tar.zst
nfcollect-1336440f83216c58e2558fd07fec307422051cd6.zip
Add READEME.md
-rw-r--r--README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4a835d1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,11 @@
+# nfcollect
+
+Collect NFLOG log entries and commit them to stable storage in binary (compressed) format
+
+### References
+
+* libnetfilter_log: https://www.icir.org/gregor/tools/files/doc.libnetfilter_log/html/libnetfilter__log.html
+* zstd: https://facebook.github.io/zstd/zstd_manual.html
+* mmap: https://stackoverflow.com/questions/35891525/mmap-for-writing-sequential-log-file-for-speed/35891885
+* pthread: http://www.cs.cmu.edu/afs/cs/academic/class/15492-f07/www/pthreads.html
+* apr_queue: http://apr.apache.org/docs/apr-util/1.3/apr__queue_8h.html