From 179fe0032cf4e33de8f941ff43e6ff4811b12bcb Mon Sep 17 00:00:00 2001
From: mokaddem <mokaddem.sami@gmail.com>
Date: Fri, 27 Oct 2017 23:03:23 +0200
Subject: [PATCH] Create README.md

---
 README.md | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..22eb688
--- /dev/null
+++ b/README.md
@@ -0,0 +1,29 @@
+# MISP-Dashboard
+A Dashboard showing live data and statistics from the MISP ZMQ
+
+## Installation
+- Launch ```./install_dependencies.sh``` from the MISP-Dashboard directory
+- Update the configuration file ```config.cfg``` so that it matches your system
+  - Fields that you may change:
+    - RedisGlobal -> host
+    - RedisGlobal -> port
+    - RedisLog -> zmq_url
+    - RedisMap -> pathMaxMindDB
+
+## Starting the System
+- Activate your virtualenv ```. ./DASHENV/bin/activate```
+- Listen to the MISP feed by starting the zmq_subscriber ```./zmq_subscriber.py```
+- Start the Flask server ```./server.py```
+
+## zmq_subscriber options
+```usage: zmq_subscriber.py [-h] [-n ZMQNAME] [-u ZMQURL]
+
+A zmq subscriber. It subscribe to a ZMQ then redispatch it to the MISP-dashboard
+
+optional arguments:
+  -h, --help            show this help message and exit
+  -n ZMQNAME, --name ZMQNAME
+                        The ZMQ feed name
+  -u ZMQURL, --url ZMQURL
+                        The URL to connect to
+```