check links in web documents or full websites
Find a file
Chris Mayo 80763ed1ea Add slack to the list of ignored schemes
slack:// is a way to interact with a local Slack client [1], and is not
something that LinkChecker can check.

[1] https://api.slack.com/reference/deep-linking#client
2020-08-09 17:10:26 +01:00
.github add github issue template 2018-03-26 09:35:43 -04:00
cgi-bin Update references to GitHub project from wummel to linkchecker 2019-04-18 19:59:52 +01:00
config Improve authentication comments in template linkcheckerrc 2020-06-23 17:28:31 +01:00
doc Update Mac installation instructions with Homebrew pip and macOS 2020-07-06 19:41:51 +01:00
linkcheck Add slack to the list of ignored schemes 2020-08-09 17:10:26 +01:00
po Update translation files for MS link in configuration/confparse.py 2020-06-19 16:44:18 +01:00
scripts Add slack to the list of ignored schemes 2020-08-09 17:10:26 +01:00
tests Add a test for the LocationInfo plugin 2020-07-07 17:25:28 +01:00
windows Remove home-cooked htmlparser and use BeautifulSoup 2019-07-22 19:59:37 +01:00
.gitattributes Add .gitattributes 2013-12-04 20:04:34 +01:00
.gitignore Add check-manifest to CI 2020-05-25 19:33:17 +03:00
.project Add Eclipse Pydev project files. 2011-05-18 21:12:18 +02:00
.pydevproject Updated pydev settings. 2011-12-17 19:13:43 +01:00
.travis.yml Add a test for the LocationInfo plugin 2020-07-07 17:25:28 +01:00
CODE_OF_CONDUCT.md split code of conduct and contributing guidelines in two 2018-03-26 09:35:01 -04:00
CONTRIBUTING.md Rename .mdwn files to .md 2020-05-22 19:43:57 +01:00
COPYING Moved some files into the doc/ subdirectory. 2010-03-06 21:52:25 +01:00
dev-requirements.txt Enable https checking using a test server 2019-11-11 20:12:25 +00:00
Dockerfile use python3 in readme and dockerfile 2020-05-09 08:03:23 -04:00
install-rpm.sh Fix RPM installer generation. 2012-04-11 18:41:34 +02:00
linkchecker Update GNOME proxy support for GNOME 3 and Python 3 2020-06-05 16:29:45 +01:00
Makefile Remove MANIFEST build logic from the Makefile 2020-05-25 19:33:10 +03:00
MANIFEST.in Remove unused updater code that supports linkchecker-gui 2020-06-05 16:05:25 +01:00
pytest.ini Move some pytest options into pytest.ini 2019-10-21 17:42:29 +03:00
README.rst Don't recommend sudo for pip 2020-06-01 19:48:26 +01:00
requirements.txt Remove use of the future package 2020-04-15 19:49:16 +01:00
robots.txt Add non-ascii values to test robots.txt 2008-07-13 13:01:59 +00:00
setup.cfg Add slack to the list of ignored schemes 2020-08-09 17:10:26 +01:00
setup.py Merge pull request #420 from cjmayo/dconf 2020-06-14 18:56:19 +01:00
tox.ini Add a test for the LocationInfo plugin 2020-07-07 17:25:28 +01:00

LinkChecker
============

|Build Status|_ |License|_

.. |Build Status| image:: https://travis-ci.com/linkchecker/linkchecker.svg?branch=master
.. _Build Status: https://travis-ci.com/linkchecker/linkchecker
.. |License| image:: https://img.shields.io/badge/license-GPL2-d49a6a.svg
.. _License: https://opensource.org/licenses/GPL-2.0

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:

.. _doc/install.txt: doc/install.txt

Python 3.5 or later is needed.

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>`_.

Windows builds are seriously lagging behind the Linux releases, see `#53 <https://github.com/linkchecker/linkchecker/issues/53>`_ for details. For now, the only two options are to install from source or use `Docker for Windows <https://www.docker.com/docker-windows>`_.

Usage
------
Execute ``linkchecker https://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://www.example.com

Local HTML file check::

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