@fabernovel/heart-observatory

Heart Observatory

Heart Observatory is an analysis module of Heart, which analyses URLs with Mozilla Observatory.

Read more about the purpose, design and general installation of Heart.

Package manager

In the following sections, every examples are using NPM as package manager, but you can use any other you prefer: Yarn, pnpm...

Installation

1. Add the package to your project:

   npm install @fabernovel/heart-observatory
   

2. Add Heart CLI if you have not already installed it

   npm install @fabernovel/heart-cli
   

3. [Optional] Customize the Mozilla Observatory scanner

   By default, the scanner used is the public one, but you can use your own: from a local codebase or with Docker.

   In this case, you must provide the following env values:

   OBSERVATORY_API_URL=
   OBSERVATORY_ANALYZE_URL=
   

Usage

Analysis setup

The analysis setup must use the JSON format, and follow the Invoke assessment API Documentation.

Example:

{
  "host": "heart.fabernovel.com",
  "hidden": true
}

Example

Using Heart CLI, starting an Observatory analysis of https://heart.fabernovel.com could look like that:

npx heart observatory --inline '{"host": "heart.fabernovel.com"}'