Getting started
Installation
Thank you for purchasing the Notifications 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].
In this guide I'll show you how to install the plugin, so you can start using it right away.
Prerequisites
For these installation instructions to work, you'll need to have the Filament Panels package installed and configured.
The package is supported on Filament V3, V4 and V5; and Laravel 10 or higher (with earlier versions available since Laravel 8). Please be aware though that support for security fixes for Laravel 10 ends within a few months.
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-notificationsIf 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 ^2.0 instead:
composer require ralphjsmit/laravel-filament-notifications:^2.0If you are installing the package in a Filament V2 installation, you should require the version ^1.0 instead:
composer require ralphjsmit/laravel-filament-notifications:^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.
Publish and migrate
Next, you'll need to publish the migration and the config file, and migrate the database:
php artisan vendor:publish --tag="filament-notifications-migrations"
php artisan vendor:publish --tag="filament-notifications-config"
php artisan migrateIf you are using a custom theme, the package will work out-of-the-box without any necessary changes.
Replace the Notifiable trait
Next, you need to replace the default Notifiable trait with the FilamentNotifiable trait. You should do this on your User model and on every other model that you want to send notifications to.
<?php
namespace App\Models;
use Illuminate\Database\Eloquent\Model;
use RalphJSmit\Filament\Notifications\Concerns\FilamentNotifiable;
class User extends Model
{
use FilamentNotifiable;
// ..
}Register the plugin
Finally, register the plugin in each of the Filament panels that you have in your project and would like to use the package in:
use RalphJSmit\Filament\Notifications\FilamentNotifications;
$panel
->plugin(FilamentNotifications::make())Publishing translations
If wanted, you can publish the translations using the following command:
php artisan vendor:publish --tag="filament-notifications-translations"Deployment environments
If you want to install the package 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_NOTIFICATIONS_USERNAME }} ${{ secrets.FILAMENT_NOTIFICATIONS_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_NOTIFICATIONS_USERNAME | Your e-mail |
| FILAMENT_NOTIFICATIONS_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.