Troubleshooting

Troubleshooting

Before reporting an issue, attempt to troubleshoot the issue by enabling debugging output. This is done setting the VERBOSTY global option to 2. Run options set VERBOSITY 2 from the global context to enable debugging.

The framework also exposes the built-in Python debugger for troubleshooting purposes. Issue the pdb command from anywhere in the framework to drop into a debugging prompt complete with the current execution context.

Issue Reporting

The framework and modules are housed in different repositories and have independent issue trackers. Do not submit module issues to the framework issue tracker and vice versa. Framework issues are tracked here, and module issues are tracked here.

Before creating a new issue:

• Do not use the issue tracker to ask questions about general usage of the framework or modules. That's what the Recon-ng Slack workspace is for. Go here for information on joining the Recon-ng Slack workspace.
• Ensure that the issue exists in the most recent version of the framework and module, if applicable. Use the marketplace refresh command to refresh the marketplace index, and the marketplace search command to view the current version of all modules in the marketplace along with the date they were last updated. Outdated modules should be annotated as such. If the framework itself is outdated, it will notify the user at runtime unless version checking has been explicitly disabled.
• Review the current open issues to make sure it is not a duplicate. Comment on existing issues with the same information as you would provide creating a new issue.

When submitting an issue:

• Do not submit multiple problems in a single issue. One problem per issue please.
• Make sure issue submissions include enough information to repeat the problematic behavior. Issues that cannot be replicated delay resolution and often get closed due to inactivity.