Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/duranda/lambda-pdf-generator
Generate PDF from HTML remotely on AWS Lambda with the Chromium rendering engine
https://github.com/duranda/lambda-pdf-generator
aws-lambda chromium pdf-generation puppeteer wkhtmltopdf
Last synced: 20 days ago
JSON representation
Generate PDF from HTML remotely on AWS Lambda with the Chromium rendering engine
- Host: GitHub
- URL: https://github.com/duranda/lambda-pdf-generator
- Owner: DurandA
- Created: 2024-06-23T19:37:28.000Z (7 months ago)
- Default Branch: master
- Last Pushed: 2024-07-31T23:43:29.000Z (5 months ago)
- Last Synced: 2024-10-10T20:01:40.957Z (3 months ago)
- Topics: aws-lambda, chromium, pdf-generation, puppeteer, wkhtmltopdf
- Language: JavaScript
- Homepage:
- Size: 19.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# pdf-puppeteer-lambda
This service provides an AWS Lambda function to convert HTML and its resources to a PDF using Puppeteer and a headless Chromium instance. It's designed to receive files as multipart/form-data and generate a PDF based on the provided HTML and resources.
## Features
- Convert HTML documents to PDF.
- Include images and styles in the PDF by uploading related resources.
- Customize PDF output through query parameters, such as page size, margins, and scaling.
## Usage
To generate a PDF, you need to send a POST request with your HTML file and any associated resources like images or stylesheets.
### Using `curl` to Generate a PDF
Below is an example of how to use `curl` to send local files as multipart/form-data:
```bash
curl -v -X POST \
-H "Content-Type: multipart/form-data" \
-F "index.html=@/path/to/your/payload/index.html" \
-F "image=@/path/to/your/payload/lena_color.gif" \
"https://h9eg1xua6c.execute-api.eu-west-1.amazonaws.com/default/pdfPuppeteer?scale=1.1&margin=0.2" \
-o output.pdf
```
Replace `/path/to/your/payload/` with the actual path to your HTML and image files.
### Response
The service will return a `PDF` file generated from the HTML content. The `curl` command uses the `-o` argument to output the result to a file named `output.pdf`.
### Query Parameters
- `scale`: Adjust the scale of the webpage rendering. Defaults to 1 if not specified.
- `margin`: Set the margin around the page. Use individual `marginTop`, `marginRight`, `marginBottom`, `marginLeft` for specific margins.
- `format`: Specify page format like `A4`, `Letter`, etc.
Please note that the query parameters are optional and have default values if not provided.
## Headers and Footers
The service allows for the addition of custom headers and footers in the generated PDF. To include a header or footer, you need to upload additional HTML files named `header.html` and `footer.html`.
Headers and footers can contain any valid HTML content, including images and styles. They are fixed to the top and bottom of each page, respectively.
To add a header and/or footer, include them in your request like so:
```bash
curl -v -X POST \
-H "Content-Type: multipart/form-data" \
-F "index.html=@/path/to/your/payload/index.html" \
-F "header.html=@/path/to/your/payload/header.html" \
-F "footer.html=@/path/to/your/payload/footer.html" \
"https://h9eg1xua6c.execute-api.eu-west-1.amazonaws.com/default/pdfPuppeteer" \
-o output.pdf
```
### Inserting Special Values in Headers/Footers
You can insert special values such as page numbers into headers and footers using Puppeteer's template syntax. The following classes can be used within your `header.html` and `footer.html` files:
- `date`: Inserts the print date.
- `title`: Inserts the title of the page, if any.
- `url`: Inserts the URL of the page.
- `pageNumber`: Inserts the current page number.
- `totalPages`: Inserts the total number of pages.
For example, to create a footer that includes the current page number and the total number of pages, your `footer.html` might look like this:
```html
Page of
```