Skip to main content

ftw.linkchecker

Project description

ftw.linkchecker

Introduction

It’s important, that this package isn’t started by conjob in non productive deployments. This is due to the fact, that the command is started by a zope ctl command.

Compatibility

Plone 4.3.x

Installation

  • Add the package to your buildout configuration:
[instance]
eggs +=
    ...
    ftw.linkchecker

One needs to add a config file (e.g. linkchecker_config.json) holding:

  • portal path (unique identifier of the platform)
  • emails of the platforms administrator (the ones who gets the report)
  • base URI (domain where the platform is configured)
  • timeout in seconds (how long the script waits for each external link before continuing if the page does not respond).
  • upload_location can be left empty. It is the path to a file listing block where the report will be uploaded.
{
  "/portal/path-one": {
    "email": ["first_site_admin@example.com", "first_site_keeper@example.com"],
    "base_uri": "http://example1.ch",
    "timeout_config": "1",
    "upload_location": "/content_page/my_file_listing_block"
  },
  "/portal/path-two": {
    "email": ["second_site_admin@example.com"],
    "base_uri": "http://example2.ch",
    "timeout_config": "1"
  }
}

Usage

The linkchecker can be started with (–log logpath optional):

bin/instance check_links --config path/to/config/file.json --log path/to/logfile.log

Development

  1. Fork this repo
  2. Clone your fork
  3. Shell: ln -s development.cfg buildout.cfg
  4. Shell: python bootstrap.py
  5. Shell: bin/buildout

Run bin/test to test your changes.

Or start an instance by running bin/instance fg.

1.3.2 (2019-10-15)

  • Add logger to mailer and ensure utf-8 when logging. [busykoala]

1.3.1 (2019-09-11)

  • Log and make requests with link utf-8 encoded. [busykoala]
  • Extend LinkObject table attributes so autofilter covers all columns. [busykoala]

1.3.0 (2019-09-10)

  • Replace workflow with review_state in the report. [busykoala]

1.2.0 (2019-09-10)

  • Add the links source objs workflow or its parents to report. [busykoala]
  • Remove duplicate “Introduction” header in readme [Nachtalb]

1.1.1 (2019-08-13)

  • Improve logging. [busykoala]
  • Check if report upload location exists, otherwise log and continue to next page. [busykoala]
  • Check if pages exist, otherwise exit linkchecker. [busykoala]
  • Check if there is a config path before checking if it’s valid. [busykoala]

1.1.0 (2019-08-08)

  • Allow multiple notified email addresses per site. The string in the config file is a list of strings now. [busykoala]

1.0.1 (2019-08-05)

  • Fix version conflict in test packages. [busykoala]

1.0.0 (2019-08-02)

  • Initial implementation.

Download files

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

Files for ftw.linkchecker, version 1.3.2
Filename, size File type Python version Upload date Hashes
Filename, size ftw.linkchecker-1.3.2.tar.gz (35.2 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page