Creating PDF reports

This guide contains:

Installing the PDF exporter

Reporting 08

For Dradis Professional Edition:

  1. Edit file /opt/dradispro/dradispro/shared/addons/Gemfile.plugins (create it if it doesn't already exist)

  2. Append the following to the end of the file:

    gem 'dradis-pdf_export', github: 'dradis/dradis-pdf_export'
  3. Run the following as dradispro:

    $ cd /opt/dradispro/dradispro/current/
    $ RAILS_ENV=production bundle install
  4. Restart the app:

    $ god restart dradispro-unicorn

Now, navigate to Export results in the header of one of your projects to see the new Generate PDF Reports option!

For Dradis Community Edition:

  1. Edit file Gemfile.plugins and add/uncomment this line in the Export section:

    gem 'dradis-pdf_export', github: 'dradis/dradis-pdf_export'
  2. Install the new PDF exporter by running this command from your local dradis-ce folder:

    $ bundle install

Restart the server ($ bundle exec rails server), then navigate to Export results in the header to see the new Generate PDF Reports option!


Customizing your PDF report

We're using the powerful Prawn library to do the heavy lifting.

Essentially, you're just editing an .rb file to customize it as needed. For more details on specific syntax options, check out the Prawn library linked above!

For Dradis Professional Edition:

  1. Create an .rb file! For a quick starting point, copy this sample PDF report template: exporter.rb and customize as needed.

  2. When you're ready to export, navigate to Templates > Reports and upload the report template under the Pdf Export tab.

  3. Open your Dradis Project and navigate to Export Results in the header, then select the template from the Generate PDF Reports tab and click Export.

For Dradis Community Edition:

  1. Create an .rb file! For a quick starting point, copy this sample PDF report template: exporter.rb and customize as needed.

  2. Place this file in the dradis-ce/templates/reports/pdf_export/ folder (create the folder if it doesn't already exist).

  3. Navigate to Export Results in the header, then select the template from the Generate PDF Reports tab and click Export.

InfoSec project delivery 5-day crash course

Learn innovative, actionable techniques and approaches for reducing the overhead that drags down InfoSec project delivery. You’ll learn how to optimize:

  • Scoping
  • Scheduling
  • Project Planning
  • Delivery
  • Intra-team Collaboration
  • Reporting and much more...

Your email is kept private. We don't do the spam thing.