digifactory/laravel-pull-production-data

Pull your production storage folder and database to your local environment

v4.0.0 2024-04-16 07:36 UTC

README

Latest Version on Packagist MIT Licensed GitHub Workflow Status Quality Score StyleCI Total Downloads

This package provides a command to download your production database and storage/app folder to your local environment.

In the current state this package mainly scratches our own itch. Nonetheless this package can be used in nearly every Laravel environment.

The package assumes you have:

  • Environment variables DEPLOY_SERVER and DEPLOY_PATH (customisable in the config)
  • Setup SSH keys between your machine and the production machine
  • mysql binary available on your local machine
  • mysqldump binary available on your production machine

Installation

You can install the package via composer:

composer require digifactory/laravel-pull-production-data --dev

You can publish the config file:

php artisan vendor:publish --provider="DigiFactory\PullProductionData\PullProductionDataServiceProvider" --tag="config"

Usage

By default both the database and the storage folder will be synced.

php artisan pull-production-data

The following flags are available:

Flag Description
-D, --no-database Whether the database should not be synced
-S, --no-storage-folder Whether the storage folder should not be synced

Preview

Screenshot of the command

Testing

composer test

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email helpdesk@digifactory.nl instead of using the issue tracker.

Credits

License

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