README.md

BrowserMicroservice

Fast, robust and scalable self-hosted microservice for taking website screenshots.

Getting started

This browser microservice can be used to make the functionalities of a web browser available to different clients via a REST API interface.

It offers the following features:

• Taking high quality screenshots of websites
• Save screenshots to object storage

Documentation

Configuration

When starting the application, it will first check if there exists an configuration file "config.yml". If this file doesn't exists, it will use the default configuration the config file will be created.

Below is the default config.yml file:

host: "127.0.0.1"
port: 7000
screenshots:
  defaultWidth: 1920
  defaultHeight: 1200
  defaultBrowserEngine: "CHROME"

For more information about all configuration options visit the Configuration Documentation

API Interface

• Take screenshot

  GET localhost:7000/v1/screenshot/{url-encoded website url}

  This request takes a simple screenshot of the given website and returns the image in the response.

  Get parameter	Description	Value
  width	Width of the screenshot	1 - 10000
  height	Height of the screenshot	1 - 10000

  For more information about all api endpoints visit the Screenshot-API Documentation.

• Status

  GET localhost:7000/status

  This HTTP endpoint provides status information and metrics about the microservce.

  For more information about the status api visit the Status-API Documentation.

Links

• https://javalin.io/documentation
• https://www.selenium.dev/documentation/
• https://bonigarcia.dev/webdrivermanager/