Back to all templates
Browserless logo

Browserless

Development1024MB+ RAM

Headless Chrome as a service for scraping and automation

browserautomationscrapingpuppeteer

Deploy Browserless in 3 Steps

1

Connect Your VPS

Add your server credentials to Server Compass

2

Select Browserless

Choose from our template library

3

Deploy & Configure

Fill in settings and click Deploy

No Docker knowledge required
Step-by-step deployment guide

Deploy Browserless on a VPS with Server Compass

Use the Browserless template in Server Compass to deploy a token-protected headless Chrome automation service on your VPS, then verify the HTTP endpoint in a browser.

About 10 minutesBrowser verified
1
Step 1

Open the server Apps tab

Select the tutorial-vps VPS, open the Apps tab, and start a new app deployment. Keep sensitive server details hidden before capturing or sharing screenshots.

Server Compass Apps tab before creating an Browserless app
2
Step 2

Choose an app template

Click New App and choose the template deployment path so Server Compass can load the built-in catalog.

Choosing to deploy an app from a Server Compass template
3
Step 3

Search for Browserless

Use the template picker search to find Browserless in the Server Compass template catalog.

Searching for Browserless in the Server Compass template picker
4
Step 4

Select the Browserless template

Choose the Browserless template. Server Compass fills the Browserless API service, generated API key, and web/API port.

Browserless template selected in Server Compass
5
Step 5

Review the Browserless settings

Confirm the app name and compose services. In this run, the app was named browserless-demo and used host port 8080.

Reviewing Browserless project settings and compose services
6
Step 6

Deploy Browserless

Review the generated compose settings, confirm the API port is available, and click Deploy.

Reviewing Browserless environment variables and port before deployment
7
Step 7

Watch the deployment progress

Keep the deployment modal open while Server Compass uploads the compose file, pulls the Browserless image, starts the container, and verifies the stack.

Server Compass deploying the Browserless template on the VPS
8
Step 8

Confirm Browserless is running

After deployment finishes, return to the Apps tab and confirm the Browserless app is marked Running with its application URL available.

Browserless template running in the Server Compass Apps tab
9
Step 9

Open the Browserless REST endpoint in the browser

Click Open Application or open the application URL in a browser. The Browserless endpoint confirms the headless Chrome service is reachable.

The deployed Browserless endpoint loaded in a browser

After Browserless Opens

  • Do not expose Browserless directly to the public internet without a firewall, VPN, or authenticated reverse proxy.
  • Always keep the generated API key enabled and rotate it if it is shared outside the deployment team.
  • Use a VPN, IP allowlist, firewall rule, or authenticated reverse proxy for production browser automation access.
  • Monitor CPU and memory usage because concurrent headless browser sessions can be resource-intensive.
  • Keep the Browserless image updated for Chromium, dependency, and security fixes.
  • Restrict API access before running browser automation against private sites or internal services.

Verified Result

The Browserless API endpoint loaded successfully in a browser.

Browserless deployment questions

What does the Browserless template deploy?

It deploys the Browserless Chrome container with a generated token, a maximum concurrent session limit, and an exposed HTTP API for Puppeteer or Playwright clients.

Which port did the tutorial use?

The tutorial used host port 8080, which maps to the Browserless API inside the container on the same port.

Why does the browser verification stop at the first API response?

A fresh Browserless deployment is considered reachable when the HTTP endpoint loads or returns the expected token-protected service response. The tutorial does not publish the generated token.

Should this become a blog post?

No. The deployment guide should live on the Browserless template detail page and be linked from the reusable template deployment docs page.

CLI Deployment

Deploy Browserless Yourself

Want full control? Here's how to deploy Browserless yourself using Docker Compose.

1

Log into Your Server

Access your server's command line by opening a terminal and running the SSH command below.

terminal
# SSH into your server
ssh root@your-server-ip

# Using a custom SSH key
ssh -i ~/.ssh/id_rsa root@your-server-ip

First time? Need Docker? Install it: curl -fsSL https://get.docker.com | sh

2

Prepare the Install Location

Set up the folder structure for your Docker deployment.

terminal
# Create and navigate to project directory
mkdir -p ~/apps/browserless
cd ~/apps/browserless
3

Create docker-compose.yml

Set up your Docker Compose file with this configuration:

docker-compose.yml
services:
  browserless:
    image: browserless/chrome:latest
    ports:
      - "3000:3000"
    environment:
      - TOKEN=<your-token>
      - MAX_CONCURRENT_SESSIONS=10
    restart: unless-stopped
Required Settings
PORTHost port(default: 3000)
TOKENAPI token
4

Run the Deployment

Start all services defined in your compose file.

terminal
# Start the containers in detached mode
docker compose up -d

# Check if containers are running
docker compose ps

# View logs
docker compose logs -f
5

Configure Network Access

Open the port so you can access the application externally.

terminal
# Allow the application port through firewall
sudo ufw allow 3000/tcp
sudo ufw reload

# Access your app at:
# http://your-server-ip:3000
Skip the Terminal

Want one-click deploys? Try Server Compass.

Skip the terminal and deploy Browserless with a visual interface. Configure everything with clicks, not commands.

  • Visual configuration UI
  • One-click deployment
  • Automatic SSL setup
  • Zero-downtime updates
  • Built-in monitoring
  • One-click rollbacks
Download Server Compass$29 one-time • Lifetime license

After Deployment

After deploying Browserless with Server Compass, complete these steps to finish setup

1

Test with Puppeteer or Playwright

2

Configure concurrency limits

Need help? Check out our documentation for detailed guides.

Browserless FAQ

Common questions about self-hosting Browserless

How do I deploy Browserless with Server Compass?

Simply download Server Compass, connect to your VPS, and select Browserless from the templates list. Fill in the required configuration and click Deploy. The entire process takes under 3 minutes.

What are the system requirements for Browserless?

Browserless requires a minimum of 1024MB RAM. We recommend a VPS with at least 2048MB RAM for optimal performance. Any modern Linux server with Docker support will work.

Can I migrate my existing Browserless data?

Yes! Server Compass provides volume mapping that allows you to import existing data. You can also use standard Browserless backup and restore procedures.

How do I update Browserless to the latest version?

Server Compass makes updates easy. Simply click the Update button in your deployment dashboard, and the latest Browserless image will be pulled and deployed with zero downtime.

Is Browserless free to self-host?

Browserless is open-source software. You only pay for your VPS hosting (typically $5-20/month) and optionally Server Compass ($29 one-time). No subscription fees or per-seat pricing.

Ready to Self-Host Browserless?

Download Server Compass and deploy Browserless to your VPS in under 3 minutes. No Docker expertise required.

Download Server Compass