From 4eafca29366194be5110064a525d4164dff4caa8 Mon Sep 17 00:00:00 2001 From: Mokaddem Date: Thu, 13 Oct 2016 17:13:08 +0200 Subject: [PATCH] Added pystemon instruction section --- README.md | 26 ++++++++++++++++++++++++++ bin/feeder/pystemon-feeder.py | 0 2 files changed, 26 insertions(+) mode change 100644 => 100755 bin/feeder/pystemon-feeder.py diff --git a/README.md b/README.md index f5cdb7b4..7483a57f 100644 --- a/README.md +++ b/README.md @@ -101,6 +101,28 @@ Eventually you can browse the status of the AIL framework website at the followi ``http://localhost:7000/`` +How to +====== + +How to feed the AIL framework +----------------------------- + +For now, there are two different way to feed AIL with data: +1. Be a collaborator of CIRCL and ask to access our feed. Then, it will be sent to the static IP your are using for AIL. +2. You can setup [pystemon](https://github.com/CIRCL/pystemon) and use the custom feeder provided by AIL + +#Feeding AIL with pystemon +AIL is a analysis tool, not a collector! +However, if you want to collect some paste and feed them to AIL, here is the procedure but moderate your queries quantity!! + +Here are the steps to setup your pystemon and feed data to AIL: +1. Clone the [pystemon's git repository](https://github.com/CIRCL/pystemon) +2. Install its python dependencies inside your virtual environment +3. Launch pystemon ``` ./pystemon ``` +4. Edit the file bin/feeder/pystemon-feeder.py and modify the pystemonpath path accordingly +5. Launch pystemon-feeder ``` ./pystemon-feeder.py ``` + + How to create a new module -------------------------- @@ -117,6 +139,10 @@ Feel free to fork the code, play with it, make some patches or add additional an To contribute your module, feel free to pull your contribution. +Overview and License +==================== + + Redis and LevelDB overview -------------------------- diff --git a/bin/feeder/pystemon-feeder.py b/bin/feeder/pystemon-feeder.py old mode 100644 new mode 100755