Skip to main content

Liches a server for linkchecker results

Project description


In fantasy fiction, a lich is a type of undead creature. (wikipedia_)
Liches is used to find dead links in your website so I thought this name
was appropriate (and a nicer explanation than liches stands for LInk Checker

Liches wraps the linkchecker_ output into a web interface.
You can run Liches as a stand-alone service for use with your websites
regardless of the language they're written in. While Liches itself is
written in Python, it interacts with your website purely via HTTP and
JSON_. You can even integrate it with pure javascript without the need of
server side programming or use it as a stand alone service.
An example how to integrate it into a website can be found at


While linkchecker_ itself can produce html this results in a single
monolithic page with all results included. This can be intimidating
and is from a usability point of view suboptimal. Liches presents
the results agregated per page, so you get a quick overview of how
many pages in your site have broken links and for each page an overview
which links are broken. You can also filter the results for a specific
error message so you can narrow down and prioritize which errors to deal
with first.

You can configure your linkchecks and invoke linkchecker through the



It is strongly recommended to install Liches in a virtualenv_


$ mkdir liches
$ virtualenv --no-site-packages liches/
$ cd liches/

In this virtualenv you can install liches for production
or development.

Install for production

In the virtualenv you created above execute these commands


$ wget
$ xz -d LinkChecker-8.4.tar.xz
$ bin/pip install LinkChecker-8.4.tar
$ bin/pip install liches
$ wget
$ bin/initialize_liches_db production.ini
Username [admin]:
Password [generate]:
('password generated: ', 'whmgfi6r')
Fullname: Administrator
Email: root@localhost
$ bin/pserve production.ini

Username and password are written to the file 'password.txt'. Delete this
file after installation.

Install for development

In the virtualenv you created above execute these commands:


$ wget
$ mkdir buildout-cache
$ mkdir buildout-cache/eggs
$ mkdir buildout-cache/downloads
$ bin/easy_install -u setuptools
$ wget
$ bin/python
$ bin/buildout
$ rm buildout.cfg
$ ln -s src/liches/buildout.cfg
$ ln -s src/liches/development.ini
$ bin/initialize_liches_db development.ini
Username [admin]:
Password [generate]:
('password generated: ', 'whmgfi6r')
Fullname: Administrator
Email: root@localhost
$ bin/pserve development.ini

Username and password are written to the file 'password.txt', so you do
not have to input these values every time you reinitialize your database.


You configure you liches server in you production.ini or development.ini


In the `[app:main]` section of you configuration file change the sqlalchemy.url_
to point to your database (or leave it like it is if you want to use sqllite)

.. _sqlalchemy.url:


To enable a website to request a linkcheck of a particular page you have
to provide an `api_key` in the `[liches]` section of your ini file. If this
parameter is not set liches will generate a random key every time it is
started. The generated key will be displayed during startup.


2013-08-05 17:16:01,085 WARNI [liches.utils][MainThread] API Key: w4NhYBHSVGzfmpiK

As the generated key is reasonably unique and complicated you may copy
it into your ini file.

Getting Started

Define your linkchecks in the web GUI or alternatively import linkchecks
from the commandline.


Open your Liches server in your webbrowser.

.. image::

Log into your liches server.

.. image::

Goto linkchecks.

.. image::

and add a new linkcheck.

.. image::

On the commandline you can then call:


$ bin/liches_linkchecker development.ini

This command will call linkchecker_ for all the checks you have enabled
and import the results into the database. For regular linkchecks you can
call this command as a cron job.

Manual Import
Check a site for bad links with e.g:


$ bin/linkchecker --file-output=csv --pause=3 --no-warnings http://localhost/index.html

Please refer to the linkchecker_ manual for usage.

Import the output produced by linkchecker_ into liches


$ bin/import_liches_csv production.ini

View the results

Open `http://localhost:6543/` in your browser to see the results. The
frontpage tells you how many pages with broken urls are in your site.
Click on the link *'You have XYZ pages with broken links'* to view the
pages at `http://localhost:6543/getpages`.

At `http://localhost:6543/getpages?format=json` you can access the data
in JSON_ format.

.. image::

The links will take you to a page with detailed results for this page e.g.
which can also be accessed as JSON_

.. image::

.. _linkchecker:
.. _virtualenv:
.. _JSON:
.. _wikipedia:


0.7 (2013/11/28)

- remove linkchecker dependency so you can `pip install -U liches`
- pyramid 1.5 compatible (if you are using pyramid < 1.5 use liches 0.6)

0.6 (2013/11/28)

- add ability to invoke linkchecker in the webinterface
- add a broken links count to each page in overview

0.5 (2013/08/29)

- add ability to show invalid pages only
- inititialize_liches_db writes a file 'password.txt' with user:password

0.4 (2013/08/12)

- bug fixes
- add ability to filter pages by error

0.3 (2013/08/07)

- add script to check all linkchecks
- add linkcheck contenttype
- add authentication
- add form to change password
- add user add form

0.2 (2013/07/31)

- Add script to empty db
- fixes
- more documentation
- add license

0.1 (2013/07/31)

- Initial version

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

liches-0.7.tar.gz (65.7 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page