diff --git a/docs/documentation/sitespeed.io/installation/index.md b/docs/documentation/sitespeed.io/installation/index.md index 61d71072a..8fc2d5e0e 100644 --- a/docs/documentation/sitespeed.io/installation/index.md +++ b/docs/documentation/sitespeed.io/installation/index.md @@ -1,14 +1,13 @@ --- layout: default -title: Installation - Documentation - sitespeed.io -description: How to to install sitespeed.io. Use npm or Docker. -keywords: installation, documentation, web performance, sitespeed.io -author: Peter Hedenskog +title: Install sitespeed.io using npm/yarn or Docker. +description: Install "npm install sitespeed.io -g" or "yarn global add sitespeed.io". +keywords: installation, documentation, web performance, sitespeed.io, yarn, npm, docker nav: documentation image: https://www.sitespeed.io/img/sitespeed-2.0-twitter.png -twitterdescription: How to to install sitespeed.io. Use npm or Docker. +twitterdescription: Install sitespeed.io using npm, yarn or Docker. --- -[Documentation]({{site.baseurl}}/documentation/sitespeed.io/) / Installation +[Documentation](/documentation/sitespeed.io/) / Installation # Installation {:.no_toc} @@ -16,32 +15,45 @@ twitterdescription: How to to install sitespeed.io. Use npm or Docker. * Lets place the TOC here {:toc} -# Download and installation +# Install -## Install on Mac, Linux & Windows +## Mac & Linux -Prerequisites: Install [NodeJS](https://nodejs.org/en/download/) ([Linux](https://github.com/creationix/nvm)) and make sure you have [npm](https://github.com/npm/npm) installed. +Prerequisites: Install [NodeJS](https://nodejs.org/en/download/) ([Linux](https://github.com/creationix/nvm)) and make sure you have [npm](https://github.com/npm/npm) or [yarn](https://yarnpkg.com/) installed. You can also use [Docker](https://docs.docker.com/engine/installation/) if you prefer. + +### npm +If you prefer npm, just run: ~~~ bash -$ npm install sitespeed.io@4.0.0-beta.1 -g +$ npm install sitespeed.io -g +$ sitespeed.io --help ~~~ -Run +### yarn +Or with [yarn](https://yarnpkg.com/): ~~~ bash -sitespeed.io --help +$ yarn global add sitespeed.io +$ sitespeed.io --help ~~~ -on Windows you should use the Docker image. +### Docker - -## Docker - -We have [Docker images](https://hub.docker.com/u/sitespeedio/) with sitespeed.io, Chrome, Firefox and Xvfb. They are super easy to use (Xvfb is started automatically when you start the container). Here's how to use the container with both Firefox & Chrome (install [Docker](https://docs.docker.com/engine/installation/) first. +We have [Docker images](https://hub.docker.com/u/sitespeedio/) with sitespeed.io, Chrome, Firefox and Xvfb. They are super easy to use (Xvfb is started automatically when you start the container). Here's how to use the container with both Firefox & Chrome (install [Docker](https://docs.docker.com/engine/installation/) first). ~~~ bash -$ docker pull sitespeedio/sitespeed.io:4.0-beta -$ docker run --rm -v "$(pwd)":/sitespeed.io sitespeedio/sitespeed.io:4.0-beta https://www.sitespeed.io -b firefox +$ docker pull sitespeedio/sitespeed.io +$ 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]({{site.baseurl}}/documentation/sitespeed.io/docker/). +## Windows +We support Windows using [Docker](https://docs.docker.com/engine/installation/windows/). To be able to support running on Windows with NodeJS we need more [core contributors](/aboutus/) that can focus on Windows. + +### Docker + +~~~ bash +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](/documentation/sitespeed.io/docker/).