pdf-export-server's Introduction

PDF export server

This repository contains sources for a server which builds PDF and PNG files out of HTML fragments. Server is designed to work with Bryntum PDF Export feature. See compatibility table between Export server and other Bryntum products in this table.

Live demos available here:

Features

Uses headless chromium browser.
Runnable as NodeJS instance.
Docker container available at Docker Hub
Written in JavaScript and fully adaptable.
Can be used as standalone service or as an intermediary between your (C#, Java, PHP) frontend and backend.

Getting started

Using NodeJS

Check out this repository

~$ git clone [email protected]:bryntum/pdf-export-server.git
~$ cd pdf-export-server

Install packages

pdf-export-server$ npm i

Start the server

pdf-export-server$ npm run start
Access-Control-Allow-Origin: *
Http server started on port 8080

Multiple configuration options are available as you can see in the configuration guide.

Using image from Docker Hub

For your convenience we have pre-built container available on Docker Hub.

Pull it

$ docker pull bryntum/pdf-export-server

Create docker-compose.yml and configure image/port forwarding

version: "3.9"
services:
  web:
    image: "bryntum/pdf-export-server:1.0.1"
    ports:
      - "8080:8080"

Start container

$ docker compose -f docker-compose.yml up

FAQ

Exported PDF/PNG doesn't look correct

Most likely server couldn't get access to the resources. See architecture guide for detailed information, resources section for short summary and troubleshooting guide for debugging tips.

PDF/PNG file is not generated

Most likely there is a problem on the server, see troubleshooting guide for help.

Cannot export using HTTPS

You can see errors like NET::ERR_CERT_AUTHORITY_INVALID or CORS exception (in Firefox). See Make browser to accept self-signed certificate section for more info.

Recommend Projects