Migrate code from Go branch to new repo

2020-06-02 17:47:39 +08:00
commit fad1302a73
40 changed files with 14952 additions and 0 deletions
@@ -0,0 +1,141 @@
+![LibreSpeed Logo](https://github.com/librespeed/speedtest-go/blob/master/.logo/logo3.png?raw=true)
+
+# LibreSpeed
+
+No Flash, No Java, No WebSocket, No Bullshit.
+
+This is a very lightweight speed test implemented in JavaScript, using XMLHttpRequest and Web Workers.
+
+## Try it
+[Take a speed test](https://speedtest.fdossena.com) (PHP implementation)
+
+## Compatibility
+All modern browsers are supported: IE11, latest Edge, latest Chrome, latest Firefox, latest Safari.
+Works with mobile versions too.
+
+## Features
+* Download
+* Upload
+* Ping
+* Jitter
+* IP Address, ISP, distance from server (optional)
+* Telemetry (optional)
+* Results sharing (optional)
+* Multiple Points of Test (optional)
+* Compatible with PHP frontend predefined endpoints (with `.php` suffixes)
+
+![Screenshot](https://speedtest.fdossena.com/mpot_v6.gif)
+
+## Server requirements
+* Any [Go supported platforms](https://github.com/golang/go/wiki/MinimumRequirements)
+* BoltDB, PostgreSQL or MySQL database to store test results (optional)
+* A fast! Internet connection
+
+## Installation
+
+You need Go 1.13+ to compile the binary. If you have an older version of Go and don't want to install the tarball
+manually, you can install newer version of Go into your GOPATH:
+
+0. Install Go 1.14
+
+   ```
+   $ go get golang.org/dl/go1.14.2
+   # Assuming your GOPATH is default (~/go), Go 1.14.2 will be installed in ~/go/bin
+   $ ~/go/bin/go1.14.2 version
+   go version go1.14.2 linux/amd64
+   ```
+
+1. Clone this repository:
+
+    ```
+    $ git clone github.com/librespeed/speedtest-go
+    # Switch to the Go branch
+    $ git checkout go
+    ```
+
+2. Build
+    ```
+    # Change current working directory to the repository
+    $ cd speedtest
+    # Compile
+    $ go build -ldflags "-w -s" -trimpath -o speedtest main.go
+    ```
+
+3. Copy the `assets` directory, `settings.toml` file along with the compiled `speedtest` binary into a single directory
+
+4. If you have telemetry enabled,
+    - For PostgreSQL/MySQL, create database and import the corresponding `.sql` file under `database/{postgresql,mysql}`
+
+        ```
+        # assume you have already created a database named `speedtest` under current user
+        $ psql speedtest < database/postgresql/telemetry_postgresql.sql
+        ```
+
+    - For embedded BoltDB, make sure to define the `database_file` path in `settings.toml`:
+
+        ```
+        database_file="speedtest.db"
+        ```
+
+5. Put `assets` folder under the same directory as your compiled binary.
+    - Make sure the font files and JavaScripts are in the `assets` directory
+    - You can have multiple HTML pages under `assets` directory. They can be access directly under the server root
+    (e.g. `/example-singleServer-full.html`)
+    - It's possible to have a default page mapped to `/`, simply put a file named `index.html` under `assets`
+
+6. Change `settings.toml` according to your environment:
+
+    ```toml
+    # bind address, use empty string to bind to all interfaces
+    bind_address="127.0.0.1"
+    # backend listen port, default is 8989
+    listen_port=8989
+    # Server location, use zeroes to fetch from API automatically
+    server_lat=0
+    server_lng=0
+    # ipinfo.io API key, if applicable
+    ipinfo_api_key=""
+
+    # password for logging into statistics page, change this to enable stats page
+    statistics_password="PASSWORD"
+    # redact IP addresses
+    redact_ip_addresses=false
+
+    # database type for statistics data, currently supports: bolt, mysql, postgresql
+    database_type="postgresql"
+    database_hostname="localhost"
+    database_name="speedtest"
+    database_username="postgres"
+    database_password=""
+
+    # if you use `bolt` as database, set database_file to database file location
+    database_file="speedtest.db"
+    ```
+
+## Differences between Go and PHP implementation and caveats
+
+- Since there is no CGo-free SQLite implementation available, I've opted to use [BoltDB](https://github.com/etcd-io/bbolt)
+  instead, as an embedded database alternative to SQLite
+- Test IDs are generated ULID, there is no option to change them to plain ID
+- You can use the same HTML template from the PHP implementation
+- Server location can be defined in settings
+- There might be a slight delay on program start if your Internet connection is slow. That's because the program will
+attempt to fetch your current network's ISP info for distance calculation between your network and the speed test client's.
+This action will only be taken once, and cached for later use.
+
+## License
+Copyright (C) 2016-2020 Federico Dossena
+Copyright (C) 2020 Maddie Zhan
+
+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>.