0 Installation (Node.js)

dosse91 edited this page 2019-09-25 09:27:38 +02:00

Table of Contents

• Requirements
• Linux:
• macOS
• Windows
• Next steps:

Requirements

• A server with a fast connection (at least 100 Mbps recommended)
• nodeJS (tested with 8.10)
• npm or yarn

Note: prebuilt packages are available for Windows, macOS and Linux. No installation is required for these.

Linux:

1. Install git by executing sudo apt install git
2. Clone the repo and enter the directory: git clone https://github.com/librespeed/speedtest.git && cd speedtest && git checkout node
3. Install the node dependencies by executing npm i or yarn (depending on which Package Manager you use)
4. Start the Speedtest Server: node Speedtest.js

macOS

1. Start the Terminal
2. Install git via brew: brew install git (If you have XCode installed, git should already be installed. Try git --version)
3. Clone the repo and enter the directory: git clone https://github.com/librespeed/speedtest.git && cd speedtest && git checkout node
4. Install the node dependencies by executing npm i or yarn (depending on which Package Manager you use)
5. Start the Speedtest Server: node Speedtest.js

Windows

1. Install git via Git For Windows
2. Open git bash
3. Clone the repo and enter the directory: git clone https://github.com/librespeed/speedtest.git && cd speedtest && git checkout node
4. Install the node dependencies by executing npm i or yarn (depending on which Package Manager you use)
5. Start the Speedtest Server: node Speedtest.js

Next steps:

• Using PM2 to keep the instance running

Main topics

• Browser support
• Installation
  • With PHP
    • With docker
  • Multiple test points, PHP
  • With Node.js
    • Using prebuilt binaries
  • With Go
• Troubleshooting, common problems, known limitations

Advanced topics

• Making a custom front-end
• Using PM2 (nodeJS only)
• Alternative backends
  • No backend
• Implementation details
  • speedtest.js
  • speedtest_worker.js
  • backend files
  • results files
• Contributing