Skip to content

About

A one-button desktop app that checks common home-network problems and explains the results in plain English.

Topics

Resources

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

HomeNetCheck

HomeNetCheck is a free desktop app that checks common home-network problems and explains the results in plain English.

Download it, open it, and click Check my network. You do not need to use a terminal or install Python.

HomeNetCheck showing plain-language gateway, DNS, double NAT, and UPnP results

Sanitized example from an early build. Download the current version from the latest release.

Read why I built HomeNetCheck, or tell me where the report is confusing.

Download and run it

  1. Go to the latest release.
  2. Download the file for your computer:
    • Windows: homenetcheck-windows.exe
    • macOS: homenetcheck-macos.dmg
    • Linux: homenetcheck-linux.AppImage
  3. Open the downloaded file.
  4. Click Check my network.

HomeNetCheck is not code-signed, so Windows or macOS may show a security warning the first time you open it. Read Why the app is unsigned and how to open it safely before continuing.

Only download HomeNetCheck from this repository's Releases page. Each download has a matching SHA-256 checksum file if you want to verify that the file arrived unchanged.

What it checks

HomeNetCheck looks at:

  • whether it can find your router;
  • DNS response time;
  • double NAT;
  • whether your router responds to UPnP discovery;
  • approximate download and upload speed;
  • latency and packet loss; and
  • available Wi-Fi information and possible congestion.

It reports what it can measure and explains when a check is unavailable. It does not change your router or network settings.

HomeNetCheck or homenet?

HomeNetCheck is the graphical version. It sits on top of the open-source homenet engine, which performs the actual checks.

Choose HomeNetCheck if you want a window, a button, and a report you can read without terminal commands. Choose homenet if you are comfortable in a terminal, want a smaller Python installation, need machine-readable JSON, or want to run checks from a script or remote session.

Both versions perform the same core checks. You do not need to install both.

Privacy

The checks run on your computer. HomeNetCheck does not send your diagnostic report to Greg Weir or Tartanleaf.com Inc.

Some checks must contact outside services to test your connection: Cloudflare for DNS and speed testing and api.ipify.org to determine your public IP address. The app may show local and public network addresses in its report. Review a saved report before sharing it publicly.

Limitations and support

HomeNetCheck is a diagnostic aid. Results vary by operating system, permissions, router, and network conditions. It is not a replacement for your internet provider, router manufacturer, or qualified technical support.

This is a free, open-source project, not a supported commercial Tartanleaf product. Bug reports are welcome in GitHub Issues, but there is no promise of individual support, fixes, or continued development.

Build from source

For developers, Python 3.12 is the tested build version:

python3.12 -m venv .venv
.venv/bin/pip install -e ".[build,test]"
QT_QPA_PLATFORM=offscreen .venv/bin/python -m pytest -q
./scripts/build_local.sh

On Windows, use the equivalent .venv\Scripts\python and .venv\Scripts\pip paths. The finished bundle appears in dist/.

See CONTRIBUTING.md before proposing a change.

License and credits

HomeNetCheck was developed by Greg Weir and released as free, open-source software by Tartanleaf.com Inc..

The source code is available under the MIT License and comes with no warranty. The application icon is derived from the Tartanleaf logo, used here to identify the official build. The Tartanleaf name and logo are not licensed for general reuse under the MIT License; see BRANDING.md.

HomeNetCheck uses the separate open-source homenet engine and Qt for Python. See THIRD_PARTY_NOTICES.md for dependency licensing information.

About

A one-button desktop app that checks common home-network problems and explains the results in plain English.

Topics

Resources

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages