Sign inSign up

eeacms/garie-linksintegrity

By eeacms

•Updated 3 months ago

Custom docker image for garie-linksintegrity plugin

Image
0

6.4K

eeacms/garie-linksintegrity repository overview

⁠Garie linksintegrity plugin

Tool to gather linkchecker metrics and supports CRON jobs.

Highlights

  • Poll for linkchecker⁠ statistics on any website and stores the data into InfluxDB
  • View all historic linkchecker reports.
  • Setup within minutes

⁠Overview of garie-linksintegrity

Garie-linksintegrity was developed as a plugin for the Garie⁠ Architecture.

Garie⁠ is an out the box web performance toolkit, and garie-linksintegrity is a plugin that generates and stores linkchecker⁠ data into InfluxDB.

Garie-linksintegrity can also be run outside the Garie environment and run as standalone.

If your interested in an out the box solution that supports multiple performance tools like lighthouse, google-speed-insight and web-page-test then checkout Garie⁠.

If you want to run garie-linksintegrity standalone you can find out how below.

⁠Getting Started

⁠Prerequisites
  • Docker installed
⁠Running garie-linksintegrity

You can get setup with the basics in a few minutes.

First clone the repo.

git clone https://github.com/eea/garie-linksintegrity.git

Next setup you're config. Edit the config.json and add websites to the list.

{
  "plugins":{
        "linksintegrity":{
            "cron": "0 */4 * * *"
        }
    },
  "urls": [
    {
      "url": "https://www.eea.europa.eu/",
      "plugins": {
        "linksintegrity":{
            "recursion_depth":1
        }
      }
    },
    {
      "url": "https://biodiversity.europa.eu/",
      "plugins": {
        "linksintegrity":{
            "recursion_depth":1
        }
      }
    }
  ]
}

Once you finished edited your config, lets setup our environment.

docker-compose up

This will run the application.

On start garie-linkchecker will start to gather statistics for the websites added to the config.json.

⁠config.json

PropertyTypeDescription
plugins.linksintegrity.cronstring (optional)Cron timer. Supports syntax can be found [here].(https://www.npmjs.com/package/cron⁠)
plugins.linksintegrity.retryobject (optional)Configuration how to retry the failed tasks
plugins.linksintegrity.retry.afternumber (optional, default 30)Minutes before we retry to execute the tasks
plugins.linksintegrity.retry.timesnumber (optional, default 3)How many time to retry to execute the failed tasks
plugins.linksintegrity.retry.timeRangenumber (optional, default 360)Period in minutes to be checked in influx, to know if a task failed
plugins.linksintegrity.max_age_of_report_filesnumber (optional, default 365)Maximum age (in days) for all the files. Any older file will be deleted.
plugins.linksintegrity.delete_files_by_typeobject (optional, no default)Configuration for deletion of custom files. (e.g. mp4 files)
plugins.linksintegrity.delete_files_by_type.typestring (required for 'delete_files_by_type')The type / extension of the files we want to delete. (e.g. "mp4").
plugins.linksintegrity.delete_files_by_type.agenumber (required for 'delete_files_by_type')Maximum age (in days) of the custom files. Any older file will be deleted.
urlsobject (required)Config for lighthouse. More detail below

urls object

PropertyTypeDescription
urlstring (required)Url to get linksintegrity statistics for.
pluginsobject (optional)To setup custom configurations.
plugins.linksintegrityobject (required)To setup custom lighthouse config.
plugins.linksintegrity.recursion_depthnumber (optional)If not set, the default 1 will be used.

For more information please go to the garie-plugin⁠ repo.

Tag summary

Content type

Image

Digest

sha256:06b279e75…

Size

486.5 MB

Last updated

3 months ago

docker pull eeacms/garie-linksintegrity