{"id":19618598,"url":"https://github.com/cleder/liches","last_synced_at":"2026-05-15T15:32:47.301Z","repository":{"id":9730322,"uuid":"11689069","full_name":"cleder/liches","owner":"cleder","description":"A server for linkchecker","archived":false,"fork":false,"pushed_at":"2022-10-27T08:06:37.000Z","size":168,"stargazers_count":0,"open_issues_count":2,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2026-02-13T09:02:44.033Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cleder.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGES.txt","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2013-07-26T15:43:44.000Z","updated_at":"2022-10-27T08:05:28.000Z","dependencies_parsed_at":"2022-09-02T08:24:21.408Z","dependency_job_id":null,"html_url":"https://github.com/cleder/liches","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/cleder/liches","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cleder%2Fliches","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cleder%2Fliches/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cleder%2Fliches/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cleder%2Fliches/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cleder","download_url":"https://codeload.github.com/cleder/liches/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cleder%2Fliches/sbom","scorecard":{"id":291162,"data":{"date":"2025-08-11","repo":{"name":"github.com/cleder/liches","commit":"f37c76070ce7a28ef162a20d404a91e728a6f718"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.1,"checks":[{"name":"Code-Review","score":0,"reason":"Found 1/30 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/semgrep.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/semgrep.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/cleder/liches/semgrep.yml/master?enable=pin","Info:   0 out of   1 GitHub-owned GitHubAction dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"License","score":0,"reason":"license file not detected","details":["Warn: project does not have a license file"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 1 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-17T18:14:30.732Z","repository_id":9730322,"created_at":"2025-08-17T18:14:30.732Z","updated_at":"2025-08-17T18:14:30.732Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33071118,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-15T11:35:32.926Z","status":"ssl_error","status_checked_at":"2026-05-15T11:35:31.362Z","response_time":103,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-11T11:10:03.732Z","updated_at":"2026-05-15T15:32:47.279Z","avatar_url":"https://github.com/cleder.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"Introduction\n==================\n\nIn fantasy fiction, a lich is a type of undead creature. (wikipedia_)\nLiches is used to find dead links in your website so I thought this name\nwas appropriate (and a nicer explanation than liches stands for LInk Checker\nServer).\n\nLiches wraps the linkchecker_ output into a web interface.\nYou can run Liches as a stand-alone service for use with your websites\nregardless of the language they're written in. While Liches itself is\nwritten in Python, it interacts with your website purely via HTTP and\nJSON_. You can even integrate it with pure javascript without the need of\nserver side programming or use it as a stand alone service.\nAn example how to integrate it into a website can be found at\nhttps://github.com/collective/collective.liches\n\nRational\n--------\n\nWhile linkchecker_ itself can produce html this results in a single\nmonolithic page with all results included. This can be intimidating\nand is from a usability point of view suboptimal. Liches presents\nthe results agregated per page, so you get a quick overview of how\nmany pages in your site have broken links and for each page an overview\nwhich links are broken. You can also filter the results for a specific\nerror message so you can narrow down and prioritize which errors to deal\nwith first.\n\nYou can configure your linkchecks and invoke linkchecker through the\nwebinterface.\n\nInstall\n=======\n\nPrerequisites\n-------------\n\nIt is strongly recommended to install Liches in a virtualenv_\n\n::\n\n    $ mkdir liches\n    $ virtualenv --no-site-packages liches/\n    $ cd liches/\n\nIn this virtualenv you can install liches for production\nor development.\n\nInstall for production\n----------------------\n\nIn the virtualenv you created above execute these commands\n\n::\n\n    $ wget http://github.com/downloads/wummel/linkchecker/LinkChecker-8.4.tar.xz\n    $ xz -d LinkChecker-8.4.tar.xz\n    $ bin/pip install LinkChecker-8.4.tar\n    $ bin/pip install liches\n    $ wget https://raw.github.com/cleder/liches/master/production.ini\n    $ bin/initialize_liches_db production.ini\n    Username [admin]:\n    Password [generate]:\n    ('password generated: ', 'whmgfi6r')\n    Fullname: Administrator\n    Email: root@localhost\n    $ bin/pserve production.ini\n\nUsername and password are written to the file 'password.txt'. Delete this\nfile after installation.\n\nInstall for development\n------------------------\n\nIn the virtualenv you created above execute these commands:\n\n::\n\n    $ wget https://raw.github.com/cleder/liches/master/buildout.cfg\n    $ mkdir buildout-cache\n    $ mkdir buildout-cache/eggs\n    $ mkdir buildout-cache/downloads\n    $ bin/easy_install -u setuptools\n    $ wget http://python-distribute.org/bootstrap.py\n    $ bin/python bootstrap.py\n    $ bin/buildout\n    $ rm buildout.cfg\n    $ ln -s src/liches/buildout.cfg\n    $ ln -s src/liches/development.ini\n    $ bin/initialize_liches_db development.ini\n    Username [admin]:\n    Password [generate]:\n    ('password generated: ', 'whmgfi6r')\n    Fullname: Administrator\n    Email: root@localhost\n    $ bin/pserve development.ini\n\n\nUsername and password are written to the file 'password.txt', so you do\nnot have to input these values every time you reinitialize your database.\n\nConfiguration\n--------------\n\nYou configure you liches server in you production.ini or development.ini\nfile.\n\nDatabase\n+++++++++\n\nIn the `[app:main]` section of you configuration file change the sqlalchemy.url_\nto point to your database (or leave it like it is if you want to use sqllite)\n\n.. _sqlalchemy.url: http://docs.sqlalchemy.org/en/rel_0_8/core/engines.html#database-urls\n\nAPI Key\n++++++++\n\nTo enable a website to request a linkcheck of a particular page you have\nto provide an `api_key` in the `[liches]` section of your ini file. If this\nparameter is not set liches will generate a random key every time it is\nstarted. The generated key will be displayed during startup.\n\n::\n\n    2013-08-05 17:16:01,085 WARNI [liches.utils][MainThread] API Key: w4NhYBHSVGzfmpiK\n\nAs the generated key is reasonably unique and complicated you may copy\nit into your ini file.\n\nGetting Started\n===============\n\nDefine your linkchecks in the web GUI or alternatively import linkchecks\nfrom the commandline.\n\nWeb GUI\n--------\n\nOpen your Liches server in your webbrowser.\n\n.. image:: https://raw.github.com/cleder/liches/master/docs/liches-home-loggedout.png\n\nLog into your liches server.\n\n.. image:: https://raw.github.com/cleder/liches/master/docs/liches-home-loggedin.png\n\nGoto linkchecks.\n\n.. image:: https://raw.github.com/cleder/liches/master/docs/liches-linkchecks.png\n\nand add a new linkcheck.\n\n.. image:: https://raw.github.com/cleder/liches/master/docs/liches-add-linkcheck.png\n\nOn the commandline you can then call:\n\n::\n\n    $ bin/liches_linkchecker development.ini\n\nThis command will call linkchecker_ for all the checks you have enabled\nand import the results into the database. For regular linkchecks you can\ncall this command as a cron job.\n\n\nManual Import\n--------------\nCheck a site for bad links with e.g:\n\n::\n\n    $ bin/linkchecker --file-output=csv --pause=3 --no-warnings http://localhost/index.html\n\nPlease refer to the linkchecker_ manual for usage.\n\nImport the output produced by linkchecker_ into liches\n\n::\n\n    $ bin/import_liches_csv production.ini\n\nView the results\n-----------------\n\nOpen `http://localhost:6543/` in your browser to see the results. The\nfrontpage tells you how many pages with broken urls are in your site.\nClick on the link *'You have XYZ pages with broken links'* to view the\npages at `http://localhost:6543/getpages`.\n\nAt `http://localhost:6543/getpages?format=json` you can access the data\nin JSON_ format.\n\n.. image:: https://raw.github.com/cleder/liches/master/docs/liches-brokenpages.png\n\nThe links will take you to a page with detailed results for this page e.g.\n`http://localhost:6543/checkurl?url=http://localhost/index.html`\nwhich can also be accessed as JSON_\n`http://localhost:6543/checkurl?url=http://localhost/index.html\u0026format=json`\n\n.. image:: https://raw.github.com/cleder/liches/master/docs/liches-brokenlinks.png\n\n.. _linkchecker: http://wummel.github.io/linkchecker/\n.. _virtualenv: http://www.virtualenv.org/\n.. _JSON: http://www.json.org/\n.. _wikipedia: https://en.wikipedia.org/wiki/Lich\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcleder%2Fliches","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcleder%2Fliches","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcleder%2Fliches/lists"}