Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/xcoo/pdfshot

PDF screenshot generator for web pages
https://github.com/xcoo/pdfshot

clojure clojurescript docker puppeteer

Last synced: about 1 month ago
JSON representation

PDF screenshot generator for web pages

Awesome Lists containing this project

README

        

# pdfshot

[![build](https://github.com/xcoo/pdfshot/workflows/build/badge.svg)](https://github.com/xcoo/pdfshot/actions?query=workflow%3Abuild)
[![DockerHub](https://img.shields.io/docker/v/xcoo/pdfshot)](https://hub.docker.com/r/xcoo/pdfshot)

PDF screenshot generator for web pages

## Run pdfshot

```shell
$ docker pull xcoo/pdfshot:0.1.8
$ docker run --rm \
--cap-add=SYS_ADMIN \
-e "PDFSHOT_PORT=8000" \
-e "PDFSHOT_TIMEOUT=60000" \
-p 8000:8000 \
xcoo/pdfshot:0.1.8
```

## Usage

```shell
$ curl -fsLJO 'localhost:8000/print.pdf?target=https%3A%2F%2Fxcoo.jp&wait_for=%23container'
```

- `target` (Required)
- The URL for which you want to get the screenshot.
- `https://xcoo.jp`
- `wait_for` (Optional)
- Wait for the screenshot until the selector you specified appears on the page.
- `#container`

## Build Requirements

- Leiningen

## Build Docker image

```shell
$ docker build -t xcoo/pdfshot:latest .
$ docker-compose up -d
```

## Local execution

```shell
$ lein cljsbuild once
$ node target/pdfshot.js
```

## License

Copyright [Xcoo, Inc.][xcoo]

Licensed under the [Apache License, Version 2.0][apache-license-2.0].

[xcoo]: https://xcoo.jp
[apache-license-2.0]: http://www.apache.org/licenses/LICENSE-2.0.html