Skip to content

Latest commit

 

History

History
91 lines (71 loc) · 2.77 KB

README.md

File metadata and controls

91 lines (71 loc) · 2.77 KB
Raw

bot-render Build status

A Docker container which runs headless Chrome and renders web pages on the fly.

Dependencies

This project requires Node 7+ and Docker (installation instructions). For deployment this project uses the Google Cloud Platform SDK.

Installing

Install node dependencies using:

npm install

Install Chrome:

apt-get install google-chrome

Running locally

With a local instance of Chrome installed, you can start the server locally:

npm start

To test a rendering, send a request:

http://localhost:3000/?url=https://dynamic-meta.appspot.com

Docker

After installing docker, build the docker image:

docker build -t bot-render . --no-cache=true

Running the container

There are two ways to run the container locally:

  1. [Recommended] - Use Jessie Frazelle' seccomp profile and -security-opt flag
  2. Utilize the --cap-add SYS_ADMIN flag

In the case where your kernel lacks user namespace support or are receiving a ECONNREFUSED error when trying to access the service in the container (as noted in issues 2 and 3), both methods above should resolve the problem.

[Recommended] Start a container with the built image using Jessie Frazelle' seccomp profile for Chrome:

wget https://raw.githubusercontent.com/jfrazelle/dotfiles/master/etc/docker/seccomp/chrome.json -O ~/chrome.json
docker run -it -p 8080:8080 --security-opt seccomp=$HOME/chrome.json --name bot-render-container bot-render

Start a container with the built image using SYS_ADMIN:

docker run -it -p 8080:8080 --cap-add SYS_ADMIN --name bot-render-container bot-render

Send a request to the server running inside the container:

curl -X GET "http://localhost:8080/?url={urlToDump}&dom={document|body|head}"

Examples:

# To dump head dom (Default)
curl -X GET "http://localhost:8080/?url=https://dynamic-meta.appspot.com&dom=head"
 
# To dump body dom
curl -X GET "http://localhost:8080/?url=https://dynamic-meta.appspot.com&dom=body"
 
# To dump document dom
curl -X GET "http://localhost:8080/?url=https://dynamic-meta.appspot.com&dom=document"

Stop the container:

docker stop bot-render-container

Remove the container:

docker rm bot-render-container

Clear all containers:

docker rm -f $(docker ps -a -q)

Deploying to Google Cloud Platform

gcloud app deploy app.yaml --project <your-project-id>