This package provides a git-like artisan command to easily sync files and folders between environments. This is super useful for assets, documents, and any other files that are untracked in your git repository.
Laravel Sync is a no-brainer and the perfect companion for your deploy script. The days are over when you had to manually keep track of files and folders between your environments. Do yourself a favor and give it a try!
rsyncon both your source and destination machine- A working
SSHsetup between your source and destination machine
Install the package using Composer.
composer require aerni/syncPublish the config of the package.
php artisan vendor:publish --provider="Aerni\Sync\SyncServiceProvider"The following config will be published to config/sync.php.
<?php
return [
/*
|--------------------------------------------------------------------------
| Remotes
|--------------------------------------------------------------------------
|
| Define on or more remotes you want to sync with.
| Each remote is an array with 'user', 'host', 'root', and optional 'port'.
|
*/
'remotes' => [
// 'production' => [
// 'user' => 'forge',
// 'host' => '104.26.3.113',
// 'port' => 1431,
// 'root' => '/home/forge/statamic.com',
// 'read_only' => false,
// ],
],
/*
|--------------------------------------------------------------------------
| Recipes
|--------------------------------------------------------------------------
|
| Define one or more recipes with the paths you want to sync.
| Each recipe is an array of paths relative to your project's root.
|
*/
'recipes' => [
// 'assets' => ['storage/app/assets/', 'storage/app/img/'],
],
/*
|--------------------------------------------------------------------------
| Options
|--------------------------------------------------------------------------
|
| An array of default rsync options.
| You can override these options when executing the command.
|
*/
'options' => [
'--archive',
],
];To use this package, you have to define at least one remote and recipe.
Each remote consists of a user, host, and root. Optionally, you may also define the SSH port and make a remote read_only.
| Key | Description |
|---|---|
user |
The username to log in to the host |
host |
The IP address of your server. |
port |
The SSH port to use for this connection |
root |
The absolute path to the project's root folder |
read_only |
Set to true to make the remote read-only |
'remotes' => [
'production' => [
'user' => 'forge',
'host' => '104.26.3.113',
'port' => 1431,
'root' => '/home/forge/statamic.com',
'read_only' => env('SYNC_PRODUCTION', true),
],
],The read_only option comes in handy if you want to prevent pushing to a remote from a certain environment, e.g. pushing to production from your local environment.
Add any number of recipes with the paths you want to sync. Each recipe is an array of paths relative to your project's root.
'recipes' => [
'assets' => ['storage/app/assets/', 'storage/app/img/'],
'env' => ['.env'],
],Configure the default rsync options to use when performing a sync. You can override these options when executing the command.
'options' => [
'--archive',
],If you know git, you'll feel right at home with the syntax of this command:
php artisan [command] [operation] [remote] [recipe] [options]The structure of the command looks like this:
| Structure | Description |
|---|---|
command |
The command you want to use |
operation |
The operation you want to use (pull or push) |
remote |
The remote you want to sync with |
recipe |
The recipe defining the paths to sync |
options |
The options you want to use |
You have three commands at your disposal:
| Command | Description |
|---|---|
sync |
Perform the sync |
sync:list |
List the origin, target, options, and port in a nice table |
sync:commands |
List all rsync commands |
You may use the following options:
| Option | Description |
|---|---|
-O* or --option=* |
Override the default rsync options |
-D or --dry |
Perform a dry run of the sync with real-time output |
-v or --verbose |
Displays the real-time output of the sync in the terminal |
Pull the assets recipe from the staging remote:
php artisan sync pull staging assetsPush the assets recipe to the production remote with some custom rsync options:
php artisan sync push production assets --option=-avh --option=--deletePerform a dry run:
php artisan sync pull staging assets --dryEcho the real-time output of the sync in your terminal:
php artisan sync pull staging assets --verboseList the origin, target, options, and port in a nice table:
php artisan sync:list pull staging assetsList all rsync commands:
php artisan sync:commands pull staging assets