README
¶
ndt-server
This repository contains a ndt5 and ndt7 server written in Go. This code may compile under many systems, including macOS and Windows, but is specifically designed and tested for running on Linux 4.17+.
Clients
Depending on your needs, there are several ways to perform a client measurement using the NDT7 protocol.
Officially supported by members of M-Lab staff.
- https://github.com/m-lab/ndt7-js (javascript)
- https://github.com/m-lab/ndt7-client-go (golang)
Unofficially supported by members of the M-Lab community.
- https://github.com/m-lab/ndt7-client-ios (swift)
- https://github.com/m-lab/ndt7-client-android (kotlin)
- https://github.com/m-lab/ndt7-client-android-java (java)
Setup
Primary setup & running (Linux)
Prepare the runtime environment
install -d certs datadir
To run the server locally, generate local self signed certificates (key.pem
and cert.pem) using bash and OpenSSL
./gen_local_test_certs.bash
build the docker container for ndt-server
docker build . -t ndt-server
enable BBR (with which ndt7 works much better)
sudo modprobe tcp_bbr
and run the ndt-server binary container
docker run --network=bridge \
--publish 443:4443 \
--publish 80:8080 \
--volume `pwd`/certs:/certs:ro \
--volume `pwd`/datadir:/datadir \
--read-only \
--user `id -u`:`id -g` \
--cap-drop=all \
ndt-server \
-cert /certs/cert.pem \
-key /certs/key.pem \
-datadir /datadir \
-ndt7_addr :4443 \
-ndt7_addr_cleartext :8080
Alternate setup & running (Windows & MacOS)
These instructions assume you have Docker for Windows/Mac installed.
Note: NDT5 does not work on Docker for Windows/Mac as it requires using the host's network, which is only supported on Linux
docker-compose run ndt-server ./gen_local_test_certs.bash
docker-compose up
After making changes you will have to run docker-compose up --build to rebuild the ntd-server binary.
Accessing the service
Once you have done that, you should have a ndt5 server running on ports
3001 (legacy binary flavour), 3002 (WebSocket flavour), and 3010
(secure WebSocket flavour); a ndt7 server running on port 443 (over TLS
and using the ndt7 WebSocket protocol); and Prometheus metrics available
on port 9990.
Try accessing these URLs in your browser (for URLs using HTTPS, certs will appear invalid to your browser, but everything is safe because this is a test deployment, hence you should ignore this warning and continue):
- ndt7: http://localhost/ndt7.html or https://localhost/ndt7.html
- ndt5+wss: https://localhost:3010/widget.html
- prometheus: http://localhost:9090/metrics
Replace localhost with the IP of the server to access them externally.
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package bbr contains code required to read BBR variables of a net.Conn on which we're serving a WebSocket client.
|
Package bbr contains code required to read BBR variables of a net.Conn on which we're serving a WebSocket client. |
|
cmd
|
|
|
generate-schemas
Module
|
|
|
Package logging contains data structures useful to implement logging across ndt-server in a Docker friendly way.
|
Package logging contains data structures useful to implement logging across ndt-server in a Docker friendly way. |
|
web100
Package web100 provides web100 variables (or a simulation thereof) to interested systems.
|
Package web100 provides web100 variables (or a simulation thereof) to interested systems. |
|
ndt7
|
|
|
closer
Package closer implements the WebSocket closer.
|
Package closer implements the WebSocket closer. |
|
download
Package download implements the ndt7/server downloader.
|
Package download implements the ndt7/server downloader. |
|
download/sender
Package sender implements the download sender.
|
Package sender implements the download sender. |
|
handler
Package handler implements the WebSocket handler for ndt7.
|
Package handler implements the WebSocket handler for ndt7. |
|
listener
Package listener provides generic functions which extend the capabilities of the http package.
|
Package listener provides generic functions which extend the capabilities of the http package. |
|
measurer
Package measurer collects metrics from a socket connection and returns them for consumption.
|
Package measurer collects metrics from a socket connection and returns them for consumption. |
|
ping
Package ping implements WebSocket PING messages.
|
Package ping implements WebSocket PING messages. |
|
receiver
Package receiver implements the messages receiver.
|
Package receiver implements the messages receiver. |
|
spec
Package spec contains constants defined in the ndt7 specification.
|
Package spec contains constants defined in the ndt7 specification. |
|
upload
Package upload implements the ndt7 upload
|
Package upload implements the ndt7 upload |
|
upload/sender
Package sender implements the upload sender.
|
Package sender implements the upload sender. |
|
iface
Package iface provides access to network connection operations via file descriptor.
|
Package iface provides access to network connection operations via file descriptor. |
|
Package platformx contains platform specific code
|
Package platformx contains platform specific code |
|
Package tcpinfox helps to gather TCP_INFO statistics.
|
Package tcpinfox helps to gather TCP_INFO statistics. |
|
Package version contains ndt-server version
|
Package version contains ndt-server version |