Configuration

db-sync-tool can be configured via command line arguments or configuration files (YAML or JSON).

Configuration Methods

Method	Best For
Auto-Discovery	Quick, repeated syncs with predefined hosts
Config Files	Complex setups, CI/CD pipelines
CLI Arguments	One-off syncs, scripting

Quick Example

Using a Config File

# config.yaml
type: TYPO3
origin:
  host: prod.example.com
  user: deploy
  path: /var/www/html/typo3conf/LocalConfiguration.php
target:
  path: /var/www/local/typo3conf/LocalConfiguration.php
ignore_table:
  - cache_*
  - sys_log

db_sync_tool -f config.yaml

Using Auto-Discovery

# With global hosts configured
db_sync_tool production local

# Interactive selection
db_sync_tool

Using CLI Arguments

db_sync_tool \
    --type TYPO3 \
    --origin-host prod.example.com \
    --origin-user deploy \
    --origin-path /var/www/html/typo3conf/LocalConfiguration.php \
    --target-path /var/www/local/typo3conf/LocalConfiguration.php

Key Configuration Sections

Origin & Target

Every sync requires an origin (source) and target (destination):

origin:
  host: remote.example.com  # SSH host (makes this remote)
  user: ssh_user           # SSH user
  path: /path/to/config    # Framework config path
target:
  path: /local/path/to/config  # No host = local

Framework Type

Specify the framework for automatic credential extraction:

type: TYPO3  # or Symfony, Drupal, WordPress, Laravel

If omitted, the tool attempts to detect the framework from the file path.

Ignore Tables

Exclude tables from the sync (supports wildcards):

ignore_table:
  - cache_*
  - sessions
  - logs

Truncate Tables

Clear tables before import:

truncate_table:
  - user_sessions

Next Steps

• Auto-Discovery - Set up quick syncs
• Full Reference - All configuration options
• Authentication - SSH keys and passwords