You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
Chris Mayo 2c3aa5ebb9
Merge pull request #629 from lpirl/ignoreerrors
1 day ago
.github Fix install with pip git+https 2 weeks ago
cgi-bin Use python3 for cgi-bin/lc.wsgi 2 years ago
config Install linkcheckerrc in the package data 9 months ago
doc add option to ignore specific errors for specific URLs 3 days ago
linkcheck add option to ignore specific errors for specific URLs 3 days ago
po Update application translation catalogs 9 months ago
scripts Add gemini scheme 2 weeks ago
tests add option to ignore specific errors for specific URLs 3 days ago
tools Write all metadata used to _release.py 2 weeks ago
.flake8 Rename setup.cfg to .flake8 3 weeks ago
.gitattributes Remove defunct entries from .gitattributes 3 weeks ago
.gitignore Add .coverage and .pytest_cache to .gitignore 3 weeks ago
.project Add Eclipse Pydev project files. 12 years ago
.pydevproject Updated pydev settings. 11 years ago
.yamllint Add a yamllint check for workflows 10 months ago
CODE_OF_CONDUCT.rst Include CONTRIBUTING and CODE_OF_CONDUCT in Sphinx documentation 2 years ago
CONTRIBUTING.rst Fix broken external links in documentation 1 year ago
COPYING Moved some files into the doc/ subdirectory. 13 years ago
Dockerfile Merge pull request #634 from cjmayo/pyxdg 4 weeks ago
Makefile Add yamllint to make check 2 weeks ago
README.rst Use the website for installation link in README 7 months ago
pyoxidizer.bzl Enable creating a binary with PyOxidizer 9 months ago
pyproject.toml Install create.sql to examples 2 weeks ago
pytest.ini Ignore bs4 markup and XML parser warnings 4 weeks ago
requirements.txt Remove dependency on pyxdg 1 month ago
robots.txt Add non-ascii values to test robots.txt 14 years ago
tox.ini Remove check-python-versions that needs setup.py 3 weeks ago

README.rst

LinkChecker

Build Status_ License_

Check for broken links in web sites.

Features

  • recursive and multithreaded checking and site crawling
  • output in colored or normal text, HTML, SQL, CSV, XML or a sitemap graph in different formats
  • HTTP/1.1, HTTPS, FTP, mailto:, news:, nntp:, Telnet and local file links support
  • restrict link checking with regular expression filters for URLs
  • proxy support
  • username/password authorization for HTTP, FTP and Telnet
  • honors robots.txt exclusion protocol
  • Cookie support
  • HTML5 support
  • a command line and web interface
  • various check plugins available

Installation

Python 3.7 or later is needed. Using pip to install LinkChecker:

pip3 install linkchecker

The version in the pip repository may be old, to find out how to get the latest code, plus platform-specific information and other advice see doc/install.txt in the source code archive.

Usage

Execute linkchecker https://www.example.com. For other options see linkchecker --help, and for more information the manual pages linkchecker(1) and linkcheckerrc(5).

Docker usage

If you do not want to install any additional libraries/dependencies you can use the Docker image which is published on GitHub Packages.

Example for external web site check:

docker run --rm -it -u $(id -u):$(id -g) ghcr.io/linkchecker/linkchecker:latest --verbose https://www.example.com

Local HTML file check:

docker run --rm -it -u $(id -u):$(id -g) -v "$PWD":/mnt ghcr.io/linkchecker/linkchecker:latest --verbose index.html

In addition to the rolling latest image, uniquely tagged images can also be found on the packages page.