@dcentrica/metaport-agent-nodejs NPM

What is this?

A client library which connects a Javascript app to a Metaport server using the CycloneDX SBOM standard for data interchange.

The agent will automatically generate an SBOM for your app, submit it to Metaport and subsequently delete it. Data can be sent using the HTTP or Email transports. See the docs site for example requests.

If configured correctly, the agent provides a single executable metaport. It's designed to be invoked on a schedule via cron from within an application's production environment or as part of a CI/CD pipeline.

Requirements

nodejs ^18
libsodium23
libtool

Install

npm i @dcentrica/metaport-agent-nodejs

Configuration

Modify your app's package.json "scripts" section as follows:

"scripts": {
  "metaport": "node ./node_modules/@dcentrica/metaport-agent-nodejs/metaport.js"
}

Environment Variables

There are some environment variables which need to be set before the agent will operate correctly. Please see the docs site for more detailed installation and configuration instructions and examples.

Run

This is an example only. Please review the full agent documentation.

npm run metaport -- \
    --transport=http \
    --name='Acme Frontend' \
    --host=metaport.dev \
    --uuid='71caa01c-e724-4db0-acb8-05d7f712bd9c' \
    --domain='foo.com' \
    --env=PROD \
    --version=1.0.0 \
    --auth='bm90aWZpY2F0aW9uc0BhY21lLWV4cGxvc2l2ZXMuY29tOmR1bW15NDu' \
    --classic=1

Supported Frameworks

Metaport will automatically detect and report the following frameworks. Yours not listed? Contributions are very welcome. Please file an issue and issue a Merge Request, it's a one-line file change!