This project is not actively developed anymore as there are better solutions out there that are headless. I would suggest using https://github.com/alvarcarto/url-to-pdf-api
Simple PDF/PNG/JPEG render service, accepts webpage URL and returns the resource.
Alternatively an HTML payload can be POST-ed.
Based on official Debian Jessie image, uses latest electron.
docker run -t -e RENDERER_ACCESS_KEY=secret -p 3000:3000 msokk/electron-render-service
wget -O out.pdf 'http://<node_address>:3000/pdf?accessKey=secret&url=https%3A%2F%2Fgithub.com%2Fmsokk%2Felectron-render-service'
NB: Set bigger shared memory size
--shm-size=Xm
(default:64m
) if dealing with very heavy pages.Docker Swarm needs extra configuration to work -
--shm-size
is not implemented use--mount type=tmpfs,dst=/dev/shm,tmpfs-size=134217728
instead and blank hostname-e HOSTNAME=
.
# Enable contrib packages
sed -i 's/main/main contrib/g' /etc/apt/sources.list
# Install packages needed for runtime
apt-get update && apt-get install -y xvfb libgtk2.0-0 ttf-mscorefonts-installer libnotify4 libgconf2-4 libxss1 libnss3 dbus-x11
# Install from NPM
npm install -g electron-render-service
# Run in virtual framebuffer
RENDERER_ACCESS_KEY=secret xvfb-run --server-args="-screen 0 1024x768x24" electron-render-service
wget -O out.pdf 'http://localhost:3000/pdf?accessKey=secret&url=https%3A%2F%2Fgithub.com%2Fmsokk%2Felectron-render-service'
GET /pdf
- Render PDFQuery params (About PDF params):
accessKey
- Authentication key.url
- Full URL to fetch.pageSize
- Specify page size of the generated PDF. Can be A3
, A4
, A5
, Legal
, Letter
, Tabloid
or <width>x<height>
in microns (e.g. 210000x297000
for A4)(default: A4
)marginsType
- Specify the type of margins to use (default: 0
)printBackground
- Whether to print CSS backgrounds. (default: true
)landscape
- true
for landscape, false
for portrait. (default: false
)removePrintMedia
- Removes any <link media="print">
stylesheets on page before render. (default: false
)delay
- Specify how many seconds to wait before generating the PDF (default: 0
)waitForText
- Specify a specific string of text to find before generating the PDF (default: false
)POST /pdf
Identical as above, omit url
and provide HTML in request body.
GET /png|jpeg
- Render PNG/JPEGQuery params:
accessKey
- Authentication key.url
- Full URL to fetch.quality
- JPEG quality. (default: 80
)delay
- Specify how many seconds to wait before generating the image (default: 0
)waitForText
- Specify a specific string of text to find before generating the image (default: false
)browserWidth
- Browser window width (default: rect.width || env.WINDOW_WIDTH
, max: 3000
)browserHeight
- Browser window height (default: rect.height || env.WINDOW_HEIGHT
, max: 3000
)clippingRect[x]
clippingRect[y]
clippingRect[width]
clippingRect[height]
POST /png|jpeg
Identical as above, omit url
and provide HTML in request body.
GET /stats
- Display render pool statsQuery params:
accessKey
- Generic authentication key is required.RENDERER_ACCESS_KEY
or RENDERER_ACCESS_KEY_<suffix>
- Secret key for limiting access. Suffixed keys are used as labels in access log for debugging usage.CONCURRENCY
- Number of browser windows to run in parallel (default: 1
)TIMEOUT
- Number of seconds before request timeouts (default: 30
)WINDOW_WIDTH
- Default window width (default: 1024
)WINDOW_HEIGHT
- Default window height (default: 768
)HOSTNAME
- Hostname to accept Express connections on (default: 0.0.0.0
)PORT
- (default: 3000
)CHROMIUM_CLI_SWITCHES
- Comma separated list of Chromium command line switches to append. For example pass ignore-certificate-errors
as value to render self-signed pages (at your own risk).Not all content is loaded once the DOM is loaded, some data can take time because calls are being made via websockets and other methods. You can delay the rendering by either providing a delay
value in the query string or you can provide waitForText
in the query string.
If you specify waitForText
the service will continually scan the loaded URL until the overall timeout is reached. If the text passed to the variable waitForText
is found before the timeout, the PDF/image will generate and return.