Headless Chrome

Headless Chrome is a headless browser that can be configured on projects like any other service on Upsun.

You can interact with the chrome-headless service container using Puppeteer, a Node.js library that provides an API to control Chrome over the DevTools Protocol.

Puppeteer can be used to generate PDFs and screenshots of web pages, automate form submission, and test your project’s UI. You can find out more information about using Puppeteer on GitHub or in their documentation.

Supported versions

You can select the major version. But the latest compatible minor version is applied automatically and can’t be overridden.

Patch versions are applied periodically for bug fixes and the like. When you deploy your app, you always get the latest available patches.

• 120
• 113
• 95
• 91
• 86
• 84
• 83
• 81
• 80
• 73

Relationship reference

For each service defined via a relationship to your application, Upsun automatically generates corresponding environment variables within your application container, in the $<RELATIONSHIP-NAME>_<SERVICE-PROPERTY> format.

Here is example information available through the service environment variables themselves, or through the PLATFORM_RELATIONSHIPS environment variable.

CHROMEHEADLESS_SERVICE=chromeheadless
CHROMEHEADLESS_IP=123.456.78.90
CHROMEHEADLESS_HOSTNAME=azertyuiopqsdfghjklm.chromeheadless.service._.eu-1.platformsh.site
CHROMEHEADLESS_CLUSTER=azertyuiop-main-7rqtwti
CHROMEHEADLESS_HOST=chromeheadless.internal
CHROMEHEADLESS_REL=http
CHROMEHEADLESS_SCHEME=http
CHROMEHEADLESS_TYPE=chrome-headless:120
CHROMEHEADLESS_PORT=9222

{
    "service": "chromeheadless",
    "ip": "123.456.78.90",
    "hostname": "azertyuiopqsdfghjklm.chromeheadless.service._.eu-1.platformsh.site",
    "cluster": "azertyuiop-main-7rqtwti",
    "host": "chromeheadless.internal",
    "rel": "http",
    "scheme": "http",
    "type": "chrome-headless:120",
    "port": 9222
}

# Decode the built-in credentials object variable.
export RELATIONSHIPS_JSON=$(echo $PLATFORM_RELATIONSHIPS | base64 --decode)

# Set environment variables for individual credentials.
export APP_HEADLESSCHROME_HOST=="$(echo $RELATIONSHIPS_JSON | jq -r '.chromeheadless[0].host')"

Requirements

Puppeteer requires at least Node.js version 6.4.0, while using the async and await examples below requires Node 7.6.0 or greater.

If your app container uses a language other than Node.js, upgrade the Node.js version before using Puppeteer. See how to manage your Node.js version.

Usage example

1. Configure the service

To define the service, use the chrome-headless type:

services:
    # The name of the service container. Must be unique within a project.
    <SERVICE_NAME>:
        type: chrome-headless:<VERSION>

Note that changing the name of the service replaces it with a brand new service and all existing data is lost. Back up your data before changing the service.

2. Add the relationship

To define the relationship, use the following configruation:

applications:
    # The name of the app container. Must be unique within a project.
    <APP_NAME>:
        # Relationships enable access from this app to a given service.
        # The example below shows simplified configuration leveraging a default service
        # (identified from the relationship name) and a default endpoint.
        # See the Application reference for all options for defining relationships and endpoints.
        relationships:
            <SERVICE_NAME>: 
services:
    # The name of the service container. Must be unique within a project.
    <SERVICE_NAME>:
        type: chrome-headless:<VERSION>

You can define <SERVICE_NAME> as you like, so long as it’s unique between all defined services and matches in both the application and services configuration.

The example above leverages default endpoint configuration for relationships. That is, it uses default endpoints behind-the-scenes, providing a relationship (the network address a service is accessible from) that is identical to the name of that service.

Depending on your needs, instead of default endpoint configuration, you can use explicit endpoint configuration.

With the above definition, the application container now has access to the service via the relationship <RELATIONSHIP_NAME> and its corresponding service environment variables.

Example configuration

applications:
    # The name of the app container. Must be unique within a project.
    myapp:
        # Relationships enable access from this app to a given service.
        # The example below shows simplified configuration leveraging a default service
        # (identified from the relationship name) and a default endpoint.
        # See the Application reference for all options for defining relationships and endpoints.
        relationships:
            chrome-headless: 

services:
    # The name of the service container. Must be unique within a project.
    chrome-headless:
        type: chrome-headless:120

Use in app

After configuration, include Puppeteer as a dependency:

npm install puppeteer

pnpm add puppeteer

yarn add puppeteer

Configuration for a project looks similar to the following:

applications:
    # The name of the app container. Must be unique within a project.
    myapp:
        # The location of the application's code.
        source:
            root: "/"
            type: "nodejs:22"

            [...]

            # Relationships enable an app container's access to a service.
            relationships:
                chromeheadless: 
                    service: chromeheadless
                    endpoint: http
services:
    # The name of the service container. Must be unique within a project.
    chromeheadless:
        type: chrome-headless:120

This configuration defines a single application (myapp), whose source code exists in the <PROJECT_ROOT>/myapp directory.
myapp has access to the chromeheadless service, via a relationship whose name is identical to the service name (as per default endpoint configuration for relationships).

From this, myapp can retrieve access credentials to the service through the relationship environment variable.

# Set environment variables for individual credentials,
# For more information, please visit https://docs.upsun.com/development/variables.html#service-environment-variables.
export CHROME_IP=${CHROMEHEADLESS_IP}
export CHROME_PORT=${CHROMEHEADLESS_PORT}

# Combine into a single base URL to be used within app.
export CHROME_BASEURL="http://${CHROME_IP}:${CHROME_PORT}"

The above file — .environment in the myapp directory — is automatically sourced by Upsun into the runtime environment, so that the variable CHROME_BASEURL can be used within the application to connect to the service.

Note that CHROME_BASEURL and all Upsun service environment variables like CHROMEHEADLESS_HOST, are environment-dependent. Unlike the build produced for a given commit, they can’t be reused across environments and only allow your app to connect to a single service instance on a single environment.

A file very similar to this is generated automatically for your when using the upsun ify command to migrate a codebase to Upsun.

Puppeteer allows your application to create screenshots, emulate a mobile device, generate PDFs, and much more.