Tim Tomes avatar Tim Tomes committed edcab13

modified the documentation to reflect framework changes.

Comments (0)

Files changed (1)

 
 * Pay attention to the global options. Global options are the options that are available at the root context of the framework. In many cases, global options are inherited by modules. While module options can still be set individually, it is often easier to leverage global options so that the same information doesn't have to be entered repeatedly. Global options also have a global effect on how the framework operates. Global options such as "verbosity" and "proxy" drastically change how the modules present feedback and make web requests. Explore and understand the global options before diving into the modules.
 
+* **NEW** - Workspaces help users to conduct multiple simultaneous engagements without having to repeatedly configure global options or databases. All of the information for each workspace is stored in its own directory underneath the "workspaces" folder. Each workspace consists of it's own instance of the Recon-ng database, a configuration file for the storage of global options, reports from reporting modules, and any loot that is gathered from other modules. To create a new workspace, simply set the global "workspace" option. If there are no existing workspaces with the same name, a new workspace is created. Loading an existing workspace is just as easy. Set the global "workspace" option to the name of an existing workspace and the workspace will be loaded. To view a list of available workspaces, see the "show" command.
+
 * The "reload" command gives users the ability to reload all modules without restarting the framework. This is mainly a development feature. During development, users will need to repeatedly reload the framework to test code changes. The "reload" command provides the capability to reload modules while maintaining command history and global options settings.
 
 * As the framework grows, the "search" command will become an important feature. The "search" command provides the capability to search the names of all loaded modules and present the matches to the user.
 ** //lname// is the last name of the contact.
 ** //title// is the job title of the contact.
 ** //email// (optional) is the email address of the contact.
+** //region// (optional) is the city, state or region of where the contact is located.
+** //country// (optional) is the country of where the contact is located.
 {{{
 #!python
-self.add_contact(fname, lname, title[, email=None])
+self.add_contact(fname, lname, title[, email=None][, region=None][, country=None])
 }}}
 
 * Add a credential to the database and return the affected row count.
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.