Skip to content

Latest commit

 

History

History
59 lines (43 loc) · 2.28 KB

README.rst

File metadata and controls

59 lines (43 loc) · 2.28 KB
Raw

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, eg. HTML syntax and antivirus checks.

Installation

See doc/install.txt in the source code archive for general information. Except the given information there, please take note of the following:

Python 2.7.2 or later is needed. It doesn't work with Python 3 yet, see #40 for details.

The version in the pip repository is old. Instead, you can use pip to install the latest release from git: pip install git+https://github.com/linkchecker/[email protected]. See #4.

Windows builds are seriously lagging behind the Linux releases, see #53 for details. For now, the only two options are to install from source or use Docker for Windows.

Usage

Execute linkchecker http://www.example.com. For other options see linkchecker --help.

Docker usage

If you do not want to install any additional libraries/dependencies you can use the Docker image.

Example for external web site check: ` docker run --rm -it -u $(id -u):$(id -g) linkchecker/linkchecker --verbose https://google.com `

Local HTML file check: ` docker run --rm -it -u $(id -u):$(id -g) -v "$PWD":/mnt linkchecker/linkchecker --verbose index.html `