diff --git a/README.md b/README.md index 08fa684..24d8417 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,27 @@ +# Stages +**Normalize**: Touch-up/rename fields, etc. +**Enrich**: Enrich and part of the message. +**Check**: Checks parts of message (now enriched) against known bad stuff. +**Archive**: Push document into elasticsearch. Can also log to file. + ## Installation on FreeBSD -# Configure Kafka topics (run on one kafka node) -doc/kafka_topics.sh +### Configure Kafka topics (run on one kafka node) +`doc/kafka_topics.sh` -# Initialize elasticsearch -curl -X PUT 'http://:9200/threatline' -d@doc/es_mapping.json +### Initialize elasticsearch +`curl -X PUT 'http://:9200/threatline' -d@doc/es_mapping.json` -# Install service file -cp doc/threatline /usr/local/etc/rc.d/threatline +### Install service file +`cp doc/threatline /usr/local/etc/rc.d/threatline` -# Enable threatline -sysrc threatline_enable=YES -sysrc threatline_agents="normalize enrich check archive" +### Enable threatline +`sysrc threatline_enable=YES` +`sysrc threatline_agents="normalize enrich check archive"` -# Start threatline -service threatline start +### Start threatline +`service threatline start` -# Monitor logs -tail -f /tmp/tl_worker.log - - -# Stages -Normalize: Touch-up/rename fields, etc. -Enrich: Enrich and part of the message. -Check: Checks parts of message (now enriched) against known bad stuff. -Archive: Push document into elasticsearch. Can also log to file. +### Monitor logs +`tail -f /tmp/tl_worker.log`