+

Add informations about JSON file content

Benjamin Renard [2014-12-31 15:14:24]
Add informations about JSON file content
Filename
README
diff --git a/README b/README
index fb677d1..bcf58c1 100644
--- a/README
+++ b/README
@@ -33,3 +33,21 @@ Parameters :
  - umask :
    Umask use on JSON file creation (Integer)
    Default : 0077
+
+JSON file content
+-----------------
+
+On start, the file will be created with "{}" and the file will be removed on stop.
+
+When some IP is ban, the file content will be updated like in the example :
+
+The IP "1.2.3.4" is banned after 3 failures at 31/12/2014 16:07:40 :
+
+{
+  "1.2.3.4": {
+    "failures": "3",         // Number of failures
+    "time": "1420038460.98"  // UNIX timestamp ot the ban time
+  }
+}
+
+On unban, the block corresponding to the IP address will be removed.
ViewGit