Getting started
Installation
Thank you for purchasing the Record Finder Pro plugin for Filament!
We tried to make the plugin as easy-to-install and versatile as possible. Nevertheless, if you still have a question or a feature request, please send an e-mail to [email protected].
Prerequisites
Before starting the further installation, you should have Filament Forms and/or Panels installed.
The package is supported on Laravel 10 or higher (with earlier versions available since Laravel 8) and supports Filament V3, V4 and V5.
Installation
Add Composer repository
Run the following command to add the private Composer repository:
composer config 'repositories.ralphjsmit/*' composer https://satis.ralphjsmit.comThe end result should look something like this:
"repositories": [
{
"type": "composer",
"url": "https://satis.ralphjsmit.com"
}
]Require the package
Next, run the following command to require the package:
composer require ralphjsmit/laravel-filament-record-finderIf you receive a question to allow the plugin to run code, select yes. Next, you will be prompted for your username (which is your e-mail) and your password (which is your license key, e.g. 8c21df8f-6273-4932-b4ba-8bcc723ef500).
If you are installing the package in a Filament V3 installation, you should require the version ^1.0 instead:
composer require ralphjsmit/laravel-filament-record-finder:^1.0Composer will ask if you want to store your credentials in your global auth.json.
If you want to store the credentials per project and not globally, run the following command to create an auth.json file in the root of your project instead:
composer config http-basic.satis.ralphjsmit.com {your_username} {your_password}(Make sure not to commit the auth.json file by adding it to your .gitignore file.)
If you have a Solo-license and are getting a 403 error, then you probably have run out of device activations. Each new server/laptop/device counts as one activation. Check your license email for the link to remove existing activations or upgrade your license.
Add to custom theme
For all panels that you want to use the package in, make sure that you have created a Filament custom theme. Next, for each theme, you need to add the following line to the theme.css file:
@source '../../../../vendor/ralphjsmit/laravel-filament-record-finder/resources/**/*.blade.php';If you are using the plugin outside a panel, then make sure to include the above line in the CSS file that is used to generate the CSS for the Livewire components where you will use the Record Finder component in.
Register the plugin
The Filament Record Finder package works in all forms, irrespective of whether you also have a Filament panel or not. This means that you can nicely include the Record Finder in your app, anywhere you want and wherever you have a Filament form.
If you do decide to use the Filament Record Finder package in a panel, then you should register the plugin in each of the $panel providers that you want to use the plugin in:
use RalphJSmit\Filament\RecordFinder\FilamentRecordFinder;
$panel
->plugin(FilamentRecordFinder::make())There currently are no configuration methods on the plugin itself. However, it is best practice in Filament to register plugins in the panels that a plugin is used in. Also, if it ever becomes necessary in the future to add per-panel configuration methods to the plugin, then I will be able to do so without needing a breaking change.
Publishing translations
If wanted, you can publish the translations using the following command:
php artisan vendor:publish --tag="filament-record-finder-translations"Deployment environments
If you want to install the Record Finder during your GitHub Actions workflow, you can add the following line to your workflow file just before the composer install command:
composer config http-basic.satis.ralphjsmit.com ${{ secrets.FILAMENT_RECORD_FINDER_USERNAME }} ${{ secrets.FILAMENT_RECORD_FINDER_PASSWORD }}
composer install --no-interaction --prefer-dist --no-devNext, add the following two GitHub Actions secrets to your repository (Settings > Secrets and variables > Actions > New repository secret):
| Secret | Value |
|---|---|
| FILAMENT_RECORD_FINDER_USERNAME | Your e-mail |
| FILAMENT_RECORD_FINDER_PASSWORD | Your license key |
As Laravel Cloud does not support a global auth.json or a UI-based way to add private package credentials, the current solution is to add the following line to your deployment script, replacing {username} and {password} with your actual credentials:
composer config http-basic.satis.ralphjsmit.com {username} {password}
composer install --no-devInstalling on Laravel Forge can be done in two ways. The simplest way is on first deploy to SSH to your server, run composer install, enter the required credentials and select yes when asked to save them in the global auth.json file. The other option is to go to {server} > PHP > Composer > Add credential in Forge. Here, enter the following details:
- Repository:
satis.ralphjsmit.com(note: do not prefix with https://) - Username: which is your e-mail
- Password: which is your license key
Changing the email associated with your license key
If you need to change the email associated with your license key, please send an e-mail to [email protected].
Changelog
You can view the changelog and/or subscribe for email updates on the Filament Plugins page. You can sign in using your license e-mail and a magic link, after which you can go to your plugin, click on the Gear icon > Changelog.