As an automation project, GoogleChrome/rendertron has picked up 6.0k stars on GitHub (TypeScript). A Headless Chrome rendering solution
Snapshot summary built from the project's own GitHub metadata — there's no written TopGit review yet. The page will update automatically when a full review is published.
WHY NO REVIEW YET
TopGit writes full reviews for the most-starred, most-requested repositories. This page is a snapshot until then — see the READ ME tab for the original README in full.
Please note that this project is deprecated. Dynamic rendering is not a recommended approach and there are better approaches to rendering on the web.
Rendertron will not be actively maintained at this point.
Rendertron is a headless Chrome rendering solution designed to render & serialise web pages on the fly.
:hammer: Built with Puppeteer
:cloud: Easy deployment to Google Cloud
:mag: Improves SEO
Rendertron is designed to enable your Progressive Web App (PWA) to serve the correct
content to any bot that doesn't render or execute JavaScript. Rendertron runs as a
standalone HTTP server. Rendertron renders requested pages using Headless Chrome,
auto-detecting when your PWA has completed loading
and serializes the response back to the original request. To use Rendertron, your application
configures middleware to determine whether to proxy a request to Rendertron.
Rendertron is compatible with all client side technologies, including web components.
Contents
Middleware
API
Render
Screenshot
Invalidate cache
FAQ
Query parameters
Page render timing
Rendering budget timeout
Web components
Status codes
Installing & deploying
Building
Running locally
Deploying to Google Cloud Platform
Deploying using Docker
Config
Troubleshooting
Middleware
Once you have the service up and running, you'll need to implement the differential serving
layer. This checks the user agent to determine whether prerendering is required.
This is a list of middleware available to use with the Rendertron service:
Express.js middleware
Firebase functions (Community maintained)
ASP.net core middleware (Community maintained)
Python (Django) middleware and decorator (Community maintained)
Rendertron is also compatible with prerender.io middleware.
Note: the user agent lists differ there.
API
Render
GET /render/<url>
The render endpoint will render your page and serialize your page. Options are
specified as query parameters:
mobile defaults to false. Enable by passing ?mobile to request the
mobile version of your site.
refreshCache: Pass refreshCache=true to ignore potentially cached render results
and treat the request as if it is not cached yet.
The new render result is used to replace the previous result.
Screenshot
GET /screenshot/<url>
POST /screenshot/<url>
The screenshot endpoint can be used to verify that your page is rendering
correctly.
Both endpoints support the following query parameters:
width defaults to 1000 - specifies viewport width.
height defaults to 1000 - specifies viewport height.
mobile defaults to false. Enable by passing ?mobile to request the
mobile version of your site.
timezoneId - specifies rendering for timezone.
Additional options are available as a JSON string in the POST body. See
Puppeteer documentation
for available options. You cannot specify the type (defaults to jpeg) and
encoding (defaults to binary) parameters.
Invalidate cache
GET /invalidate/<url>
The invalidate endpoint will remove cache entried for <url> from the configured cache (in-memory, filesystem or cloud datastore).
FAQ
Query parameters
When setting query parameters as part of your URL, ensure they are encoded correctly. In JS,
this would be encodeURIComponent(myURLWithParams). For example to specify page=home:
The service attempts to detect when a page has loaded by looking at the page load event, ensuring there
are no outstanding network requests and that the page has had ample time to render.
Rendering budget timeout
There is a hard limit of 10 seconds for rendering. Ensure you don't hit this budget by ensuring
your application is rendered well before the budget expires.
Web components
Headless Chrome supports web components but shadow DOM is difficult to serialize effectively.
As such, shady DOM (a lightweight shim for Shadow DOM)
is required for web components.
If you are using web components v0 (deprecated), you will need to enable Shady DOM to
render correctly. In Polymer 1.x, which uses web components v0, Shady DOM is enabled by default.
If you are using Shadow DOM, override this by setting the query parameter dom=shady when
directing requests to the Rendertron service.
If you are using web components v1 and either webcomponents-lite.js or webcomponents-loader.js,
set the query parameter wc-inject-shadydom=true when directing requests to the Rendertron
service. This renderer service will force the necessary polyfills to be loaded and enabled.
Status codes
Status codes from the initial requested URL are preserved. If this is a 200, or 304, you can
set the HTTP status returned by the rendering service by adding a meta tag.
<meta name="render:status_code" content="404" />
Running locally
To install Rendertron and run it locally, first install Rendertron:
npm install -g rendertron
With Chrome installed on your machine run the Rendertron CLI:
rendertron
Installing & deploying
Building
Clone and install dependencies:
git clone https://github.com/GoogleChrome/rendertron.git
cd rendertron
npm install
npm run build
Running locally
With a local instance of Chrome installed, you can start the server locally:
Rendertron no longer includes a Docker file. Instead, refer to
Puppeteer documentation
on how to deploy run headless Chrome in Docker.
Config
When deploying the service, set configuration variables by including a config.json in the
root. Available configuration options:
timeoutdefault 10000 - set the timeout used to render the target page.
portdefault 3000 - set the port to use for running and listening the rendertron service. Note if process.env.PORT is set, it will be used instead.
hostdefault 0.0.0.0 - set the hostname to use for running and listening the rendertron service. Note if process.env.HOST is set, it will be used instead.
widthdefault 1000 - set the width (resolution) to be used for rendering the page.
heightdefault 1000 - set the height (resolution) to be used for rendering the page.
reqHeadersdefault {} - set the additional HTTP headers to be sent to the target page with every request.
cachedefault null - set to datastore to enable caching on Google Cloud using datastore only use if deploying to google cloud, memory to enable in-memory caching or filesystem to enable disk based caching
cacheConfig - an object array to specify caching options
renderOnly - restrict the endpoint to only service requests for certain domains. Specified as an array of strings. eg. ['http://render.only.this.domain']. This is a strict prefix match, so ensure you specify the exact protocols that will be used (eg. http, https).
closeBrowserdefault false - true forces the browser to close and reopen between each page render, some sites might need this to prevent URLs past the first one rendered returning null responses.
restrictedUrlPatterndefault null - set the restrictedUrlPattern to restrict the requests matching given regex pattern.
cacheConfig
cacheDurationMinutesdefault 1440 - set an expiry time in minues, defaults to 24 hours. Set to -1 to disable cache Expiration
cacheMaxEntriesdefault 100 - set the maximum number of entries stored in the selected cache method. Set to -1 to allow unlimited caching. If using the datastore caching method, setting this value over 1000 may lead to degraded performance as the query to determine the size of the cache may be too slow. If you want to allow a larger cache in datastore consider setting this to -1 and managing the the size of your datastore using a method like this Deleting Entries in Bulk
snapshotDirdefault <your os's default tmp dir>/renderton - filesystem only the directory the rendertron cache files will be stored in
Example
An example config file specifying a memory cache, with a 2 hour expiration, and a maximum of 50 entries
How active is development on GoogleChrome/rendertron?
The most recent commit recorded on GoogleChrome/rendertron was 4.1 years ago, based on the GitHub push timestamp. The repository has 901 forks — one of the better signals of community interest.
How many stars does GoogleChrome/rendertron have?
GoogleChrome/rendertron has 6.0k GitHub stars — refresh the page for the live number, or check github.com/GoogleChrome/rendertron. TopGit mirrors GitHub's count but does not claim minute-by-minute accuracy.
What else is in the Automation space?
GoogleChrome/rendertron is tracked by TopGit under the Automation category, alongside 6 GitHub-tagged topics. Trending and Topics pages list peer repositories of comparable stars and language.
What language is GoogleChrome/rendertron written in?
GoogleChrome/rendertron is written primarily in TypeScript. GitHub's language field is based on the largest share of bytes in the default branch.
What topics is GoogleChrome/rendertron associated with?
GitHub's repository topics for GoogleChrome/rendertron: "hacktoberfest", "headless-chrome", "puppeteer", "rendering", "seo", "webcomponents". TopGit's editorial category is Automation.
Where do I read more about GoogleChrome/rendertron?
This TopGit page is a snapshot — the READ ME tab shows the project's own README content (links stripped, images preserved). The GitHub repository at github.com/GoogleChrome/rendertron is the definitive source.
Why is GoogleChrome/rendertron categorized under Automation?
TopGit places GoogleChrome/rendertron in the Automation category based on its GitHub topics and description (tagged: "hacktoberfest", "headless-chrome", "puppeteer"). Categories are assigned from real repository metadata, not editorial guesswork.
Read full README in the tab above.
Curious whether rendertron is right for you?
Let ChatGPT, Claude, or Perplexity look into it — click below and see what AI actually says about rendertron.