Sign inSign up

eeacms/garie-ssllabs

By eeacms

•Updated 3 months ago

Garie plugin for ssllabs

Image
0

7.9K

eeacms/garie-ssllabs repository overview

⁠Garie ssllabs plugin

Tool to gather ssllabs metrics and supports CRON jobs.

MIT

Highlights

  • Poll for ssllabs performance metrics on any website and stores the data into InfluxDB
  • Generates web performance videos
  • View all historic reports.
  • Setup within minutes

⁠Overview of garie-ssllabs

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

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

Garie-ssllabs 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 ssllabs, google-speed-insight and lighthouse then checkout Garie⁠.

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

⁠Getting Started

⁠Prerequisites
  • Docker installed
⁠Running garie-ssllabs

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

First clone the repo.

git clone [email protected]:eea/garie-ssllabs.git

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

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

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

docker-compose up

This will build your copy of garie-ssllabs and run the application.

On start garie-ssllabs will start to gather performance metrics for the websites added to the config.json.

⁠config.json

PropertyTypeDescription
plugins.sslabs.cronstring (optional)Cron timer. Supports syntax can be found [here].(https://www.npmjs.com/package/cron⁠)
plugins.sslabs.retryobject (optional)Configuration how to retry the failed tasks
plugins.sslabs.retry.afternumber (optional, default 30)Minutes before we retry to execute the tasks
plugins.sslabs.retry.timesnumber (optional, default 3)How many time to retry to execute the failed tasks
plugins.sslabs.retry.timeRangenumber (optional, default 360)Period in minutes to be checked in influx, to know if a task failed
plugins.sslabs.max_age_of_report_filesnumber (optional, default 365)Maximum age (in days) for all the files. Any older file will be deleted.
plugins.sslabs.delete_files_by_typeobject (optional, no default)Configuration for deletion of custom files. (e.g. mp4 files)
plugins.sslabs.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.sslabs.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 ssllabs metrics for.

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

Tag summary

Content type

Image

Digest

sha256:61d29cb16…

Size

448.9 MB

Last updated

3 months ago

docker pull eeacms/garie-ssllabs