README

SQLighter is a lightweight SQLite backup solution for Laravel applications. SQLighter provides automated backups of your SQLite database with configurable retention policies, while allowing for manual backups through an artisan command.

🔄 Automated SQLite database backups
⚙️ Configurable backup frequency
📦 Backup file rotation with configurable retention
🗂️ Automatic backup directory creation
🚫 Git-friendly (auto-generates appropriate .gitignore)
💡 Simple integration with Laravel's scheduler

Installation

You can install the package via composer:

composer require joeymckenzie/sqlighter

Usage

After installation, publish the configuration file:

php artisan vendor:publish --tag="sqligther-config"

This will create a config/sqligther.php configuration file. Customize the options to fit your needs:

return [
    // Enable/disable automatic backups
    'enabled' => env('SQLIGHTER_ENABLED', true),

    // Hours between backups
    'frequency' => env('SQLIGHTER_FREQUENCY', 3),

    // SQLite database filename
    'database' => env('SQLIGHTER_DATABASE', 'database.sqlite'),

    // How many backup copies to maintain
    'copies_to_maintain' => env('SQLIGHTER_COPIES', 5),

    // Where to store backups (relative to database directory)
    'storage_folder' => env('SQLIGHTER_STORAGE', 'backups/'),

    // Prefix for backup files
    'file_prefix' => env('SQLIGHTER_PREFIX', 'backup'),
];

Automatic Backups

SQLighter automatically registers a scheduled command to perform backups based on your configuration. No additional setup is required other than ensuring your Laravel scheduler is running:

cd /path-to-your-project && php artisan schedule:run >> /dev/null 2>&1

Backups are configured to run every six hours by default, though can be overridden using the sqlighter.frequency configuration option. Any valid cron string will work:

return [
    // Using hour intervals
    'frequency' => 1,    // Every hour
    'frequency' => 12,   // Every 12 hours
    'frequency' => 24,   // Daily
    'frequency' => 168,  // Weekly

    // Or using cron expressions
    'frequency' => '0 * * * *',     // Every hour
    'frequency' => '0 */12 * * *',  // Every 12 hours
    'frequency' => '0 0 * * *',     // Daily at midnight
    'frequency' => '0 0 * * 0',     // Weekly on Sunday at midnight
    'frequency' => '30 2 * * *',    // Daily at 2:30 AM
];

Manual Backups

You can also trigger a backup manually using the provided Artisan command:

php artisan sqlighter:backup

Backup Storage

Backups are stored in your Laravel database directory under the configured storage_folder (default: backups/). A .gitignore file is automatically created to prevent backups from being committed to your repository.

File Naming

Backup files are named using the following format:

{prefix}-{timestamp}.sql

For example: backup-1698765432.sql

Testing

Pest is used to test the backup command. To run tests, just use the composer script:

composer test

Security Vulnerabilities

If you discover a security vulnerability within SQLighter, please send an e-mail to Joey McKenzie via joey.mckenzie27@gmail.com.

License

The MIT License (MIT). Please see License File for more information.

joeymckenzie / sqlighter

Maintainers

Details