prerender

Render JavaScript-rendered page as HTML using headless Chrome

These details have not been verified by PyPI

Project description

# prerender

Render JavaScript-rendered page as HTML/PDF/mhtml/png/jpeg using headless Chrome

## Install Chrome

Headless mode is supported in Chrome unstable/dev channel, you should be able to install it via:

https://www.google.com/chrome/browser/beta.html?platform=linux

## Start Chrome Headless

```bash
$ google-chrome-unstable --headless --remote-debugging-port=9222 --disable-gpu "about:blank"
```

## Install Prerender

```bash
$ pip install -U prerender
```

## Start Prerender

As standalone application:

```bash
$ prerender
```

To run it under gunicorn:

```bash
$ gunicorn --bind 0.0.0.0:3000 --worker-class sanic.worker.GunicornWorker prerender.app:app
```

## How does it work

Say you deployed Prerender under `http://prerender.example.com:8000`, to render `http://example.com` you can do:

```bash
$ # render HTML
$ curl http://prerender.example.com:8000/http://example.com
$ curl http://prerender.example.com:8000/html/http://example.com
$ # render mhtml
$ curl http://prerender.example.com:8000/mhtml/http://example.com
$ # render PDF
$ curl http://prerender.example.com:8000/pdf/http://example.com
$ # render png
$ curl http://prerender.example.com:8000/png/http://example.com
$ # render jpeg
$ curl http://prerender.example.com:8000/jpeg/http://example.com
```

## Configuration

Settings are mostly configured by environment variables.

| ENV | default value | description |
|----------------------------|------------------|-----------------------------------------------------|
| HOST | 0.0.0.0 | Prerender listen host |
| PORT | 8000 | Prerender listen port |
| DEBUG | false | Toggle debug mode |
| PRERENDER_TIMEOUT | 30 | renderring timeout |
| CONCURRENCY | 2 * CPU count | Chrome pages count |
| MAX_ITERATIONS | 200 | Restart Chrome page after rendering this many pages |
| CHROME_HOST | localhost | Chrome remote debugging host |
| CHROME_PORT | 9222 | Chrome remote debugging port |
| USER_AGENT | | Chrome User Agent |
| ALLOWED_DOMAINS | | Domains allowed for renderring, comma seperated |
| CACHE_BACKEND | dummy | Cache backend, `dummy`, `disk`, `s3` |
| CACHE_LIVE_TIME | 3600 | Disk cache live seconds |
| CACHE_ROOT_DIR | /tmp/prerender | Disk cache root directory |
| S3_SERVER | s3.amazonaws.com | S3 server address |
| S3_ACCESS_KEY | | S3 access key |
| S3_SECRET_KEY | | S3 secret key |
| S3_REGION | | S3 region |
| S3_BUCKET | prerender | S3 bucket name |
| SENTRY_DSN | | Sentry DSN, for exception monitoring |

## Configure client

Please view the original NodeJs version [prerender](https://github.com/prerender/prerender#official-middleware) README.

## License

MIT

Project details

These details have not been verified by PyPI

Release history Release notifications | RSS feed

0.10.0

Apr 19, 2018

0.9.3

Dec 21, 2017

0.9.2

Dec 21, 2017

0.9.1

Nov 1, 2017

0.9.0

Oct 9, 2017

0.8.1

Aug 16, 2017

0.8.0

Jul 26, 2017

This version

0.7.5

Jun 30, 2017

0.7.5.dev1 pre-release

Jun 28, 2017

0.7.5.dev0 pre-release

Jun 28, 2017

0.7.4

Jun 12, 2017

0.7.3

May 26, 2017

0.7.3.dev5 pre-release

May 25, 2017

0.7.3.dev4 pre-release

May 25, 2017

0.7.3.dev3 pre-release

May 24, 2017

0.7.3.dev2 pre-release

May 24, 2017

0.7.3.dev1 pre-release

May 24, 2017

0.7.3.dev0 pre-release

May 24, 2017

0.7.2

May 22, 2017

0.7.1

May 22, 2017

0.7.0

May 18, 2017

0.7.0.dev3 pre-release

May 17, 2017

0.7.0.dev2 pre-release

May 16, 2017

0.7.0.dev1 pre-release

May 16, 2017

0.7.0.dev0 pre-release

May 15, 2017

0.6.1

May 8, 2017

0.6.0

May 8, 2017

0.5.1

Apr 28, 2017

0.5.0

Apr 27, 2017

0.4.7

Apr 27, 2017

0.4.6

Apr 16, 2017

0.4.3

Apr 11, 2017

0.4.2

Apr 9, 2017

0.4.1

Apr 9, 2017

0.4.0

Apr 9, 2017

0.3.7

Apr 8, 2017

0.3.6

Apr 7, 2017

0.3.5

Apr 7, 2017

0.3.4

Apr 4, 2017

0.3.3

Apr 4, 2017

0.3.2

Apr 3, 2017

0.3.0

Mar 23, 2017

0.2.12

Mar 21, 2017

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

prerender-0.7.5.tar.gz (13.7 kB view details)

Uploaded Jun 30, 2017 Source

Built Distribution

prerender-0.7.5-py3-none-any.whl (17.6 kB view details)

Uploaded Jun 30, 2017 Python 3

File details

Details for the file prerender-0.7.5.tar.gz.

File metadata

Download URL: prerender-0.7.5.tar.gz
Upload date: Jun 30, 2017
Size: 13.7 kB
Tags: Source
Uploaded using Trusted Publishing? No

File hashes

Hashes for prerender-0.7.5.tar.gz
Algorithm	Hash digest
SHA256	`e82c1b5fa505bb1cdf94a2af6b82cfdc31b070469b48fa07a203a5a0aa4e630b`
MD5	`5e8717983ac413a2b154bd7e1333e57f`
BLAKE2b-256	`59a31fe1789084acc8f88379add41362ce7fa485fdafefdc2b5dfc460d4451fe`

See more details on using hashes here.

File details

Details for the file prerender-0.7.5-py3-none-any.whl.

File metadata

Download URL: prerender-0.7.5-py3-none-any.whl
Upload date: Jun 30, 2017
Size: 17.6 kB
Tags: Python 3
Uploaded using Trusted Publishing? No

File hashes

Hashes for prerender-0.7.5-py3-none-any.whl
Algorithm	Hash digest
SHA256	`26d9455f1e9f55e0321cc5465568e15af45a1268c38e72a8cefcfdbea25e5fe8`
MD5	`be64464357add23779d0fdd8ad20613d`
BLAKE2b-256	`abd95bc306b7993184ef550871bff48a733a54a9eb328ec9e36737cd2ff43bcb`