Documentation v7

sitespeed.io logo

Sitespeed.io is the complete toolbox to test the web performance of your web site. Use it to monitor your performance or checkout how your competition is doing. You can see all the latest changes in the Changelog for the project.

  • Introduction - start here if you are new to the project or web performance testing.
  • Installation - install using npm, yarn or run our Docker containers.
  • Configuration - there‚Äôs a lot of things you can do with sitespeed.io, lets checkout how!
  • Browsers - collect timings using real browsers. We support Firefox, Chrome and Chrome on Android.
  • Connectivity - set the connectivity to emulate real users network conditions.
  • Performance Dashboard - keep track of your metrics and performance.
  • Alerts - send alerts (email/Slack/PagerDuty etc) when you get a performance regression.
  • F.A.Q and Best Practice - here we keep track of questions we get in Slack.
  • Performance Budget - make sure you are within your performance budget.
  • Plugins - list/disable/enable or create your own plugin.
  • Pre/post scripting - run Selenium scripts before/after you test a URL.
  • Setup S3 - how to setup S3 for your html result/videos and screenshots.
  • Metrics - configure which metrics you want to use.
  • Continuous Integration - generate JUnit XML/TAP and use Jenkins, Circle CI, Gitlab CI, Grunt or the Gulp plugin.
  • Docker - how to use our Docker containers.
  • Graphite - how to configure and store your metrics in Graphite (and using StatsD).
  • Video - all that you can do with the video.
  • Upgrade - upgrading from 5.x to 6.0 check out our guide here.
  • Mobile phones - test using your mobile phone (Android only).
  • WebPageTest - drive WebPageTest and fetch metrics and graph them.
  • Lighthouse - run Lighthouse and Google PageSpeed Insights from sitespeed.io.
  • WebPageReplay - WebPageReplay is proxy that first records your web site and then replay it locally. That can help you find performance regression in the front-end code easier: Latency/server timings are constant.
  • Developers - start here when you want to do PRs or create a plugin.
  • How to Write a Good Bug Report - if you write a good bug report, we can spend more time helping you fixing the problem instead of asking you questions.