Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ccjmne/puppeteer-html2pdf
Print your HTML to PDF via Puppeteer in a Docker container.
https://github.com/ccjmne/puppeteer-html2pdf
docker html-to-pdf nodejs pdf puppeteer
Last synced: 1 day ago
JSON representation
Print your HTML to PDF via Puppeteer in a Docker container.
- Host: GitHub
- URL: https://github.com/ccjmne/puppeteer-html2pdf
- Owner: ccjmne
- License: mit
- Created: 2019-04-11T13:29:58.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-08-30T23:35:45.000Z (6 months ago)
- Last Synced: 2024-12-31T18:45:18.646Z (about 2 months ago)
- Topics: docker, html-to-pdf, nodejs, pdf, puppeteer
- Language: JavaScript
- Homepage:
- Size: 332 KB
- Stars: 13
- Watchers: 4
- Forks: 7
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ccjmne/puppeteer-html2pdf
Print your HTML to PDF via Puppeteer in a Docker container.
[](https://github.com/ccjmne/puppeteer-html2pdf/actions/workflows/publish-to-ghcr.yml)
## Inside the box
This is a simple [Express](https://expressjs.com/) server listening for `POST` requests passing some custom HTML to print as PDF for generating fancy reports.
Technologies used:
- [Docker](https://www.docker.com/)
- [Puppeteer](https://github.com/GoogleChrome/puppeteer)
- [Express](https://expressjs.com/)
- [NodeJS](https://nodejs.org/en/)
It offers images for both ARM and AMD architectures.
## Run it
As a webserver, on the port of your choosing.
- Testing:
```shell
docker run -it --rm -p=:3000 ghcr.io/ccjmne/puppeteer-html2pdf:
```
Kill with: `Ctrl^C`
- Production:
```shell
docker run --name html2pdf --detach -p=:3000 \
--shm-size 1G --sysctl net.ipv6.conf.all.disable_ipv6=1 \
ghcr.io/ccjmne/puppeteer-html2pdf:
```
Stop with: `docker stop html2pdf`
## Docker Environment Variables
| Name | Description | Default Value |
| ---------- | ------------------------------------------------------------------------------------------------------------------------- | ------------- |
| BODY_LIMIT | Maximum request body size. Passed on to [body-parser](https://github.com/expressjs/body-parser#limit) and `express.json`. | `1mb` |
## Use it
The webserver listens on the port (specified in the [Run it](#run-it) section) and exposes two endpoints:
Single-page document, default settings (format: `A4`, orientation: `portrait`):
| | Single-page document | Multi-page document |
| ---------------------- | ----------------------- | ----------------------------------------- |
| Request Path | `/` | `/multiple` |
| Request Method | `POST` | `POST` |
| `Content-Type` header | `text/html` | `application/json` |
| Request Body | HTML content | JSON array of strings containing HTML |
| Request Body (example) | `
Hello World!
` | `["Page 1", "Page 2
" ]` |
Both methods handle the following query parameters:
- `filename`: the name of the resulting PDF file (will automatically append the `.pdf` extension if absent)
- all the options supported by [Puppeteer's page#pdf(\[options\])](https://github.com/puppeteer/puppeteer/blob/main/docs/api.md#pagepdfoptions), except:
- `path`
- `headerTemplate`
- `margin`
## Changes from version 1.x.x
The `/multiple` endpoint used to expect the request body to be a JSON object with a single `pages` property that would map to a JSON array of strings containing your HTML content for each page to be printed.
That endpoint now expects the JSON array directly.
- version 1.x.x
```json
{
"pages": [
"
First Page
",
"Second Page
"
]
}
```
- version 2.x.x
```json
[
"
First Page
",
"Second Page
"
]
```
## Examples
Single-page document, default settings (format: `A4`, orientation: `portrait`):
```bash
curl -X POST \
'http://localhost:3000' \
-H 'Content-Type: text/html' \
-d '
Hello World!
'
```
Single-page document (format: `A3`, orientation: `landscape`):
```bash
curl -X POST \
'http://localhost:3000?format=a3&landscape=true' \
-H 'Content-Type: text/html' \
-d '
Hello World!
'
```
Multi-page document:
```bash
curl -X POST \
'http://localhost:3000/multiple' \
-H 'Content-Type: application/json' \
-d '[
"
Hello World!
",
"This is the second page"
]'
```
## TODO
1. Better handle errors.
2. Set up a way to configure endpoints that will inject custom CSS styles in each page.
## Build
**Automatically builds and publishes to GitHub Packages** (GitHub Container Registry) with each **GitHub Release**.
~~Includes a comprehensive script that lets you build and publish new versions of the image: `./compose.sh `~~
## License
MIT. Do as you please.
Refer to the [LICENSE](./LICENSE) file for more details.