Checkweb – Instructions

Check websites locally or online and interpret the results.

Installation and launch

Get the DEB package from the downloads page. On Linux Mint, open it with the package manager and install it. Alternatively, run this in the directory containing the downloaded file:

sudo apt install ./checkweb_*.deb

Keep only the intended Checkweb DEB in that directory. APT installs required dependencies. Launch Checkweb from its menu entry. When using the source code, run ./start.sh inside the project directory; the script itself does not install packages.

Check a website

1. Choose a local or online check.
2. Select the project directory for a local check, or enter a website address such as https://example.org for an online check.
3. Select the check categories and review the limits for pages, link depth, files and HTTP requests.
4. Start the check and wait for the result. Missing optional tools and unchecked areas are reported separately.
5. Open the reported locations and fix confirmed issues in the project.

Read the results

Distinguish errors, warnings, notes and unchecked areas. A completed run does not mean every area could be checked. Reaching resource limits makes the check incomplete.

HTTP 404 and 410 confirm missing links according to the target server. Access restrictions, rate limits, server errors and timeouts may require manual or later checks.

Save reports

Export HTML for a readable overview or JSON for further processing. Reports include locations, notes and check limitations.

Settings and help

Tools and settings are available under Options. Help contains the manual and program information. The interface supports German and English; additional language packs can be imported.

Terminal checks

Check a local project without network access:

python3 checkweb.py --local /path/to/project --no-network --output report.html

Run selected online checks:

python3 checkweb.py --url https://example.org --checks html,links --output report.json

Run these examples in the source directory. --help, --tools and --version provide more information. Exit code 0 means a completed run without error findings, 1 means error findings, and 2 means a failed or incomplete check. Notes and skipped areas still matter.

Limitations

Online checks do not execute JavaScript in a browser. Dynamic content and server-side PHP code cannot be fully checked that way. Automated checks do not replace complete security or accessibility audits.

Current project documentation on GitHub · Downloads · Contact