Documentation / Installation

Installation

Install

You can run sitespeed.io using our Docker containers or using NodeJS.

Docker #

We have Docker images with sitespeed.io, Chrome, Firefox, Xvfb and all the software needed for recording a video of the browser screen and analyse it to get Visual Metrics. It is super easy to use). Here’s how to use the container with both Firefox & Chrome (install Docker first).

Mac & Linux #

docker run --rm -v "$(pwd)":/sitespeed.io sitespeedio/sitespeed.io https://www.sitespeed.io -b firefox

Windows #

C:\Users\Vicky> docker pull sitespeedio/sitespeed.io
C:\Users\Vicky> docker run --rm -v ${pwd}:/sitespeed.io sitespeedio/sitespeed.io https://www.sitespeed.io -b firefox

That will output the data from the run in the current directory. You can read more about running the containers here.

Node JS #

Mac & Linux #

Prerequisites: Install latest NodeJS LTS (Linux) and make sure you have npm or yarn installed. Also install Chrome/Firefox (you need them to collect metrics).

Make sure you install without sudo using sudo. Checkout Sindre Sorhus guide.

npm #

If you prefer npm, just run:

npm install sitespeed.io -g

yarn #

Or with yarn:

yarn global add sitespeed.io

Windows #

We support Windows using Docker. To be able to support running on Windows with NodeJS we need at least one core contributor that can focus on Windows. Are you that one? Please get in touch!

Skip installing ChromeDriver/GeckoDriver #

If you don’t want to install ChromeDriver or GeckoDriver when you install through npm you can skip them with an environment variable.

Skip installing ChromeDriver:

CHROMEDRIVER_SKIP_DOWNLOAD=true npm install sitespeed.io -g

Skip installing GeckoDriver:

GECKODRIVER_SKIP_DOWNLOAD=true npm install sitespeed.io -g