This add-on is operated by DocRaptor
Simple & Robust HTML-to-PDF Conversion
Last updated 02 October 2020
Table of Contents
DocRaptor can be attached to a Heroku application via the add-on page or via the CLI:
$ heroku addons:create docraptor Creating docraptor on ⬢ sharp-mountain-4005... free Created docraptor-pointy-98065 as DOCRAPTOR_API_KEY, DOCRAPTOR_URL Use heroku addons:docs docraptor to view documentation
A list of all plans available can be found here or by running
heroku addons:plans docraptor
You can get your DocRaptor API key through the CLI:
$ heroku config:get DOCRAPTOR_API_KEY YOUR_API_KEY_HERE
Document styling and API options
DocRaptor’s documentation site contains detailed style and formatting guides as well as a full API reference. If you’re familiar with traditional open-source HTML to PDF libraries, you may be surprised by DocRaptor’s support for advanced document features, such as page break control, varying sizes and layouts, headers and footers, and accessible PDFs. h
Both successful and failed document requests are available within your DocRaptor dashboard. The dashboard by visiting the Heroku Dashboard and selecting the application in question, then select DocRaptor from the Add-ons menu. Alternatively, you can open the dashboard via the CLI:
$ heroku addons:open docraptor Opening https://addons-sso.heroku.com/apps/your_app_id/addons/your_addon_id...
Most issues can be easily debugged by looking at the document error logs or by reviewing style and formatting guides. For additional assistance, contact DocRaptor support at firstname.lastname@example.org. We’d be happy to assist you in getting the perfect document.
Migrating between plans
heroku addons:upgrade CLI command to migrate to a new plan by upgrading (or downgrading):
$ heroku addons:upgrade docraptor:premium Changing docraptor-pointy-98065 on sharp-mountain-4005 from docraptor:starter to docraptor:basic... done, $19/month
$ heroku addons:downgrade docraptor:starter Changing docraptor-pointy-98065 on sharp-mountain-4005 from docraptor:basic to docraptor:starter... done, free
You can cancel your DocRaptor plan by destroying the Heroku provisioning:
$ heroku addons:destroy docraptor ▸ WARNING: Destructive Action ▸ This command will affect the app sharp-mountain-4005 ▸ To proceed, type sharp-mountain-4005 or re-run this command with --confirm sharp-mountain-4005 > sharp-mountain-4005 Destroying docraptor-pointy-98065 on ⬢ sharp-mountain-4005... done
Billing and Heroku account issues should be submitted via one of the Heroku Support channels. All technical questions and product feedback is welcome by contacting us at email@example.com. We are happy to assist with debugging your documents.