texas2step 2.0.0__tar.gz

texas2step-2.0.0/.gitignore

@@ -0,0 +1,14 @@
+__pycache__/
+*.py[cod]
+.venv/
+.pytest_cache/
+.ruff_cache/
+dist/
+build/
+*.egg-info/
+*.db
+*.db-shm
+*.db-wal
+web/node_modules/
+.DS_Store
+html/

texas2step-2.0.0/LICENSE.md

@@ -0,0 +1,204 @@
+# Apache License
+
+Version 2.0, January 2004<br>
+<http://www.apache.org/licenses/>
+
+## TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+**1. Definitions.**
+
+"License" shall mean the terms and conditions for use, reproduction,
+and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by
+the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all
+other entities that control, are controlled by, or are under common
+control with that entity. For the purposes of this definition,
+"control" means (i) the power, direct or indirect, to cause the
+direction or management of such entity, whether by contract or
+otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity
+exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications,
+including but not limited to software source code, documentation
+source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical
+transformation or translation of a Source form, including but
+not limited to compiled object code, generated documentation,
+and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or
+Object form, made available under the License, as indicated by a
+copyright notice that is included in or attached to the work
+(an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object
+form, that is based on (or derived from) the Work and for which the
+editorial revisions, annotations, elaborations, or other modifications
+represent, as a whole, an original work of authorship. For the purposes
+of this License, Derivative Works shall not include works that remain
+separable from, or merely link (or bind by name) to the interfaces of,
+the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including
+the original version of the Work and any modifications or additions
+to that Work or Derivative Works thereof, that is intentionally
+submitted to Licensor for inclusion in the Work by the copyright owner
+or by an individual or Legal Entity authorized to submit on behalf of
+the copyright owner. For the purposes of this definition, "submitted"
+means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems,
+and issue tracking systems that are managed by, or on behalf of, the
+Licensor for the purpose of discussing and improving the Work, but
+excluding communication that is conspicuously marked or otherwise
+designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity
+on behalf of whom a Contribution has been received by Licensor and
+subsequently incorporated within the Work.
+
+**2. Grant of Copyright License.** Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the
+Work and such Derivative Works in Source or Object form.
+
+**3. Grant of Patent License.** Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+(except as stated in this section) patent license to make, have made,
+use, offer to sell, sell, import, and otherwise transfer the Work,
+where such license applies only to those patent claims licensable
+by such Contributor that are necessarily infringed by their
+Contribution(s) alone or by combination of their Contribution(s)
+with the Work to which such Contribution(s) was submitted. If You
+institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work
+or a Contribution incorporated within the Work constitutes direct
+or contributory patent infringement, then any patent licenses
+granted to You under this License for that Work shall terminate
+as of the date such litigation is filed.
+
+**4. Redistribution.** You may reproduce and distribute copies of the
+Work or Derivative Works thereof in any medium, with or without
+modifications, and in Source or Object form, provided that You
+meet the following conditions:
+
+(a) You must give any other recipients of the Work or
+Derivative Works a copy of this License; and
+
+(b) You must cause any modified files to carry prominent notices
+stating that You changed the files; and
+
+(c) You must retain, in the Source form of any Derivative Works
+that You distribute, all copyright, patent, trademark, and
+attribution notices from the Source form of the Work,
+excluding those notices that do not pertain to any part of
+the Derivative Works; and
+
+(d) If the Work includes a "NOTICE" text file as part of its
+distribution, then any Derivative Works that You distribute must
+include a readable copy of the attribution notices contained
+within such NOTICE file, excluding those notices that do not
+pertain to any part of the Derivative Works, in at least one
+of the following places: within a NOTICE text file distributed
+as part of the Derivative Works; within the Source form or
+documentation, if provided along with the Derivative Works; or,
+within a display generated by the Derivative Works, if and
+wherever such third-party notices normally appear. The contents
+of the NOTICE file are for informational purposes only and
+do not modify the License. You may add Your own attribution
+notices within Derivative Works that You distribute, alongside
+or as an addendum to the NOTICE text from the Work, provided
+that such additional attribution notices cannot be construed
+as modifying the License.
+
+You may add Your own copyright statement to Your modifications and
+may provide additional or different license terms and conditions
+for use, reproduction, or distribution of Your modifications, or
+for any such Derivative Works as a whole, provided Your use,
+reproduction, and distribution of the Work otherwise complies with
+the conditions stated in this License.
+
+**5. Submission of Contributions.** Unless You explicitly state otherwise,
+any Contribution intentionally submitted for inclusion in the Work
+by You to the Licensor shall be under the terms and conditions of
+this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify
+the terms of any separate license agreement you may have executed
+with Licensor regarding such Contributions.
+
+**6. Trademarks.** This License does not grant permission to use the trade
+names, trademarks, service marks, or product names of the Licensor,
+except as required for reasonable and customary use in describing the
+origin of the Work and reproducing the content of the NOTICE file.
+
+**7. Disclaimer of Warranty.** Unless required by applicable law or
+agreed to in writing, Licensor provides the Work (and each
+Contributor provides its Contributions) on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+implied, including, without limitation, any warranties or conditions
+of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+PARTICULAR PURPOSE. You are solely responsible for determining the
+appropriateness of using or redistributing the Work and assume any
+risks associated with Your exercise of permissions under this License.
+
+**8. Limitation of Liability.** In no event and under no legal theory,
+whether in tort (including negligence), contract, or otherwise,
+unless required by applicable law (such as deliberate and grossly
+negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special,
+incidental, or consequential damages of any character arising as a
+result of this License or out of the use or inability to use the
+Work (including but not limited to damages for loss of goodwill,
+work stoppage, computer failure or malfunction, or any and all
+other commercial damages or losses), even if such Contributor
+has been advised of the possibility of such damages.
+
+**9. Accepting Warranty or Additional Liability.** While redistributing
+the Work or Derivative Works thereof, You may choose to offer,
+and charge a fee for, acceptance of support, warranty, indemnity,
+or other liability obligations and/or rights consistent with this
+License. However, in accepting such obligations, You may act only
+on Your own behalf and on Your sole responsibility, not on behalf
+of any other Contributor, and only if You agree to indemnify,
+defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason
+of your accepting any such warranty or additional liability.
+
+## END OF TERMS AND CONDITIONS
+
+## APPENDIX: How to apply the Apache License to your work.
+
+To apply the Apache License to your work, attach the following
+boilerplate notice, with the fields enclosed by brackets "[]"
+replaced with your own identifying information. (Don't include
+the brackets!)  The text should be enclosed in the appropriate
+comment syntax for the file format. We also recommend that a
+file or class name and description of purpose be included on the
+same "printed page" as the copyright notice for easier
+identification within third-party archives.
+
+```text
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+```

texas2step-2.0.0/PKG-INFO

@@ -0,0 +1,184 @@
+Metadata-Version: 2.5
+Name: texas2step
+Version: 2.0.0
+Summary: Web-centric throughput, latency, jitter and packet-loss measurement between endpoints.
+Project-URL: Homepage, https://github.com/robert-patrick-texas/texas2step
+Project-URL: Documentation, https://robert-patrick-texas.github.io/texas2step/
+Project-URL: Repository, https://github.com/robert-patrick-texas/texas2step
+Project-URL: Issues, https://github.com/robert-patrick-texas/texas2step/issues
+Author: Robert Patrick
+License-Expression: Apache-2.0
+License-File: LICENSE.md
+Keywords: jitter,latency,network,packet-loss,speedtest,webrtc
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Web Environment
+Classifier: Framework :: FastAPI
+Classifier: Intended Audience :: System Administrators
+Classifier: Intended Audience :: Telecommunications Industry
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: System :: Networking :: Monitoring
+Requires-Python: >=3.11
+Requires-Dist: aiortc>=1.9
+Requires-Dist: fastapi>=0.115
+Requires-Dist: httpx>=0.27
+Requires-Dist: uvicorn[standard]>=0.32
+Requires-Dist: websockets>=13
+Description-Content-Type: text/markdown
+
+# texas2step
+
+**Throughput, latency, jitter and packet loss between endpoints, measured from a web
+browser.** Open the page and press Start. texas2step measures the path between you
+and the server with multi-stream HTTP transfers, latency probes idle and under load,
+and real UDP packet loss over WebRTC, then shows every figure as discrete metrics and
+graphs. The same measurements are available as a REST API, a Python CLI, and
+server-to-server functions.
+
+![Download in progress](https://raw.githubusercontent.com/robert-patrick-texas/texas2step/main/docs/images/hero-dark.jpg)
+
+Inspired by [speed.cloudflare.com](https://speed.cloudflare.com)
+([cloudflare/speedtest](https://github.com/cloudflare/speedtest)), but self-hosted: a
+Python server, a dependency-free TypeScript client, and no third-party services, so it
+works on air-gapped and internal networks.
+
+## What it measures
+
+| Metric | How | Transport |
+|---|---|---|
+| **Latency** | 20 keep-alive pings, timed with Resource Timing, server time removed | HTTP |
+| **Jitter** | Mean absolute difference between consecutive RTTs | HTTP |
+| **Download / upload** | N parallel streams for T seconds, 100 ms timeline, ramp-up excluded | HTTP |
+| **Latency under load** | Probes every 250 ms on a separate connection during each transfer, graded A+ to F | WebSocket |
+| **Packet loss** | Numbered probes on an unreliable data channel, echoed; up- and downstream loss separated | UDP (WebRTC) |
+| **Stream fairness** | Per-stream rates and Jain's index | HTTP |
+| **Readiness** | Grades for streaming, video calls, reaction time/VDI/SSH and bulk transfers | derived |
+
+Details and definitions: [docs/methodology.md](https://github.com/robert-patrick-texas/texas2step/blob/main/docs/methodology.md).
+
+![Results](https://raw.githubusercontent.com/robert-patrick-texas/texas2step/main/docs/images/results-light.jpg)
+
+The UI has five views: **Test** (gauge, live link animation, charts, exportable and
+shareable results), **Monitor** (continuous UDP probing with a scrolling RTT and loss
+trace, to one server or to two at once for a side-by-side comparison), **Diag** (HTTPS,
+WebSocket and UDP over IPv4 and IPv6, tried once a second, with your addresses, NAT,
+TLS and an event log), **History** (saved runs and trend), and **API** (copy-ready
+examples). A site can hide any of them (`page_test`, `page_monitor`, `page_diag`,
+`page_history`, `page_api`). Every
+chart has a hover readout and a table equivalent.
+
+Visitors pick a theme from the header: Light, Dark, America, Energy, Federal, Military or
+Texas, or one that follows the OS. A page-size drop-down beside it (70% to 125%) fits more on smaller screens. Operators can rename the site, add their logo, organization and
+support links, show a notice on every page and set the default theme; see
+[Branding and themes](https://github.com/robert-patrick-texas/texas2step/blob/main/docs/configuration.md#branding-and-themes).
+
+## Install
+
+On an Ubuntu 26.04 LTS server that already runs nginx, install the Debian package from
+the [releases page](https://github.com/robert-patrick-texas/texas2step/releases) and add
+one line to your site's `server { }` block:
+
+```bash
+sudo apt install ./texas2step-*-amd64.deb        # the package from the releases page
+#   in /etc/nginx/sites-available/<your site>:  include snippets/texas2step.conf;
+sudo nginx -t && sudo systemctl reload nginx     # → https://www.example.net/texas2step/
+```
+
+Or let `texas2step-setup`, which ships next to the `.deb`, check the server first. It
+reports what it will change and what you must fix, then writes an install script for
+that server. The script installs, reinstalls or upgrades texas2step, merges your
+settings into the new template, publishes it through nginx and opens the UDP range:
+
+```bash
+sudo ./texas2step-setup --id houston --name "houston.example.net" --location "Houston, TX"
+sudo ./texas2step-install.sh                     # after reading it
+```
+
+Once installed, `sudo texas2step update` upgrades it to the newest release, and a timer
+can do that unattended. On a server without internet access,
+`sudo texas2step update --from <directory>` installs a release whose two files you put
+there. The [install guide](https://github.com/robert-patrick-texas/texas2step/blob/main/docs/install.md) covers the rest: the setup
+tool's options, the optional `/speedtest` address, configuration, the firewall rule for
+the UDP test, updates, clearing saved results, cloning a server and removal.
+
+To run it from source instead:
+
+```bash
+uv sync && uv run texas2step serve      # http://localhost:8080
+```
+
+Building, testing, the docs site and packaging are covered in
+[docs/development.md](https://github.com/robert-patrick-texas/texas2step/blob/main/docs/development.md).
+
+## Command line
+
+The CLI runs the same engine from any host toward a texas2step server. The package
+installs it as `/usr/bin/texas2step`; elsewhere, `uv tool install texas2step` (or
+`pipx install texas2step`) installs it from PyPI.
+
+```bash
+texas2step run https://www.example.net/texas2step              # full test, human-readable
+texas2step run https://www.example.net/texas2step --json --save
+texas2step latency  https://www.example.net/texas2step --count 50
+texas2step download https://www.example.net/texas2step --streams 8 --seconds 15
+texas2step upload   https://www.example.net/texas2step
+texas2step loss     https://www.example.net/texas2step --packets 1000 --interval 5
+```
+
+```
+client 127.0.0.1 (IPv4, HTTP/1.1)
+this computer 127.0.0.1
+
+  Latency            1.26 ms   jitter 0.09 ms   (min 1.17 · p90 1.53 · 20 samples)
+  Download      6,240.5 Mbps   peak 6,543.6   (2 streams · loaded -0.5 ms)
+  Upload       13,624.1 Mbps   peak 14,188.3   (2 streams · loaded -0.1 ms)
+  Loss                0.00 %   (0/200 lost · ↑ 0.00 % ↓ 0.00 % · UDP RTT 0.92 ms · jitter 0.10 ms)
+  Bufferbloat             A+
+```
+
+`client` is the address the server sees; `this computer` is the CLI's own on that
+connection, before any NAT, with the interface's MAC address on Linux. `--save` stores
+both with the result, and `--no-local` leaves them out.
+
+## API
+
+Every primitive is a plain HTTP endpoint (`/api/v1/ping`, `/down`, `/up`, `/ws`,
+`/rtc/offer`), and a server can measure toward another server on request:
+
+```bash
+curl -o /dev/null 'https://www.example.net/texas2step/api/v1/down?bytes=1000000000'
+curl -s -X POST https://dallas.example.net/texas2step/api/v1/measure/full \
+     -H 'content-type: application/json' -d '{"target": "https://houston.example.net/texas2step"}'
+```
+
+Full reference: [docs/api.md](https://github.com/robert-patrick-texas/texas2step/blob/main/docs/api.md), or `/api/docs` on a running server.
+
+## Several locations
+
+List other texas2step servers in the config and they appear in the header's server
+picker. The browser tests the chosen server directly (cross-origin), and each server can
+measure the others through the API. See [docs/configuration.md](https://github.com/robert-patrick-texas/texas2step/blob/main/docs/configuration.md).
+For servers open to the Internet, see [Access codes](https://github.com/robert-patrick-texas/texas2step/blob/main/docs/access.md).
+
+## Documentation
+
+* [Install](https://github.com/robert-patrick-texas/texas2step/blob/main/docs/install.md): the Ubuntu package, nginx, firewall, upgrades.
+* [Configuration](https://github.com/robert-patrick-texas/texas2step/blob/main/docs/configuration.md): every setting.
+* [Access codes](https://github.com/robert-patrick-texas/texas2step/blob/main/docs/access.md): servers open to the Internet, a code from the service
+  desk, and the desk's tools kept to your networks.
+* [Traffic limits](https://github.com/robert-patrick-texas/texas2step/blob/main/docs/traffic.md): a daily and monthly cap on what the tests move,
+  for servers whose traffic is billed.
+* [Security](https://github.com/robert-patrick-texas/texas2step/blob/main/docs/security.md): the security controls, what each guards against, and
+  what is left to the operator.
+* [Methodology](https://github.com/robert-patrick-texas/texas2step/blob/main/docs/methodology.md): what is measured, and how.
+* [API](https://github.com/robert-patrick-texas/texas2step/blob/main/docs/api.md): endpoints and the UDP probe protocol.
+* [Development](https://github.com/robert-patrick-texas/texas2step/blob/main/docs/development.md): running from source, tests, docs site, packaging,
+  releases.
+* [Roadmap](https://github.com/robert-patrick-texas/texas2step/blob/main/docs/roadmap.md): ideas for future work.
+
+The same pages are published at
+[robert-patrick-texas.github.io/texas2step](https://robert-patrick-texas.github.io/texas2step/).
+
+## License
+
+Copyright 2026 Robert Patrick. Licensed under the [Apache License 2.0](https://github.com/robert-patrick-texas/texas2step/blob/main/LICENSE.md).

texas2step-2.0.0/README.md

@@ -0,0 +1,156 @@
+# texas2step
+
+**Throughput, latency, jitter and packet loss between endpoints, measured from a web
+browser.** Open the page and press Start. texas2step measures the path between you
+and the server with multi-stream HTTP transfers, latency probes idle and under load,
+and real UDP packet loss over WebRTC, then shows every figure as discrete metrics and
+graphs. The same measurements are available as a REST API, a Python CLI, and
+server-to-server functions.
+
+![Download in progress](docs/images/hero-dark.jpg)
+
+Inspired by [speed.cloudflare.com](https://speed.cloudflare.com)
+([cloudflare/speedtest](https://github.com/cloudflare/speedtest)), but self-hosted: a
+Python server, a dependency-free TypeScript client, and no third-party services, so it
+works on air-gapped and internal networks.
+
+## What it measures
+
+| Metric | How | Transport |
+|---|---|---|
+| **Latency** | 20 keep-alive pings, timed with Resource Timing, server time removed | HTTP |
+| **Jitter** | Mean absolute difference between consecutive RTTs | HTTP |
+| **Download / upload** | N parallel streams for T seconds, 100 ms timeline, ramp-up excluded | HTTP |
+| **Latency under load** | Probes every 250 ms on a separate connection during each transfer, graded A+ to F | WebSocket |
+| **Packet loss** | Numbered probes on an unreliable data channel, echoed; up- and downstream loss separated | UDP (WebRTC) |
+| **Stream fairness** | Per-stream rates and Jain's index | HTTP |
+| **Readiness** | Grades for streaming, video calls, reaction time/VDI/SSH and bulk transfers | derived |
+
+Details and definitions: [docs/methodology.md](docs/methodology.md).
+
+![Results](docs/images/results-light.jpg)
+
+The UI has five views: **Test** (gauge, live link animation, charts, exportable and
+shareable results), **Monitor** (continuous UDP probing with a scrolling RTT and loss
+trace, to one server or to two at once for a side-by-side comparison), **Diag** (HTTPS,
+WebSocket and UDP over IPv4 and IPv6, tried once a second, with your addresses, NAT,
+TLS and an event log), **History** (saved runs and trend), and **API** (copy-ready
+examples). A site can hide any of them (`page_test`, `page_monitor`, `page_diag`,
+`page_history`, `page_api`). Every
+chart has a hover readout and a table equivalent.
+
+Visitors pick a theme from the header: Light, Dark, America, Energy, Federal, Military or
+Texas, or one that follows the OS. A page-size drop-down beside it (70% to 125%) fits more on smaller screens. Operators can rename the site, add their logo, organization and
+support links, show a notice on every page and set the default theme; see
+[Branding and themes](docs/configuration.md#branding-and-themes).
+
+## Install
+
+On an Ubuntu 26.04 LTS server that already runs nginx, install the Debian package from
+the [releases page](https://github.com/robert-patrick-texas/texas2step/releases) and add
+one line to your site's `server { }` block:
+
+```bash
+sudo apt install ./texas2step-*-amd64.deb        # the package from the releases page
+#   in /etc/nginx/sites-available/<your site>:  include snippets/texas2step.conf;
+sudo nginx -t && sudo systemctl reload nginx     # → https://www.example.net/texas2step/
+```
+
+Or let `texas2step-setup`, which ships next to the `.deb`, check the server first. It
+reports what it will change and what you must fix, then writes an install script for
+that server. The script installs, reinstalls or upgrades texas2step, merges your
+settings into the new template, publishes it through nginx and opens the UDP range:
+
+```bash
+sudo ./texas2step-setup --id houston --name "houston.example.net" --location "Houston, TX"
+sudo ./texas2step-install.sh                     # after reading it
+```
+
+Once installed, `sudo texas2step update` upgrades it to the newest release, and a timer
+can do that unattended. On a server without internet access,
+`sudo texas2step update --from <directory>` installs a release whose two files you put
+there. The [install guide](docs/install.md) covers the rest: the setup
+tool's options, the optional `/speedtest` address, configuration, the firewall rule for
+the UDP test, updates, clearing saved results, cloning a server and removal.
+
+To run it from source instead:
+
+```bash
+uv sync && uv run texas2step serve      # http://localhost:8080
+```
+
+Building, testing, the docs site and packaging are covered in
+[docs/development.md](docs/development.md).
+
+## Command line
+
+The CLI runs the same engine from any host toward a texas2step server. The package
+installs it as `/usr/bin/texas2step`; elsewhere, `uv tool install texas2step` (or
+`pipx install texas2step`) installs it from PyPI.
+
+```bash
+texas2step run https://www.example.net/texas2step              # full test, human-readable
+texas2step run https://www.example.net/texas2step --json --save
+texas2step latency  https://www.example.net/texas2step --count 50
+texas2step download https://www.example.net/texas2step --streams 8 --seconds 15
+texas2step upload   https://www.example.net/texas2step
+texas2step loss     https://www.example.net/texas2step --packets 1000 --interval 5
+```
+
+```
+client 127.0.0.1 (IPv4, HTTP/1.1)
+this computer 127.0.0.1
+
+  Latency            1.26 ms   jitter 0.09 ms   (min 1.17 · p90 1.53 · 20 samples)
+  Download      6,240.5 Mbps   peak 6,543.6   (2 streams · loaded -0.5 ms)
+  Upload       13,624.1 Mbps   peak 14,188.3   (2 streams · loaded -0.1 ms)
+  Loss                0.00 %   (0/200 lost · ↑ 0.00 % ↓ 0.00 % · UDP RTT 0.92 ms · jitter 0.10 ms)
+  Bufferbloat             A+
+```
+
+`client` is the address the server sees; `this computer` is the CLI's own on that
+connection, before any NAT, with the interface's MAC address on Linux. `--save` stores
+both with the result, and `--no-local` leaves them out.
+
+## API
+
+Every primitive is a plain HTTP endpoint (`/api/v1/ping`, `/down`, `/up`, `/ws`,
+`/rtc/offer`), and a server can measure toward another server on request:
+
+```bash
+curl -o /dev/null 'https://www.example.net/texas2step/api/v1/down?bytes=1000000000'
+curl -s -X POST https://dallas.example.net/texas2step/api/v1/measure/full \
+     -H 'content-type: application/json' -d '{"target": "https://houston.example.net/texas2step"}'
+```
+
+Full reference: [docs/api.md](docs/api.md), or `/api/docs` on a running server.
+
+## Several locations
+
+List other texas2step servers in the config and they appear in the header's server
+picker. The browser tests the chosen server directly (cross-origin), and each server can
+measure the others through the API. See [docs/configuration.md](docs/configuration.md).
+For servers open to the Internet, see [Access codes](docs/access.md).
+
+## Documentation
+
+* [Install](docs/install.md): the Ubuntu package, nginx, firewall, upgrades.
+* [Configuration](docs/configuration.md): every setting.
+* [Access codes](docs/access.md): servers open to the Internet, a code from the service
+  desk, and the desk's tools kept to your networks.
+* [Traffic limits](docs/traffic.md): a daily and monthly cap on what the tests move,
+  for servers whose traffic is billed.
+* [Security](docs/security.md): the security controls, what each guards against, and
+  what is left to the operator.
+* [Methodology](docs/methodology.md): what is measured, and how.
+* [API](docs/api.md): endpoints and the UDP probe protocol.
+* [Development](docs/development.md): running from source, tests, docs site, packaging,
+  releases.
+* [Roadmap](docs/roadmap.md): ideas for future work.
+
+The same pages are published at
+[robert-patrick-texas.github.io/texas2step](https://robert-patrick-texas.github.io/texas2step/).
+
+## License
+
+Copyright 2026 Robert Patrick. Licensed under the [Apache License 2.0](LICENSE.md).

texas2step-2.0.0/deploy/nginx/texas2step-http.conf

@@ -0,0 +1,17 @@
+# texas2step: http-level definitions for snippets/texas2step.conf.
+# Installed as /etc/nginx/conf.d/texas2step.conf, which Ubuntu's nginx.conf loads
+# inside its http { } block. On its own it changes nothing.
+
+# The texas2step service; keep in step with LISTEN_HOST/LISTEN_PORT in
+# /etc/default/texas2step.
+upstream texas2step {
+    server 127.0.0.1:8080;
+    keepalive 32;
+}
+
+# Send "Connection: upgrade" only for WebSocket requests; otherwise keep the
+# upstream connection alive.
+map $http_upgrade $texas2step_connection {
+    default upgrade;
+    ""      "";
+}

texas2step-2.0.0/deploy/nginx/texas2step-log.conf

@@ -0,0 +1,11 @@
+# texas2step: the log format of its nginx snippets.
+# Installed as /etc/nginx/conf.d/texas2step-log.conf, which Ubuntu's nginx.conf loads
+# inside its http { } block. A file of its own, so that an upgrade brings it even where
+# conf.d/texas2step.conf was edited (dpkg keeps an edited file as it is).
+
+# nginx's combined format, with the path in place of the whole request line: the query
+# string can hold an access pass (?pass=), which would let anyone who reads the log test
+# until it expires.
+log_format texas2step '$remote_addr - $remote_user [$time_local] '
+                      '"$request_method $uri $server_protocol" $status $body_bytes_sent '
+                      '"$http_referer" "$http_user_agent"';

texas2step-2.0.0/deploy/nginx/texas2step-speedtest.conf

@@ -0,0 +1,20 @@
+# Optional: https://www.example.net/speedtest as a second address for texas2step.
+#
+# Installed as /etc/nginx/snippets/texas2step-speedtest.conf. Include it next to
+# snippets/texas2step.conf in the same server { } block:
+#
+#     include snippets/texas2step-speedtest.conf;
+#
+# Visitors are redirected, so links and saved results always use /texas2step/.
+# The redirects are temporary (302), so browsers don't remember them if you later
+# use /speedtest for something else.
+
+location = /speedtest {
+    absolute_redirect off;
+    return 302 /texas2step/;
+}
+
+location ^~ /speedtest/ {
+    absolute_redirect off;
+    rewrite ^/speedtest/(.*)$ /texas2step/$1 redirect;
+}