Description
Heart Observatory is an analysis module of Heart, which analyses URLs with Mozilla Observatory.
Read more about the description and design of Heart.
Usage
Standalone
-
Install the package and Heart CLI
npm install @fabernovel/heart-cli @fabernovel/heart-observatory
-
[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:
HEART_OBSERVATORY_API_URL=
HEART_OBSERVATORY_ANALYZE_URL=
-
Start an analysis
npx heart observatory --config '{"host": "heart.fabernovel.com"}'
OR
npx heart observatory --file configuration.json
The analysis configuration follows the JSON format and the Invoke assessment API Documentation.
Github Action
If you're using Github, you can simplify the integration of Heart in your CI scripts by using the Github Action.