Extension Check Link


Extension Basics

Title
Check Link
Name
ckanext-check-link
Type
Public extension
Description
Resource URL and link availability checker
CKAN versions

~2.9, ~2.10, ~2.11

Show details
Download-Url (zip)
Download-Url commit date
2024-06-01
Url to repo
Category
Data Management & Quality


Background Infos

Description (long)
Show details

Link checker providing API, CLI, and views for verifying resource and arbitrary URL availability. Features include resource URL checking, arbitrary link verification, check result storage in database, paginated broken link reports, organization/group/user-specific checks, CLI commands for bulk checking (packages, resources), orphan report cleanup, configurable user permissions for link checking, customizable report page URL and base template, and REST API for programmatic access.

Version
0.3.1
Version release date
2024-06-01
Contact name
DataShades / Sergey Motornyuk
Contakt email
Contact Url
(not set)


Installation Guide

Configuration hints

Installation: pip install ckanext-check-link, add ‘check_link collection’ to ckan.plugins (note: requires ckanext-collection), run ‘ckan db pending-migrations –apply’ to create tables. Dependencies: check-link~=0.0.11, typing-extensions, ckanext-toolbelt, ckanext-collection. Configuration: ckanext.check_link.user_can_check_url (default: false) allows logged-in users to check links (security implications), ckanext.check_link.report.base_template (default: /check-link/report/global) for report page URL, ckanext.check_link.report.base_template (default: check_link/base_admin.html) for base template. UI: /check-link/report/global shows paginated broken links (sysadmin only). CLI: ‘ckan check-link check-packages [pkg-id…]’ checks packages (–include-private, –include-draft), ‘ckan check-link check-resources [res-id…]’ checks resources, ‘ckan check-link delete-reports [–orphans-only]’ deletes reports. API: check_link_url_check, check_link_resource_check, check_link_package_check, check_link_organization_check, check_link_group_check, check_link_user_check, check_link_search_check, check_link_report_save/show/search/delete. Use cases: Resource availability monitoring, broken link detection, link health reports, automated link validation.

Plugins to configure (ckan.ini)
check_link collection
CKAN Settings (ckan.ini)
# ckanext.check_link.user_can_check_url = yes # ckanext.check_link.report.base_template = /ckan-admin/link-state
DB migration to be executed
check-link
<< back to Extensions