This is the documentation for
v1 but the latest version is
v4
.
You can switch versions in the menu on the left/at the top.
Check your current version with the following command:
composer show spatie/laravel-activitylog
The package can be installed via composer:
composer require spatie/laravel-activitylog
Next, you must install the service provider:
// config/app.php
'providers' => [
...
Spatie\Activitylog\ActivitylogServiceProvider::class,
];
You can publish the migration with:
php artisan vendor:publish --provider="Spatie\Activitylog\ActivitylogServiceProvider" --tag="migrations"
After the migration has been published you can create the activity_log
table by running the migrations:
php artisan migrate
You can optionally publish the config file with:
php artisan vendor:publish --provider="Spatie\Activitylog\ActivitylogServiceProvider" --tag="config"
This is the contents of the published config file:
return [
/*
* When set to false, no activities will be saved to database.
*/
'enabled' => env('ACTIVITY_LOGGER_ENABLED', true),
/**
* When running the clean-command all recording activities older than
* the number of days specified here will be deleted.
*/
'delete_records_older_than_days' => 365,
/**
* When not specifying a log name when logging activity
* we'll using this log name.
*/
'default_log_name' => 'default',
/**
* You can specify an auth driver here that gets user models.
* When this is null we'll use the default Laravel auth driver.
*/
'default_auth_driver' => null,
/**
* When set to true, the subject returns soft deleted models.
*/
'subject_returns_soft_deleted_models' => false,
/**
* This model will be used to log activity. The only requirement is that
* it should be or extend the Spatie\Activitylog\Models\Activity model.
*/
'activity_model' => \Spatie\Activitylog\Models\Activity::class,
];