Broker is the bridge between FOSSA and internal projects.
FOSSA users use Broker to scan local projects, importing them into the FOSSA service (including FOSSA in the cloud) without sharing access to the source code of the project.
Have a question not answered in the docs? Check the FAQ or send us a support request via support.fossa.com!
Most modern systems can run Broker with no issues. For a more detailed look at system requirements, see the system requirements reference.
- To install Broker on your local system, see install Broker locally
- To run Broker in Kubernetes, see install Broker in Kubernetes
The Broker config file tells Broker about the repositories it should scan, how it can access them, and at what cadence. See the config reference for more details.
Initialize an empty configuration file and database.
For more information, see the init subcommand documentation.
Diagnose possible issues in the local runtime environment that may be preventing Broker from scanning projects and sending their metadata to FOSSA.
For more information, see the fix subcommand documentation.
Boots Broker using the local config file, scanning the projects on configured DevOps hosts and importing their metadata into FOSSA.
For more information, see the run subcommand documentation.