https://github.com/ajaxray/laravel-server-sync
Easily sync server (production/staging) database and files to your local environment
https://github.com/ajaxray/laravel-server-sync
Last synced: 2 months ago
JSON representation
Easily sync server (production/staging) database and files to your local environment
- Host: GitHub
- URL: https://github.com/ajaxray/laravel-server-sync
- Owner: ajaxray
- License: mit
- Created: 2025-03-07T18:41:13.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2025-03-07T19:25:22.000Z (3 months ago)
- Last Synced: 2025-03-07T19:50:43.166Z (3 months ago)
- Language: PHP
- Size: 8.79 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Laravel Server Sync
[](https://packagist.org/packages/ajaxray/laravel-server-sync)
[](https://packagist.org/packages/ajaxray/laravel-server-sync)
[](https://packagist.org/packages/ajaxray/laravel-server-sync)
A Laravel package to easily sync your production/staging database and storage files to your local environment. Perfect for debugging production issues or keeping your local environment up to date with production data.
> **Note**: This package is now stable and ready for production use. It supports Laravel 10.x and 11.x.
## Features
- 🔄 One-command sync of both database and files
- 🔒 Secure SSH-based file transfer
- 📁 Smart file syncing with rsync
- 🗄️ Database dump and restore
- ⚡ Progress indicators for long operations
- 🛠️ Highly configurable
## Requirements
- PHP 8.1 or higher
- Laravel 10.0 or higher
- SSH access to production server
- MySQL/MariaDB client installed locally
- rsync installed on both local and production servers
## Installation
```bash
composer require ajaxray/laravel-server-sync
```
To install for dev environments
```bash
composer require --dev ajaxray/laravel-server-sync
```
After installation, publish the configuration file:
```bash
php artisan vendor:publish --provider="Ajaxray\ServerSync\ServerSyncServiceProvider"
```
## Configuration
### Environment Variables
Add these to your `.env` file:
```env
PROD_SSH_HOST=your-production-server.com
PROD_SSH_USER=your-ssh-username
PROD_SSH_PATH=/path/to/laravel
```
### Configuration File
The published config file `config/server-sync.php` allows you to:
- Configure default server settings
- Exclude specific tables from database sync
- Configure file sync paths and exclusions
- Customize dump location
## Usage
### Basic Usage
Sync both database and files:
```bash
php artisan sync:pull
```
### Database Sync Options
```bash
# Skip database sync entirely
php artisan sync:pull --skip-db
# Exclude specific tables
php artisan sync:pull --exclude-tables=logs,cache,sessions
# Only sync specific tables
php artisan sync:pull --only-tables=users,products,orders
```
### File Sync Options
```bash
# Skip file sync entirely
php artisan sync:pull --skip-files
# Sync files with deletion (removes local files that don't exist in production)
php artisan sync:pull --delete
```
### Server Configuration Options
```bash
# Override server details inline
php artisan sync:pull --host=prod.example.com --user=deploy --path=/var/www/app
# All options can be combined
php artisan sync:pull --host=prod.example.com --user=deploy --exclude-tables=logs --delete
```
### Safety Features
```bash
# Force sync in production environment (use with caution!)
php artisan sync:pull --force
```
> **Note**: The `--force` option should be used with extreme caution as it overrides the production environment safety check.
## Security
- Uses SSH for secure file transfer
- Requires key-based authentication
- Temporary files are automatically cleaned up
- Database credentials are never stored locally
## Troubleshooting
### SSH Connection Issues
- Verify SSH key-based authentication is set up
- Check if you can manually SSH into the server
- Ensure proper permissions for the SSH user
### Database Sync Issues
- Verify MySQL client installation
- Check database credentials in both environments
- Ensure sufficient privileges for database operations
### File Sync Issues
- Verify rsync installation
- Check storage directory permissions
- Use stable internet connection for large files
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
- [Anis Uddin Ahmad](https://github.com/ajaxray)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.