dcentrica / metaport-agent-php
Metaport PHP Agent
Requires
- php: ^8
- cyclonedx/cyclonedx-library: ^2.2
- guzzlehttp/guzzle: ^7.7
- linfo/linfo: ^4.0
- paragonie/halite: ^5.1
- symfony/http-foundation: ^6
- symfony/mailer: ^6.4
- symfony/swiftmailer-bundle: ^2.3
- t4web/composer-lock-parser: ^1.2
Requires (Dev)
- phpunit/phpunit: ^10
This package is auto-updated.
Last update: 2024-11-07 02:10:17 UTC
README
What is this?
A client library which connects any PHP app to a Metaport server using the CycloneDX SBOM standard for data interchange.
How to use
Introduction
The library 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.
The library provides a single executable metaport which is automatically installed into Composer's vendor/bin directory. 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
This package requires PHP ^8. If used as part of a CI/CD setup, it can be installed as a throwaway dependency via Composer's require-dev argument or as a permanent dependency of your PHP application.
Install
- Composer
In "disposable" CI pipelines and jobs:
composer require-dev dcentrica/metaport-agent-php
As part of production apps:
composer require dcentrica/metaport-agent-php
- Environment Variables
There are some environment variables which need to be set before the lib will operate correctly. Please see the docs site for more detailed installation and configuration instructions and examples.
Supported Frameworks and CMS's
Yours not listed? Contributions are very welcome. Please file an issue and issue a Merge Request, it's a one-line file change!