Updated docs and Dockerfile for new structure

kevthehermit · Jan 19, 2020 · 3cca69e · 3cca69e
1 parent 45418ea
commit 3cca69e
Show file tree

Hide file tree

Showing 4 changed files with 46 additions and 4 deletions.
diff --git a/Dockerfile b/Dockerfile
@@ -21,5 +21,5 @@ WORKDIR /usr/src/pastehunter
 COPY . ./
 RUN pip3 install -r requirements.txt
 
-CMD ["/usr/src/wait-for-it/wait-for-it.sh","-t", "0","172.16.10.10:9200","--", "python3", "pastehunter.py"]
+CMD ["/usr/src/wait-for-it/wait-for-it.sh","-t", "0","172.16.10.10:9200","--", "python3", "pastehunter-cli"]
 
diff --git a/docs/conf.py b/docs/conf.py
@@ -24,9 +24,9 @@
 author = 'Kevin Breen'
 
 # The short X.Y version
-version = '1.0'
+version = '1.2.1'
 # The full version, including alpha/beta/rc tags
-release = '1.0'
+release = '1.2.1'
 
 
 # -- General configuration ---------------------------------------------------

diff --git a/docs/installation.rst b/docs/installation.rst
@@ -1,9 +1,21 @@
 Installation
 ============
 
-There are a few ways to install 
+There are a few ways to install PasteHunter. Pip is the recommended route for stable releases.
 
 
+Pip Installation
+------------------
+Pip installation is supported for versions after 1.2.1. This can easily be done using:
+
+``pip install pastehunter``
+
+You will then need to configure pastehunter. To do this, use:.::
+
+    mkdir -p ~/.config
+    wget https://raw.githubusercontent.com/kevthehermit/PasteHunter/master/settings.json.sample -O ~/.config/pastehunter.json
+
+Then modify ~/.config/pastehunter.json to match your desired settings and run the project using ``pasthunter-cli``
 
 Local Installation
 ------------------

diff --git a/docs/migrating.rst b/docs/migrating.rst
@@ -0,0 +1,30 @@
+Migrating from a pre-1.2.1 config
+==================================
+1.2.1 introduces some breaking configuration changes due to various project structure changes. Most notably,
+all module names will need to be prefixed with "pastehunter.". So for example, this part of the configuration.::
+
+    "gists": {
+      "enabled": true,
+      "module": "inputs.gists",
+      "api_token": "",
+
+Will need to change to be .::
+
+    "gists": {
+      "enabled": true,
+      "module": "pastehunter.inputs.gists",
+      "api_token": "",
+
+
+This applies to inputs, outputs, sandboxes, and post modules. There is one more change required to migrate your configuration.
+You will need to change your yara configuration to look something like this:.::
+
+  "yara": {
+    "default_rules": true,
+    "custom_rules": "none",
+    "exclude_rules": [],
+    "blacklist": true,
+    "test_rules": false
+  }
+
+If you have created any custom rules, change "none" to reflect the path to your custom rules. Finally, move your ``settings.json`` file to ``~/.config/pastehunter.json``.