Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aerni/laravel-sync
A git-like artisan command to easily sync files and folders between environments.
https://github.com/aerni/laravel-sync
artisan-command laravel laravel-package laravel-sync sync
Last synced: 12 days ago
JSON representation
A git-like artisan command to easily sync files and folders between environments.
- Host: GitHub
- URL: https://github.com/aerni/laravel-sync
- Owner: aerni
- License: mit
- Created: 2020-12-08T17:53:27.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2024-03-30T21:45:11.000Z (7 months ago)
- Last Synced: 2024-10-12T18:54:49.991Z (27 days ago)
- Topics: artisan-command, laravel, laravel-package, laravel-sync, sync
- Language: PHP
- Homepage:
- Size: 123 KB
- Stars: 64
- Watchers: 4
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
  
# Laravel Sync
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!
## Requirements
- `rsync` on both your source and destination machine
- A working `SSH` setup between your source and destination machine
## Installation
Install the package using Composer.
```bash
composer require aerni/sync
```
Publish the config of the package.
```bash
php artisan vendor:publish --provider="Aerni\Sync\SyncServiceProvider"
```
The following config will be published to `config/sync.php`.
```php
[
// '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',
],
];
```
## Configuration
To use this package, you have to define at least one remote and recipe.
### Remotes
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 |
```php
'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.
### Recipes
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.
```php
'recipes' => [
'assets' => ['storage/app/assets/', 'storage/app/img/'],
'env' => ['.env'],
],
```
### Options
Configure the default rsync options to use when performing a sync. You can override these options when executing the command.
```php
'options' => [
'--archive',
],
```
## The Command
If you know git, you'll feel right at home with the syntax of this command:
```bash
php artisan [command] [operation] [remote] [recipe] [options]
```
### Command Structure
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 |
### Available Commands
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 |
### Available Options
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 |
## Usage Examples
Pull the assets recipe from the staging remote:
```bash
php artisan sync pull staging assets
```
Push the assets recipe to the production remote with some custom rsync options:
```bash
php artisan sync push production assets --option=-avh --option=--delete
```
Perform a dry run:
```bash
php artisan sync pull staging assets --dry
```
Echo the real-time output of the sync in your terminal:
```bash
php artisan sync pull staging assets --verbose
```
List the origin, target, options, and port in a nice table:
```bash
php artisan sync:list pull staging assets
```
List all rsync commands:
```bash
php artisan sync:commands pull staging assets
```