{"id":13582491,"url":"https://github.com/m-lab/ndt-server","last_synced_at":"2025-04-04T05:03:51.194Z","repository":{"id":33690768,"uuid":"104499624","full_name":"m-lab/ndt-server","owner":"m-lab","description":"docker native ndt5 and ndt7 server with prometheus integration","archived":false,"fork":false,"pushed_at":"2024-09-30T16:27:33.000Z","size":23782,"stargazers_count":101,"open_issues_count":88,"forks_count":40,"subscribers_count":19,"default_branch":"main","last_synced_at":"2024-10-29T16:09:42.778Z","etag":null,"topics":["bbr","docker","experiment","ndt","ndt7","network-performance-test","prometheus","tcpinfo"],"latest_commit_sha":null,"homepage":"https://www.measurementlab.net/","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/m-lab.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":"AUTHORS","dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-09-22T17:13:33.000Z","updated_at":"2024-10-14T00:33:51.000Z","dependencies_parsed_at":"2023-07-14T03:08:19.159Z","dependency_job_id":"c4c867a8-0e0a-4fcc-affb-ad4caf5335b1","html_url":"https://github.com/m-lab/ndt-server","commit_stats":{"total_commits":507,"total_committers":18,"mean_commits":"28.166666666666668","dds":0.5996055226824457,"last_synced_commit":"1df586728fc8383e02af55e23b9f944b466348df"},"previous_names":["m-lab/ndt-cloud"],"tags_count":62,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/m-lab%2Fndt-server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/m-lab%2Fndt-server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/m-lab%2Fndt-server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/m-lab%2Fndt-server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/m-lab","download_url":"https://codeload.github.com/m-lab/ndt-server/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246952406,"owners_count":20859833,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bbr","docker","experiment","ndt","ndt7","network-performance-test","prometheus","tcpinfo"],"created_at":"2024-08-01T15:02:45.992Z","updated_at":"2025-04-04T05:03:51.180Z","avatar_url":"https://github.com/m-lab.png","language":"Go","funding_links":[],"categories":["Go"],"sub_categories":[],"readme":"[![GoDoc](https://godoc.org/github.com/m-lab/ndt-server?status.svg)](https://godoc.org/github.com/m-lab/ndt-server) [![Build Status](https://app.travis-ci.com/m-lab/ndt-server.svg?branch=main)](https://travis-ci.com/m-lab/ndt-server) [![Coverage Status](https://coveralls.io/repos/github/m-lab/ndt-server/badge.svg?branch=main)](https://coveralls.io/github/m-lab/ndt-server?branch=main) [![Go Report Card](https://goreportcard.com/badge/github.com/m-lab/ndt-server)](https://goreportcard.com/report/github.com/m-lab/ndt-server)\n\n# ndt-server\n\nThis repository contains a [ndt5](\nhttps://github.com/ndt-project/ndt/wiki/NDTProtocol) and [ndt7](\nspec/ndt7-protocol.md) server written in Go. This code may compile under\nmany systems, including macOS and Windows, but is specifically designed\nand tested for running on Linux 4.19+.\n\n## Clients\n\nDepending on your needs, there are several ways to perform a client measurement\nusing the NDT7 protocol.\n\nOfficially supported by members of M-Lab staff.\n\n* https://github.com/m-lab/ndt7-js (javascript)\n* https://github.com/m-lab/ndt7-client-go (golang)\n\nUnofficially supported by members of the M-Lab community.\n\n* https://github.com/m-lab/ndt7-client-cc (c++)\n* https://github.com/m-lab/ndt7-client-ios (swift)\n* https://github.com/m-lab/ndt7-client-android (kotlin)\n* https://github.com/m-lab/ndt7-client-android-java (java)\n\n## Setup\n\n### Primary setup \u0026 running (Linux)\n\nPrepare the runtime environment\n\n```bash\ninstall -d certs datadir\n```\n\nTo run the server locally, generate local self signed certificates (`key.pem`\nand `cert.pem`) using bash and OpenSSL\n\n```bash\n./gen_local_test_certs.bash\n```\n\nbuild the docker container for `ndt-server`\n\n```bash\ndocker build . -t ndt-server\n```\n\nenable BBR (with which ndt7 works much better)\n\n```\nsudo modprobe tcp_bbr\n```\n\nand run the `ndt-server` binary container\n\n```bash\ndocker run --network=bridge                \\\n           --publish 443:4443              \\\n           --publish 80:8080               \\\n           --volume `pwd`/certs:/certs:ro  \\\n           --volume `pwd`/datadir:/datadir \\\n           --read-only                     \\\n           --user `id -u`:`id -g`          \\\n           --cap-drop=all                  \\\n           ndt-server                      \\\n           -cert /certs/cert.pem           \\\n           -key /certs/key.pem             \\\n           -datadir /datadir               \\\n           -ndt7_addr :4443                \\\n           -ndt7_addr_cleartext :8080\n```\n\n### Alternate setup \u0026 running (Windows \u0026 MacOS)\n\nThese instructions assume you have Docker for Windows/Mac installed.\n\n**Note: NDT5 does not work on Docker for Windows/Mac as it requires using the host's network, which is only supported on Linux**\n\n```\ndocker-compose run ndt-server ./gen_local_test_certs.bash\ndocker-compose up\n```\n\nAfter making changes you will have to run `docker-compose up --build` to rebuild the ntd-server binary.\n\n## Accessing the service\n\nOnce you have done that, you should have a ndt5 server running on ports\n`3001` (legacy binary flavour), `3002` (WebSocket flavour), and `3010`\n(secure WebSocket flavour); a ndt7 server running on port `443` (over TLS\nand using the ndt7 WebSocket protocol); and Prometheus metrics available\non port `9990`.\n\nTry accessing these URLs in your browser (for URLs using HTTPS, certs will\nappear invalid to your browser, but everything is safe because this is a test\ndeployment, hence you should ignore this warning and continue):\n\n* ndt7: http://localhost/ndt7.html or https://localhost/ndt7.html\n* ndt5+wss: https://localhost:3010/widget.html\n* prometheus: http://localhost:9090/metrics\n\nReplace `localhost` with the IP of the server to access them externally.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fm-lab%2Fndt-server","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fm-lab%2Fndt-server","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fm-lab%2Fndt-server/lists"}