documentation holders

InQuest · Aug 3, 2018 · 3de5c4f · 3de5c4f
1 parent 137dbc7
commit 3de5c4f
Show file tree

Hide file tree

Showing 10 changed files with 51 additions and 5 deletions.
diff --git a/docs/apikeys.rst b/docs/apikeys.rst
@@ -1,4 +1,4 @@
-.. _apikeys:
+.. _api_keys:
 
 API Keys
 ==========

diff --git a/docs/databases.rst b/docs/databases.rst
@@ -0,0 +1,8 @@
+.. _databases:
+
+Databases
+==========
+Omnibus requires that MongoDB and Redis be running and reachable by the host that runs the omnibus-cli. 
+
+The following file holds host and port configuration details for the databases. If you have them both running on your localhost and using the default ports, this config file should not need to be changed. Otherwise, edit the [mongo] and [redis] sections to your liking, ensuring to keep the file format in tact::
+    etc/omnibus.conf
diff --git a/docs/installation.rst b/docs/installation.rst
@@ -1,7 +1,13 @@
-.. _apikeys:
+.. _installation:
 
-API Keys
+Installation
 ==========
-All of your API keys for third party service modules must be stored within etc/apikeys.json. For each named service simply paste your API key as the quoted value within the JSON file.
+Omnibus is written for Python 2.7 and has been tested on OS X 10.13.6, Ubuntu 16.04, and Ubuntu 18.04.
+
+To get started, first clone the GitHub repository::
+    git clone https://github.com/InQuest/omnibus
+
+Move into the new directory and install the required Python libraries::
+    cd omnibus
+    pip install -r requirements.txt
 
-All services used are free to receive an API key, but if you don't enter one for a given service and attempt to run its module it will simply return no results.
diff --git a/docs/interactivecli.rst b/docs/interactivecli.rst
@@ -0,0 +1,4 @@
+.. _interactive_cli:
+
+Interactive CLI
+===============
diff --git a/docs/machine.rst b/docs/machine.rst
@@ -0,0 +1,8 @@
+.. _machines:
+
+Machines
+==========
+Machines are used to run every available module for an artifact type against a user specified artifact. This is designed to make it simple to collect all available data on an artifact with one command.
+
+Usage
+-----
diff --git a/docs/modules.rst b/docs/modules.rst
@@ -0,0 +1,4 @@
+.. _modules:
+
+Modules
+=======
diff --git a/docs/quickref.rst b/docs/quickref.rst
@@ -0,0 +1,4 @@
+.. _quick_reference:
+
+Quick Reference
+===============
diff --git a/docs/redirection.rst b/docs/redirection.rst
@@ -0,0 +1,4 @@
+.. _redirection:
+
+Redirection
+============
diff --git a/docs/reporting.rst b/docs/reporting.rst
@@ -0,0 +1,4 @@
+.. _reporting:
+
+Reporting
+==========
diff --git a/docs/sessions.rst b/docs/sessions.rst
@@ -0,0 +1,4 @@
+.. _sessions:
+
+Sessions
+==========