wrenderer

wrenderer is a web rendering service that uses automated browsers to render web pages.

---

• Overview
• Features
• API
  • Render
    • Single URL
    • Multiple URLs from sitemap
    • Sitemap rendering status check
  • Cache invalidation
    • Single url invalidation
    • Domain invalidation
  • Admin APIs
    • List rendered caches
    • List running jobs
    • Show configuration
• Setup

---

Overview

wrenderer is designed for SEO purposes and for serving proper content to bots that cannot render or execute JavaScript in client-side rendered applications (e.g., SPAs).The project is inspired by Rendertron.

wrenderer is built with Golang and chromedp, and can be deployed on AWS environment using Lambda or run on premise.

Features

• Render single URL or multiple URLs from a sitemap.xml link
• Cache rendered HTML for faster response and reduced rendering costs
• Invalidate cache for a single URL or an entire domain
• Key-based authentication for API access
• Admin API to monitor program status, such as rendered caches and running jobs (currently supported only in local mode)

API

All API requests require an x-api-key header with a valid API key.

Render

Single URL

Render a single URL and return the rendered HTML content.

GET /render?url={targetUrl}

Query Parameters

• url (required): The target page to render, must be an absolute HTTP/HTTPS url (url-encoded).

Response

• On premise: return the rendered HTML content directly with 200 OK status code.
• AWS: return 200 OK status code with JSON body containing a path key, which is the path to access the rendered HTML content.

  
  {
      "path": "page/.../..."
  }
  
  

Multiple URLs from sitemap

Render multiple URLs from a sitemap.xml link and cache the rendered HTML for each URL. This is an asynchronous operation, it will return 202 Accepted status code with location header to check the status of the operation. The location endpoint will also be in the response body with location key.

PUT /render/sitemap

Request Body

{
    "sitemapUrl": "https://example.com/sitemap.xml"
}

Response (202 Accepted)

{
    "message": "Sitemap rendering accepted", 
    "location": "/render/sitemap/{jobId}/status"
}

Sitemap rendering status check

Check the status of the sitemap rendering operation, request path can be obtain from response of the sitemap rendering opration.

GET /render/sitemap/{jobId}/status

Cache invalidation

Single url invalidation

Invalidate cache for a single URL.

DELETE /render?url={targetUrl}

Query Parameters

• url (required): The target page to render, must be an absolute HTTP/HTTPS url (url-encoded).

Domain invalidation

Invalidate all cached pages under the given domain.

DELETE /render?domain=www.example.com

Admin APIs

APIs for admin usage only, require admin API key.

Note: Currently implement in local build type only

List rendered caches

List all rendered page in cache.

GET /admin/renders

Query Parameters

• domain: Show only caches under the given domain

List running jobs

List all jobs in progress.

GET /admin/jobs

Query Parameters

• category: Filter jobs by category.
  • Available categories: sitemap

Show configuration

Show current configuration settings.

GET /admin/config

Setup

• On premise
• AWS environment