Getting started

Installation

Install LaraBeacon as a development dependency. It runs from your application and should be part of the same code and configuration review as your test suite.

1. Require LaraBeacon Core

composer require --dev baer-software/larabeacon:^3.0

The package service provider is discovered automatically by Laravel.

2. Publish the configuration

php artisan vendor:publish --tag=larabeacon

This creates config/larabeacon.php. Commit that file so analyzer selection and baselines are reviewed with the rest of your application.

3. Run your first scan

php artisan larabeacon --details

Some analyzers inspect the effective runtime environment. Run a second scan in a production-like environment when you need configuration, HTTP-header, queue, cache, or infrastructure evidence.

4. Add Pro to a licensed project

LaraBeacon Pro is distributed through the authenticated Composer repository in LaraBeacon Cloud. Create a licensed project, copy its one-time API token, and configure HTTP Basic authentication for larabeacon.com. Keep Composer’s auth.json out of version control and use protected secrets in CI.

composer config --auth http-basic.larabeacon.com YOUR_PROJECT_USERNAME YOUR_PROJECT_TOKEN
composer config repositories.larabeacon-pro composer https://larabeacon.com/api/composer
composer require --dev baer-software/larabeacon-pro:^1.0

The private repository serves only the released Pro archive and verifies its release checksum before every download. The same project credential is used for optional Cloud reports.