speedtest/README.md

76 lines
2.1 KiB
Markdown
Raw Normal View History

2018-10-28 08:48:18 +00:00
![HTML5 Speedtest Logo](https://github.com/adolfintel/speedtest/blob/master/.logo/Readme-Logo.png?raw=true)
2016-11-28 20:09:12 +00:00
# HTML5 Speedtest
2016-03-04 11:48:09 +00:00
No Flash, No Java, No Websocket, No Bullshit.
2016-11-28 20:09:12 +00:00
This is a very lightweight Speedtest implemented in Javascript, using XMLHttpRequest and Web Workers.
2016-03-04 11:48:09 +00:00
## Try it
2017-02-02 07:05:42 +00:00
[Take a Speedtest](http://speedtest.fdossena.com)
2016-03-04 11:48:09 +00:00
## Compatibility
All modern browsers are supported: IE11, latest Edge, latest Chrome, latest Firefox, latest Safari.
Works with mobile versions too.
2016-03-04 11:48:09 +00:00
## Features
* Download
* Upload
* Ping
* Jitter
* IP Address, ISP, distance from server (optional)
* Telemetry (optional)
* Results sharing (optional)
* Multiple Points of Test (optional)
![Screenshot](https://speedtest.fdossena.com/mpot_v5.gif)
2018-08-06 18:36:20 +00:00
## Docker Hub
```
Utlize the docker-compose.yml provided
$ docker-compose up
```
## Docker + Docker Compose
The project includes a basic `docker-compose.yml` for development. To run, execute the following:
```
$ docker-compose build
$ docker-compose up
```
2019-07-01 19:01:46 +00:00
Speedtest will be available at [http://0.0.0.0:8888/](http://0.0.0.0:8888/).
To run via Docker directly:
```
$ docker build -t adolfintel/speedtest:latest .
$ docker run -d --name speedtest -p 0.0.0.0:80:80 adolfintel/speedtest:latest
```
2017-06-27 14:06:57 +00:00
2017-06-26 11:19:32 +00:00
## Donate
2018-04-25 14:56:53 +00:00
[![Donate with Liberapay](https://liberapay.com/assets/widgets/donate.svg)](https://liberapay.com/fdossena/donate)
[Donate with PayPal](https://www.paypal.me/sineisochronic)
2017-06-26 11:19:32 +00:00
2016-03-04 11:48:09 +00:00
## License
2018-12-31 14:31:20 +00:00
Copyright (C) 2016-2019 Federico Dossena
2016-03-04 11:48:09 +00:00
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with this program. If not, see <https://www.gnu.org/licenses/lgpl>.