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
|
|
|
|
2021-06-17 10:47:05 +00:00
|
|
|
.. |Build Status| image:: https://github.com/linkchecker/linkchecker/actions/workflows/build.yml/badge.svg?branch=master
|
|
|
|
|
.. _Build Status: https://github.com/linkchecker/linkchecker/actions/workflows/build.yml
|
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
|
2023-08-28 18:24:57 +00:00
|
|
|
- HTTP/1.1, HTTPS, FTP, mailto: and local file links support
|
2014-06-11 20:44:57 +00:00
|
|
|
- restrict link checking with regular expression filters for URLs
|
|
|
|
|
- proxy support
|
2023-08-28 18:24:57 +00:00
|
|
|
- username/password authorization for HTTP and FTP
|
2014-06-11 20:44:57 +00:00
|
|
|
- honors robots.txt exclusion protocol
|
|
|
|
|
- Cookie support
|
|
|
|
|
- HTML5 support
|
2016-01-23 12:28:15 +00:00
|
|
|
- a command line and web interface
|
2021-11-29 19:35:34 +00:00
|
|
|
- various check plugins available
|
2014-06-11 20:44:57 +00:00
|
|
|
|
|
|
|
|
Installation
|
|
|
|
|
-------------
|
2018-06-22 13:54:36 +00:00
|
|
|
|
2023-11-27 19:22:08 +00:00
|
|
|
Python 3.9 or later is needed. Using pip to install LinkChecker:
|
2018-11-28 14:42:56 +00:00
|
|
|
|
2021-11-22 19:30:33 +00:00
|
|
|
``pip3 install linkchecker``
|
|
|
|
|
|
2023-05-01 18:24:55 +00:00
|
|
|
pipx can also be used to install LinkChecker.
|
|
|
|
|
|
2021-11-22 19:30:33 +00:00
|
|
|
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.
|
2018-06-22 13:54:36 +00:00
|
|
|
|
2022-02-22 19:35:04 +00:00
|
|
|
.. _doc/install.txt: https://linkchecker.github.io/linkchecker/install.html
|
2014-06-11 20:44:57 +00:00
|
|
|
|
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``.
|
2021-12-01 19:43:07 +00:00
|
|
|
For other options see ``linkchecker --help``, and for more information the
|
|
|
|
|
manual pages `linkchecker(1)`_ and `linkcheckerrc(5)`_.
|
|
|
|
|
|
|
|
|
|
.. _linkchecker(1): https://linkchecker.github.io/linkchecker/man/linkchecker.html
|
|
|
|
|
|
|
|
|
|
.. _linkcheckerrc(5): https://linkchecker.github.io/linkchecker/man/linkcheckerrc.html
|
2018-03-25 08:55:22 +00:00
|
|
|
|
|
|
|
|
Docker usage
|
|
|
|
|
-------------
|
|
|
|
|
|
2021-12-01 19:43:07 +00:00
|
|
|
If you do not want to install any additional libraries/dependencies you can use
|
|
|
|
|
the Docker image which is published on GitHub Packages.
|
2018-03-25 08:55:22 +00:00
|
|
|
|
2020-06-01 15:23:33 +00:00
|
|
|
Example for external web site check::
|
2018-03-25 08:55:22 +00:00
|
|
|
|
2021-11-28 18:55:46 +00:00
|
|
|
docker run --rm -it -u $(id -u):$(id -g) ghcr.io/linkchecker/linkchecker:latest --verbose https://www.example.com
|
2020-06-01 15:23:33 +00:00
|
|
|
|
|
|
|
|
Local HTML file check::
|
|
|
|
|
|
2021-11-28 18:55:46 +00:00
|
|
|
docker run --rm -it -u $(id -u):$(id -g) -v "$PWD":/mnt ghcr.io/linkchecker/linkchecker:latest --verbose index.html
|
2021-11-29 19:28:47 +00:00
|
|
|
|
|
|
|
|
In addition to the rolling latest image, uniquely tagged images can also be found
|
|
|
|
|
on the `packages`_ page.
|
|
|
|
|
|
|
|
|
|
.. _packages: https://github.com/linkchecker/linkchecker/pkgs/container/linkchecker
|
