zipreport-cli is deprecated; please use zipreport-server >= v2.0.0.
Electron cli to convert html to pdf, adapted from Athena PDF and ideas from Electron PDF, under MIT license.
Its main purpose is to convert HTML reports to PDF. Keep in mind, using it to render external or untrusted pages can cause serious security issues.
- Upgraded electron;
- Upgraded security flags (webSecurity=true, sandbox=true, enableRemoteModule=false);
- Additional options removed;
- Possibility of triggering rendering via JS event;
- Support for absolute paths on the output file;
- Upgraded electron;
- Upgraded security flags (webSecurity=true, sandbox=true, enableRemoteModule=false);
- CLI usage only for a single uri;
- Additional options removed;
- Simplified codebase;
- JS event triggering is based on preload event handler instead of injected handler;
- JS event name is not customizable;
./zpt-cli <uri> <destination-file> [options] Notice: electron requires a framebuffer. On installations without a graphical environment, initialize one with xvfb:
$ export DISPLAY=':99.0'
$ Xvfb :99 -screen 0 1024x768x24 > /dev/null 2>&1 &| Option | Default Value | Description |
|---|---|---|
| --timeout | 30 | Time to wait before exiting application. After the specified time, application will exit unless --debug specified. |
| --delay | 200 | Delay (settling time) in millisseconds to generate PDF after page is ready. Ignored if --js-event specified. |
| --pagesize | A4 | Page size (A3/A4/A5/Legal/Letter/Tabloid). |
| --margins | standard | Margin configuration to use (standard/none/minimal). |
| --zoom | 1 | Zoom factor to use in rendering (1 represents 100%). |
| --proxy | Optional proxy server to use. | |
| --no-insecure | Disable execution of insecure content. | |
| --no-background | Disable rendering of CSS backgrounds. | |
| --no-portrait | Render in landscape. | |
| --ignore-certificate-errors | Ignore SSL certificate errors. | |
| --ignore-gpu-blacklist | Enables GPU in Docker environment. | |
| --image | Export to PNG instead of PDF | |
| --width | 1024 | Window width in pixels for PNG export; Cannot be larger than framebuffer width. |
| --height | 768 | Window height in pixels for PNG export; Cannot be larger than framebuffer height. |
| --js-event | Wait for a javascript event named 'zpt-view-ready'. | |
| --js-timeout | 8 | Seconds to wait for the javascript event. After the time has passed, the rendered is triggered regardless. |
| --security-opt | Optional security options to pass to Chromium | |
| --no-sandbox | false | Disable Chromium sandbox (see below) |
| --no-gpu | false | Disable GPU acceleration |
To avoid generating the PDF before relevant in-page javascript has finished executing, it is possible for the page to trigger the rendering only after an event is fired. To use this behaviour, do not forget to use --js-event, and optionally --js-timeout <milisseconds> to specify how long to wait for the event (default is 8 seconds).
Sample event.html page:
<html>
<head>
</head>
<body>
<script>
(function() {
// trigger export event
document.dispatchEvent(new Event('zpt-view-ready'));
})()
</script>
</body>
</html>Running with event triggering:
$ ./build/zpt-cli-linux-x64/zpt-cli test.html test.pdf --js-eventOutput:
Received JS event
Converted 'file:///<path to your current directory>/test.html' to PDF: 'test.pdf'
Elapsed Time: 450.872ms
To build the zpt-cli binary in build/zpt-cli-<arch>/:
npm install
npm run buildDisabling the sandbox mode (--no-sandbox) may pose a serious security risk! Make sure you either trust any exernal web content passed to zipreport-cli, or run zipreport-cli inside a locked down virtual machine. Make yourself confortable with the (sandbox details)[https://chromium.googlesource.com/chromium/src/+/master/docs/design/sandbox_faq.md] so you can fully understand the possible attack vectors you will be exposed to when disabling the sandbox.
zipreport-cli code is provided under MIT License. Due to the derivative nature of the code, original authorship from AthenaPDF is also preserved. Please check required libraries for their own licensing terms.