Update docs (#153)

* Update README.md * Update quick-start.rst * Update quick-start.rst * Update quick-start.rst * Update quick-start.rst * Update cloner.rst * Update parameters.rst * Update quick-start.rst * Update parameters.rst
mushorg · Jul 30, 2018 · 9015a00 · 9015a00
1 parent 11dca48
commit 9015a00
Show file tree

Hide file tree

Showing 4 changed files with 51 additions and 28 deletions.
diff --git a/README.md b/README.md
@@ -29,8 +29,9 @@ Getting started
 #### Steps to setup
 1. Get SNARE: `git clone https://github.com/mushorg/snare.git` and `cd snare`
 2. Install requirements: `pip3 install -r requirements.txt`
-3. Clone a page: `sudo python3 clone.py --target http://example.com`
-4. Run SNARE: `sudo python3 snare.py --port 8080 --page-dir example.com`
+3. Setup snare: `sudo python3 setup.py install`
+3. Clone a page: `sudo clone --target http://example.com`
+4. Run SNARE: `sudo snare --port 8080 --page-dir example.com`
 5. Test: Visit http://localhost:8080/index.html
 6. (Optionally) Have your own [tanner](https://github.com/mushorg/tanner) service running.
 
@@ -42,18 +43,22 @@ You obviously want to bind to 0.0.0.0 and port 80 when running in <i>production<
 
 
 ```shell
-    # sudo python3 snare.py --port 8080 --page-dir example.com
+    # sudo snare --port 8080 --page-dir example.com
 
-        _____ _   _____    ____  ______
-       / ___// | / /   |  / __ \/ ____/
-       \__ \/  |/ / /| | / /_/ / __/
-      ___/ / /|  / ___ |/ _, _/ /___
-     /____/_/ |_/_/  |_/_/ |_/_____/
-
-
-     privileges dropped, running as "nobody:nogroup"
-     serving on ('127.0.0.1', 8080) with uuid 9cd6cfbc-9a80-401f-a171-ef24c20e45c4
-     you are running the latest version
+       _____ _   _____    ____  ______
+      / ___// | / /   |  / __ \/ ____/
+      \__ \/  |/ / /| | / /_/ / __/
+     ___/ / /|  / ___ |/ _, _/ /___
+    /____/_/ |_/_/  |_/_/ |_/_____/
+
+
+    privileges dropped, running as "nobody:nogroup"
+    serving with uuid 9c10172f-7ce2-4fb4-b1c6-abc70141db56
+    Debug logs will be stored in /opt/snare/snare.log
+    Error logs will be stored in /opt/snare/snare.err
+    ======== Running on http://localhost:8080 ========
+    (Press CTRL+C to quit)
+    you are running the latest version
 
 ```
 
diff --git a/docs/source/cloner.rst b/docs/source/cloner.rst
@@ -5,7 +5,7 @@ Cloner clones the website that we require to be served by snare.
 
 Cloner command line parameters
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-clone.py [**--target** *website_url* ] [**--max-depth** *clone_depth*]
+clone [**--target** *website_url* ] [**--max-depth** *clone_depth*]
 
 Description
 ~~~~~~~~~~~

diff --git a/docs/source/parameters.rst b/docs/source/parameters.rst
@@ -1,6 +1,7 @@
 Snare command line parameters
 =============================
-snare.py [**--page-dir** *folder* ] [**--list-pages**]
+snare [**--page-dir** *folder* ] [**--list-pages**]
+[**--host-ip**]
 [**--index-page** *filename*] [**--port** *port*]
 [**--interface** *ip_addr*] [**--debug** ]
 [**--tanner** *tanner_ip**] [**--skip-check-version**]
@@ -13,6 +14,7 @@ Description
 
 * **page--dir** -- name of the folder to be served
 * **list--pages** -- list available pages
+* **host--ip** -- host ip to bind to, default: localhost
 * **index--page** -- file name of the index page, default: index.html
 * **port** -- port to listen on, default: 8080
 * **interface** -- interface to bind to

diff --git a/docs/source/quick-start.rst b/docs/source/quick-start.rst
@@ -1,24 +1,40 @@
 SNARE
 =====
+
 Super Next generation Advanced Reactive honEypot
 
-Basic concept
-"""""""""""""
-* Surface first: Focus on the attack surface generation.
-* Sensors and masters. Lightweight collector (SNARE) and central decision maker/emulator (TANNER).
+Basic Concepts
+""""""""""""""
+
+* Surface first. Focus on the attack surface generation.
+* Sensors and masters. Lightweight collectors (SNARE) and central decision maker (tanner).
+
 
 Getting started
 """""""""""""""
 
-You need Python3. We tested primarily with >=3.4
-This was tested with a recent Ubuntu based Linux.
+ You need Python3. We tested primarily with >=3.4
+
+ This was tested with a recent Ubuntu based Linux.
+
+**Steps to setup:**
+
+1. Get SNARE: ``git clone https://github.com/mushorg/snare.git`` and ``cd snare``
+
+2. Install requirements: ``pip3 install -r requirements.txt``
+
+3. Setup snare: ``sudo python3 setup.py install``
+
+4. Clone a page: ``sudo clone --target http://example.com``
+
+5. Run SNARE: ``sudo snare --port 8080 --page-dir example.com`` (See :doc:`parameters` description for more info)
+
+6. Test: Visit http://localhost:8080/index.html
+
+7. (Optionally) Have your own tanner_ service running.
 
-* Get SNARE: ``git clone https://github.com/mushorg/snare.git``
-* Install requirements: ``pip3 install -r requirements.txt``
-* Clone a page: ``sudo python3 clone.py --target http://example.com``
-* Run SNARE: ``sudo python3 snare.py --port 8080 --page-dir example.com`` (See :doc:`parameters` description for more info)
-* Test: Visit ``http://localhost:8080/index.html``
-* (Optionally) Have your own tanner service running.
+.. _tanner: https://github.com/mushorg/tanner
 
+[Note : Cloner clones the whole website, to restrict to a desired depth of cloning add ``--max-depth`` parameter]
 
-You obviously want to bind to 0.0.0.0 and port 80 when running in production.
+You obviously want to bind to 0.0.0.0 and port 80 when running in *production*.