https://github.com/rmehner/bits-to-dead-trees

https://github.com/rmehner/bits-to-dead-trees

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/rmehner/bits-to-dead-trees
• Owner: rmehner
• License: apache-2.0
• Created: 2022-04-06T13:55:36.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-04-13T09:40:30.000Z (9 months ago)
• Last Synced: 2024-04-13T23:58:14.804Z (9 months ago)
• Language: TypeScript
• Size: 1.23 MB
• Stars: 4
• Watchers: 3
• Forks: 3
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# bits-to-dead-trees

🖥 -> 🌲 -> 📄 -> 🖨

Exposes a web server with a single endpoint to take in a URL and create a PDF out

of that. It's using [Playwright](https://playwright.dev) in the background for this.

[![Depfu](https://badges.depfu.com/badges/74bd86ac2a33c6c6f6817cafc6419e84/overview.svg)](https://depfu.com/github/rmehner/bits-to-dead-trees?project_id=35056)

## Setup

### Requirements

1. Node 20+

2. npm

### Installation

1. `git checkout https://github.com/rmehner/bits-to-dead-trees`

2. `cd bits-to-dead-trees`

3. `npm install`

4. `npm start` to start the server. It'll listen to port 8000 on localhost by default.

### Development

- After updating the `playwright` dependency, you should run `npm run update-schemas` to make sure that

  the server knows about new PDF options

- Use `npm run start:dev` to start everything in dev mode with build watch and friends

## Server

The server exposes the `/pdf` endpoint that listens to a POST request and expects a JSON body:

```json

{

  "url": "https://your-target-url.com/site/you/want/a/pdf/of",

  "pdfOptions": {},

  "gotoOptions": {},

  "browserContextOptions": {}

}

```

- `pdfOptions` are the options for the `pdf` call in Playwright: https://playwright.dev/docs/api/class-page#page-pdf.

- `gotoOptions` are the options for the `goto` method in Playwright: https://playwright.dev/docs/api/class-page#page-goto

  - if you don't pass anything, we default to a timeout of 60000 and wait for `networkidle`

- `browserContextOptions` are the options for the browser context in Playwright: https://playwright.dev/docs/api/class-browser#browser-new-context

  - if you don't pass anything, we default to set `ignoreHTTPSErrors` to `true`

The response is the PDF file.

## Docker

Versions are automatically build as Docker images and are available on [GitHub's package registry](https://github.com/rmehner/bits-to-dead-trees/pkgs/container/bits-to-dead-trees)

If you want to use it internally with docker-compose, this should give you a good idea to start:

```yml

services:

  pdf:

    image: ghcr.io/rmehner/bits-to-dead-trees:v2.18.2

    ports:

      - 8000:8000

```