speedtest/README.md

49 lines
1.9 KiB
Markdown
Raw Normal View History

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
Only modern browsers are supported (IE11, latest Edge, latest Chrome, latest Firefox, latest Safari)
2016-03-04 11:48:09 +00:00
## Requirements
2017-05-15 15:34:22 +00:00
- A reasonably fast web server. PHP is optional but recommended (see doc.md for details)
- Some way to generate garbage data (PHP script included, see doc.md for other solutions)
- Your server must accept large POST requests (up to 20 Megabytes), otherwise the upload test will fail
2016-11-28 20:09:12 +00:00
- It's also better if your server does not use compression, but it's not mandatory
2016-03-04 11:48:09 +00:00
2017-06-19 15:27:52 +00:00
## Quick installation videos
* [Debian 9.0 with Apache](https://fdossena.com/?p=speedtest/quickstart_deb.frag)
* [Windows Server 2016 with IIS](https://fdossena.com/?p=speedtest/quickstart_win.frag)
2017-07-13 14:22:01 +00:00
Also, here's an [example config on Ubuntu 16 LTS](https://github.com/adolfintel/speedtest/issues/50)
2017-06-19 15:27:52 +00:00
## How to use in your site
2017-05-15 10:03:47 +00:00
See the examples or doc.md
2016-03-04 11:48:09 +00:00
2017-06-24 08:38:37 +00:00
## Docker
Please see the ```docker``` branch
2017-06-26 11:18:57 +00:00
## Donate
If you want to support this project, you can [send a donation via PayPal](https://www.paypal.me/sineisochronic).
2016-03-04 11:48:09 +00:00
## License
2017-02-02 07:05:42 +00:00
Copyright (C) 2016-2017 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>.