2014-06-11 20:44:57 +00:00
LinkChecker
============
2017-11-10 13:26:13 +00:00
|Build Status|_ |License|_
2014-07-01 17:56:50 +00:00
2020-03-31 10:08:51 +00:00
.. |Build Status| image :: https://travis-ci.com/linkchecker/linkchecker.svg?branch=master
.. _Build Status: https://travis-ci.com/linkchecker/linkchecker
2020-05-26 08:31:28 +00:00
.. |License| image :: https://img.shields.io/badge/license-GPL2-d49a6a.svg
.. _License: https://opensource.org/licenses/GPL-2.0
2014-06-11 20:44:57 +00:00
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
2016-01-23 12:28:15 +00:00
- a command line and web interface
2014-06-11 20:44:57 +00:00
- various check plugins available, eg. HTML syntax and antivirus checks.
Installation
-------------
2018-06-22 13:54:36 +00:00
2018-11-28 14:42:56 +00:00
See `doc/install.txt`_ in the source code archive for general information. Except the given information there, please take note of the following:
.. _doc/install.txt: doc/install.txt
2018-06-22 13:54:36 +00:00
2020-09-14 18:55:05 +00:00
Python 3.6 or later is needed.
2014-06-11 20:44:57 +00:00
2020-06-01 18:48:26 +00:00
The version in the pip repository is old. Instead, you can use pip to install the latest release from git: `` pip3 install git+https://github.com/linkchecker/linkchecker.git `` . See `#359 <https://github.com/linkchecker/linkchecker/issues/359> `_ .
2017-11-10 13:26:13 +00:00
2014-06-11 20:44:57 +00:00
Usage
------
2020-06-01 15:23:33 +00:00
Execute `` linkchecker https://www.example.com `` .
2014-06-11 20:44:57 +00:00
For other options see `` linkchecker --help `` .
2018-03-25 08:55:22 +00:00
Docker usage
-------------
2020-08-23 16:24:09 +00:00
*The Docker images are out-of-date, pip installation is the only currently recommended method.*
2018-03-25 08:55:22 +00:00
If you do not want to install any additional libraries/dependencies you can use the Docker image.
2020-06-01 15:23:33 +00:00
Example for external web site check::
2018-03-25 08:55:22 +00:00
2020-06-01 15:23:33 +00:00
docker run --rm -it -u $(id -u):$(id -g) linkchecker/linkchecker --verbose https://www.example.com
Local HTML file check::
docker run --rm -it -u $(id -u):$(id -g) -v "$PWD":/mnt linkchecker/linkchecker --verbose index.html
