imflow/url2image repository overview

⁠URL2Image

A microservice that turns an URL into an image aka it takes a screenshot of the website.

⁠What it is

URL2Image provides an API, which accepts a URL and returns a rendered image of the URL.

⁠Installation

Either clone the repo and run it yourself:

git clone https://github.com/ImFlow/URL2Image.git

and then run it via:

docker build -t url2image .
docker run -d -p 5000:5000 url2image

or use the prebuild docker image:

docker pull imflow/url2image
docker run -d -p 5000:5000 url2image

there is also a docker-compose.yml file included so the service can be run using:

docker-compose up

⁠How To Use

To download an url as a png file call the /getImage endpoint.

curl "localhost:5000/getImage?url=google.de" -o test.png

Supported options are url to specify the url of the target. This is required. width and height are optional parameters specifiing the image dimensions.

curl "localhost:5000/getImage?url=google.de&width=400&height=400" -o test.png

A basic login can be achieved via:

curl -H "Content-Type: application/json" -X POST -d '{"username":"user", "password":"url2image" }' "http://localhost:5000/login"
{
    "access_token": "TOKEN"
}

The authorization is then done in the header::

curl -H "Authorization: Bearer TOKEN" "http://localhost:5000/getImage?url=google.de"

⁠Documentation

More documentation can be found here⁠

⁠Configuration

The service can be configured using environtment variables:

⁠TODO

:white_check_mark: Design API

:white_check_mark: Provide API endpoints

:white_check_mark: DDos protection

:white_check_mark: JWT authentification

:white_check_mark: Username/Password authentification

:white_check_mark: Configs

:white_check_mark: Image format selection (jpg/png)

• Add a standalone Program