php-sync-toolDatabase & File Synchronization for PHP

Sync MySQL, MariaDB or PostgreSQL databases and files between systems over SSH/rsync/SFTP — with automatic framework credential detection

Get Started

View on GitHub

🔄

Database Sync

Synchronize MySQL, MariaDB or PostgreSQL databases between local and remote systems in nine modes (receiver, sender, proxy, dump, import, sync).

🔐

Auto Credential Detection

Automatically extract database credentials from TYPO3, Symfony, Drupal, WordPress, and Laravel — no manual DB config needed.

📁

File Synchronization

Sync files alongside (or instead of) the database with --with-files / --files-only, including exclude patterns.

📦

Composer or PHAR

Install via Composer as a library dependency, or ship the single-file PHAR. PHP 8.2+, using the database and transfer tools already on your hosts.

🛡️

Secure by Default

SSH host-key verification is enforced, credentials are masked in logs, and protected hosts guard against accidental overwrites.

⚡

Fast Transfers

gzip-compressed mysqldump with rsync transfer by default, automatic SFTP fallback, and two-hop proxy for isolated networks.

Quick Example

bash

# Install via Composer
composer require konradmichalik/php-sync-tool

# Sync a database from production to local using a config file
bin/sync-tool -f config.yaml

Supported Frameworks

Point path at a framework's config file and credentials are detected automatically:

Framework	Version	Config File
TYPO3	7.6 – 12.x	`LocalConfiguration.php` / `AdditionalConfiguration.php` or `.env`
TYPO3	≥ 13	`config/system/settings.php` / `additional.php` or `.env`
Symfony	≥ 3.4	`.env` (`DATABASE_URL`)
Symfony	≤ 2.8	`parameters.yml`
Drupal	≥ 8.0	`settings.php` (via drush)
WordPress	≥ 5.0	`wp-config.php`
Laravel	≥ 4.0	`.env`

About This Project

php-sync-tool exists so that copying a database between environments is a one-line command that runs on the PHP already installed on your build and deploy hosts. It integrates with Composer-based projects, reads credentials straight out of your framework's configuration, and refuses to overwrite a target you did not mean to touch.

It succeeds the Python db-sync-tool by the same author. Existing config files keep working: Coming from db-sync-tool covers the move.