Setup

MirthSync Setup

Complete guide to setting up MirthSync for your Mirth Connect or Open Integration Engine environment. This guide assumes you’ve already installed MirthSync.

Configuration Approach

MirthSync uses command-line arguments for all configuration. There is no configuration file. Server credentials can be provided via command-line options or environment variables for security.

---

Overview

Setting up MirthSync is straightforward and takes about 5-10 minutes. This guide walks you through each step with platform-specific examples for Linux, macOS, and Windows.

What You’ll Accomplish

1. Configure Server Connection - Set up secure connection to your Mirth Connect or OIE server using environment variables
2. Choose Target Directory - Select where MirthSync saves your configurations for version control
3. Select Disk Mode - Pick how files are organized - from granular code extraction to single backup files
4. Your First Pull - Download your configurations from the server to local files
5. Initialize Git (Optional) - Set up version control for tracking changes, team collaboration, and rollback capability

Platform-Specific Examples

Every command in this guide includes tabs for Linux, macOS, and Windows. Click your platform to see the right syntax.

---

Step 1: Configure Server Connection

MirthSync needs three pieces of information to connect to your Mirth Connect or OIE server:

• Server URL - Full API URL (must include /api)
• Username - API username
• Password - API password

Command-Line Arguments

Provide credentials directly on the command line:

Linux

./mirthsync.sh \
  -s https://mirth.example.com:8443/api \
  -u admin \
  -p your_password \
  -t ./mirth-config \
  pull

macOS

./mirthsync.sh \
  -s https://mirth.example.com:8443/api \
  -u admin \
  -p your_password \
  -t ./mirth-config \
  pull

Windows

mirthsync.bat `
  -s https://mirth.example.com:8443/api `
  -u admin `
  -p your_password `
  -t ./mirth-config `
  pull

Security Warning

Passwords on command line are visible in shell history and process lists. Use environment variables for better security.

Environment Variable (Recommended)

Use MIRTHSYNC_PASSWORD environment variable to keep passwords out of command line:

Linux

Set for current session:

export MIRTHSYNC_PASSWORD="your_password"

Make permanent (add to ~/.bashrc or ~/.zshrc):

echo 'export MIRTHSYNC_PASSWORD="your_password"' >> ~/.bashrc
source ~/.bashrc

Use .env file (recommended for development):

# Create .env file
cat > .env << 'EOF'
MIRTHSYNC_PASSWORD=your_password
EOF

# Add to .gitignore
echo ".env" >> .gitignore

# Load before running mirthsync
source .env
./mirthsync.sh -s https://mirth.example.com:8443/api -u admin -t ./mirth-config pull

macOS

Set for current session:

export MIRTHSYNC_PASSWORD="your_password"

Make permanent (add to ~/.zshrc for newer macOS):

echo 'export MIRTHSYNC_PASSWORD="your_password"' >> ~/.zshrc
source ~/.zshrc

Use .env file (recommended for development):

# Create .env file
cat > .env << 'EOF'
MIRTHSYNC_PASSWORD=your_password
EOF

# Add to .gitignore
echo ".env" >> .gitignore

# Load before running mirthsync
source .env
./mirthsync.sh -s https://mirth.example.com:8443/api -u admin -t ./mirth-config pull

Windows

PowerShell (current session):

$env:MIRTHSYNC_PASSWORD="your_password"

PowerShell (permanent):

[System.Environment]::SetEnvironmentVariable('MIRTHSYNC_PASSWORD', 'your_password', 'User')

Command Prompt (current session):

set MIRTHSYNC_PASSWORD=your_password

Permanent (via System Properties):

1. Search for “Environment Variables”
2. Click “Edit the system environment variables”
3. Click “Environment Variables” button
4. Add MIRTHSYNC_PASSWORD as user variable

Then run without -p flag:

Linux

# Password automatically read from MIRTHSYNC_PASSWORD
./mirthsync.sh -s https://mirth.example.com:8443/api -u admin -t ./mirth-config pull

macOS

# Password automatically read from MIRTHSYNC_PASSWORD
./mirthsync.sh -s https://mirth.example.com:8443/api -u admin -t ./mirth-config pull

Windows

# Password automatically read from MIRTHSYNC_PASSWORD
mirthsync.bat -s https://mirth.example.com:8443/api -u admin -t ./mirth-config pull

Add .env to .gitignore

If you use a .env file to store environment variables, always add it to .gitignore to prevent accidentally committing credentials to version control.

CI/CD Secret Management

In CI/CD environments (GitHub Actions, GitLab CI, Jenkins), use your platform’s secret management to set MIRTHSYNC_PASSWORD as a protected environment variable.

---

Step 2: Choose Target Directory

The target directory is where MirthSync saves your configurations. Choose a location that:

• Has sufficient disk space
• Is backed up regularly
• Can be used as a Git repository
• Is accessible by your development tools

Common patterns:

Linux

# Project-specific directory
./mirthsync.sh -s https://mirth.example.com:8443/api -u admin -t ./mirth-config pull

# Dedicated repository directory
./mirthsync.sh -s https://mirth.example.com:8443/api -u admin -t ~/projects/mirth-prod-config pull

# Shared team directory
./mirthsync.sh -s https://mirth.example.com:8443/api -u admin -t /opt/mirth-configs/production pull

macOS

# Project-specific directory
./mirthsync.sh -s https://mirth.example.com:8443/api -u admin -t ./mirth-config pull

# Dedicated repository directory
./mirthsync.sh -s https://mirth.example.com:8443/api -u admin -t ~/projects/mirth-prod-config pull

# iCloud Drive (for backup)
./mirthsync.sh -s https://mirth.example.com:8443/api -u admin -t ~/Library/Mobile\ Documents/com~apple~CloudDocs/mirth-config pull

Windows

# Project-specific directory
mirthsync.bat -s https://mirth.example.com:8443/api -u admin -t .\mirth-config pull

# Dedicated repository directory
mirthsync.bat -s https://mirth.example.com:8443/api -u admin -t C:\Projects\mirth-prod-config pull

# Network share (for team access)
mirthsync.bat -s https://mirth.example.com:8443/api -u admin -t \\server\mirth-configs\production pull

---

Step 3: Select Disk Mode

MirthSync supports 4 disk modes that control how files are organized. Choose based on your workflow:

Mode	Description	Best For	File Count
code (default)	Most granular - extracts JavaScript/SQL to separate files	Development, code review, IDE integration	High (many files)
items	Individual XML files for channels and code templates	Version control, simple structure	Medium
groups	Channel groups and code template libraries	Team collaboration, logical grouping	Low
backup	Single XML file (equivalent to Mirth Admin backup)	Quick backups, migration	1 file

Mode Examples

code (default)

Most granular mode - extracts JavaScript and SQL to separate files.

Linux

# Default mode (no -m flag needed)
./mirthsync.sh -s https://localhost:8443/api -u admin -t ./mirth-config pull

# Explicit mode specification
./mirthsync.sh -s https://localhost:8443/api -u admin -m code -t ./mirth-config pull

macOS

# Default mode (no -m flag needed)
./mirthsync.sh -s https://localhost:8443/api -u admin -t ./mirth-config pull

# Explicit mode specification
./mirthsync.sh -s https://localhost:8443/api -u admin -m code -t ./mirth-config pull

Windows

# Default mode (no -m flag needed)
mirthsync.bat -s https://localhost:8443/api -u admin -t .\mirth-config pull

# Explicit mode specification
mirthsync.bat -s https://localhost:8443/api -u admin -m code -t .\mirth-config pull

Structure:

mirth-config/
├── Channels/
│   ├── Default Group/
│   │   └── ADT_Inbound/
│   │       ├── channel.xml
│   │       ├── sourceConnector.js
│   │       ├── destinationConnector_1.js
│   │       └── transformer.js
│   └── Production Group/
│       └── Lab_Results/
│           └── ...
├── CodeTemplates/
│   ├── Utilities/
│   │   ├── library.xml
│   │   └── parseHL7.js
│   └── ...
├── GlobalScripts/
└── Resources/

Best for: Development, code review, IDE integration

items

Individual XML files for channels and code templates.

Linux

./mirthsync.sh -s https://localhost:8443/api -u admin -m items -t ./mirth-config pull

macOS

./mirthsync.sh -s https://localhost:8443/api -u admin -m items -t ./mirth-config pull

Windows

mirthsync.bat -s https://localhost:8443/api -u admin -m items -t .\mirth-config pull

Structure:

mirth-config/
├── Channels/
│   ├── Default Group/
│   │   └── ADT_Inbound.xml
│   └── Production Group/
│       └── Lab_Results.xml
└── CodeTemplates/
    ├── Utilities.xml
    └── ...

Best for: Version control with simpler structure, quick edits

groups

Channel groups and code template library level.

Linux

./mirthsync.sh -s https://localhost:8443/api -u admin -m groups -t ./mirth-config pull

macOS

./mirthsync.sh -s https://localhost:8443/api -u admin -m groups -t ./mirth-config pull

Windows

mirthsync.bat -s https://localhost:8443/api -u admin -m groups -t .\mirth-config pull

Structure:

mirth-config/
├── ChannelGroups/
│   ├── Default Group.xml
│   └── Production Group.xml
└── CodeTemplateLibraries/
    └── Utilities.xml

Best for: Team collaboration, logical grouping by channel groups

backup

Single full backup XML file (equivalent to Mirth Administrator backup).

Linux

./mirthsync.sh -s https://localhost:8443/api -u admin -m backup -t ./mirth-config pull

macOS

./mirthsync.sh -s https://localhost:8443/api -u admin -m backup -t ./mirth-config pull

Windows

mirthsync.bat -s https://localhost:8443/api -u admin -m backup -t .\mirth-config pull

Structure:

mirth-config/
└── backup.xml

Best for: Quick backups, migration between servers, disaster recovery

Choosing a Disk Mode

• Development teams: Use code mode for best IDE integration
• Simple version control: Use items mode for cleaner structure
• Quick backups: Use backup mode for single-file backups
• You can switch modes by using a different -m flag on your next pull

---

Step 4: Your First Pull

Now let’s perform your first pull to download configurations from your server:

Linux

# 1. Create target directory
mkdir -p ./mirth-config

# 2. Pull from server (using environment variable for password)
export MIRTHSYNC_PASSWORD="your_password"
./mirthsync.sh -s https://mirth.example.com:8443/api -u admin -t ./mirth-config pull

# 3. Check what was downloaded
ls -la ./mirth-config/

macOS

# 1. Create target directory
mkdir -p ./mirth-config

# 2. Pull from server (using environment variable for password)
export MIRTHSYNC_PASSWORD="your_password"
./mirthsync.sh -s https://mirth.example.com:8443/api -u admin -t ./mirth-config pull

# 3. Check what was downloaded
ls -la ./mirth-config/

Windows

# 1. Create target directory
New-Item -ItemType Directory -Force -Path .\mirth-config

# 2. Pull from server (using environment variable for password)
$env:MIRTHSYNC_PASSWORD="your_password"
mirthsync.bat -s https://mirth.example.com:8443/api -u admin -t .\mirth-config pull

# 3. Check what was downloaded
dir .\mirth-config\

Expected output:

Connecting to Mirth Connect...
✓ Connected to https://mirth.example.com:8443
✓ Pulled 15 channels
✓ Pulled 8 code templates
✓ Pulled configuration map
✓ Files saved to ./mirth-config/

Orphaned Files

If files exist locally but not on the server (orphaned files), MirthSync will warn you. Use --delete-orphaned to remove them automatically (see CLI Reference for details).

---

Step 5: Initialize Git (Optional but Recommended)

Version control with Git is optional but highly recommended for tracking changes, team collaboration, and rollback capability.

MirthSync's Built-in Git (Recommended)

MirthSync includes embedded Git functionality:

Linux

# Initialize git repository
./mirthsync.sh -t ./mirth-config git init

# Stage all files
./mirthsync.sh -t ./mirth-config git add

# Create first commit
./mirthsync.sh -t ./mirth-config --commit-message "Initial commit from production server" git commit

# Check status
./mirthsync.sh -t ./mirth-config git status

macOS

# Initialize git repository
./mirthsync.sh -t ./mirth-config git init

# Stage all files
./mirthsync.sh -t ./mirth-config git add

# Create first commit
./mirthsync.sh -t ./mirth-config --commit-message "Initial commit from production server" git commit

# Check status
./mirthsync.sh -t ./mirth-config git status

Windows

# Initialize git repository
mirthsync.bat -t .\mirth-config git init

# Stage all files
mirthsync.bat -t .\mirth-config git add

# Create first commit
mirthsync.bat -t .\mirth-config --commit-message "Initial commit from production server" git commit

# Check status
mirthsync.bat -t .\mirth-config git status

Standard Git

If you prefer standard Git commands:

Linux

cd ./mirth-config
git init
git add .
git commit -m "Initial commit from production server"
git status
cd ..

macOS

cd ./mirth-config
git init
git add .
git commit -m "Initial commit from production server"
git status
cd ..

Windows

cd .\mirth-config
git init
git add .
git commit -m "Initial commit from production server"
git status
cd ..

Auto-Commit Workflow

For convenience, MirthSync can automatically commit after pull operations:

Linux

# Pull and auto-commit in one command
./mirthsync.sh \
  -s https://mirth.example.com:8443/api \
  -u admin \
  -t ./mirth-config \
  --git-init \
  --auto-commit \
  --commit-message "Pulled from production $(date +%Y-%m-%d)" \
  pull

macOS

# Pull and auto-commit in one command
./mirthsync.sh \
  -s https://mirth.example.com:8443/api \
  -u admin \
  -t ./mirth-config \
  --git-init \
  --auto-commit \
  --commit-message "Pulled from production $(date +%Y-%m-%d)" \
  pull

Windows

# Pull and auto-commit in one command
mirthsync.bat `
  -s https://mirth.example.com:8443/api `
  -u admin `
  -t .\mirth-config `
  --git-init `
  --auto-commit `
  --commit-message "Pulled from production $((Get-Date).ToString('yyyy-MM-dd'))" `
  pull

---

Security Best Practices

Never Commit Passwords or Credentials

Mirth Connect security best practice: Never hardcode Mirth Connect database passwords, channel credentials, or API keys in your code. Passwords in JavaScript transformers, connectors, global scripts, or code templates create security vulnerabilities when committed to version control.

1. Use Mirth Connect’s Configuration Map for password management:

Reference the Configuration Map (Settings → Configuration Map) in your channel code instead of hardcoding passwords:

// GOOD - Reference Configuration Map
var dbPassword = configurationMap.get("DB_PASSWORD");
var apiKey = $cfg("API_KEY");

// BAD - Hardcoded password (will be committed to Git!)
var dbPassword = "MySecretPassword123";

Critical: MirthSync excludes the Configuration Map by default (the --include-configuration-map flag defaults to false). Store actual Configuration Map values in AWS KMS, HashiCorp Vault, Azure Key Vault, or another secrets management service.

2. Where hardcoded passwords commonly appear in Mirth Connect code:

• JavaScript transformers
• JavaScript preprocessors and postprocessors
• Source and destination connector scripts
• Global scripts
• Code templates

3. Scan for secrets before committing:

Use a secret scanning tool as a pre-commit hook to detect accidentally hardcoded passwords. Popular open-source options:

Gitleaks (most popular):

# Install Gitleaks
brew install gitleaks  # macOS
# or follow https://github.com/gitleaks/gitleaks

# Scan repository before commit
gitleaks detect --source . --verbose

TruffleHog (alternative):

# Install TruffleHog
brew install trufflehog  # macOS
# or follow https://github.com/trufflesecurity/trufflehog

# Scan repository before commit
trufflehog git file://. --since-commit HEAD --fail

4. Additional protections:

Add to .gitignore as a safeguard:

# Safeguard if --include-configuration-map is accidentally used
ConfigurationMap.xml

Always Use HTTPS for Mirth Connect Connections

Mirth Connect security best practice: Always connect to Mirth Connect and OIE servers using HTTPS URLs to encrypt credentials and data in transit. Unencrypted HTTP connections expose admin passwords and channel configurations to network interception.

Use HTTPS in MirthSync CLI commands:

# GOOD - Encrypted connection
-s https://mirth.example.com:8443/api

# BAD - Unencrypted (credentials exposed!)
-s http://mirth.example.com:8080/api

For self-signed certificates:

Linux

# Use -i to ignore certificate warnings for self-signed certificates
./mirthsync.sh -s https://localhost:8443/api -u admin -i -t ./mirth-config pull

macOS

# Use -i to ignore certificate warnings for self-signed certificates
./mirthsync.sh -s https://localhost:8443/api -u admin -i -t ./mirth-config pull

Windows

# Use -i to ignore certificate warnings for self-signed certificates
mirthsync.bat -s https://localhost:8443/api -u admin -i -t .\mirth-config pull

Many production Mirth Connect environments use self-signed certificates, especially in internal hospital networks. The -i flag is acceptable for these deployments. The important security requirement is using HTTPS (encryption), not having a CA-signed certificate.

---

Common Setup Patterns

Development Workflow

Daily development setup:

Linux

# Morning: Pull latest from dev server
./mirthsync.sh -s https://mirth-dev:8443/api -u admin -t ./mirth-dev pull

# Work on channels in Admin Console or edit files directly

# Afternoon: Pull changes, review, and commit
./mirthsync.sh -s https://mirth-dev:8443/api -u admin -t ./mirth-dev pull
./mirthsync.sh -t ./mirth-dev git diff
./mirthsync.sh -t ./mirth-dev git add
./mirthsync.sh -t ./mirth-dev --commit-message "Updated ADT channel error handling" git commit
./mirthsync.sh -t ./mirth-dev git push

macOS

# Morning: Pull latest from dev server
./mirthsync.sh -s https://mirth-dev:8443/api -u admin -t ./mirth-dev pull

# Work on channels in Admin Console or edit files directly

# Afternoon: Pull changes, review, and commit
./mirthsync.sh -s https://mirth-dev:8443/api -u admin -t ./mirth-dev pull
./mirthsync.sh -t ./mirth-dev git diff
./mirthsync.sh -t ./mirth-dev git add
./mirthsync.sh -t ./mirth-dev --commit-message "Updated ADT channel error handling" git commit
./mirthsync.sh -t ./mirth-dev git push

Windows

# Morning: Pull latest from dev server
mirthsync.bat -s https://mirth-dev:8443/api -u admin -t .\mirth-dev pull

# Work on channels in Admin Console or edit files directly

# Afternoon: Pull changes, review, and commit
mirthsync.bat -s https://mirth-dev:8443/api -u admin -t .\mirth-dev pull
mirthsync.bat -t .\mirth-dev git diff
mirthsync.bat -t .\mirth-dev git add
mirthsync.bat -t .\mirth-dev --commit-message "Updated ADT channel error handling" git commit
mirthsync.bat -t .\mirth-dev git push

Multi-Environment Setup

Managing multiple servers (dev, staging, production):

Linux

# Create separate directories for each environment
mkdir -p ./mirth-dev ./mirth-staging ./mirth-prod

# Set environment-specific passwords
export DEV_PASSWORD="dev_pass"
export STAGING_PASSWORD="staging_pass"
export PROD_PASSWORD="prod_pass"

# Pull from each environment
./mirthsync.sh -s https://mirth-dev:8443/api -u admin -p $DEV_PASSWORD -t ./mirth-dev pull
./mirthsync.sh -s https://mirth-staging:8443/api -u admin -p $STAGING_PASSWORD -t ./mirth-staging pull
./mirthsync.sh -s https://mirth-prod:8443/api -u admin -p $PROD_PASSWORD -t ./mirth-prod pull

# Or use a single directory with branches
./mirthsync.sh -s https://mirth-dev:8443/api -u admin -t ./mirth-config pull
./mirthsync.sh -t ./mirth-config git add
./mirthsync.sh -t ./mirth-config --commit-message "Dev environment snapshot" git commit
cd ./mirth-config && git checkout -b staging && cd ..  # Use native git for branch creation
./mirthsync.sh -s https://mirth-staging:8443/api -u admin -t ./mirth-config pull

macOS

# Create separate directories for each environment
mkdir -p ./mirth-dev ./mirth-staging ./mirth-prod

# Set environment-specific passwords
export DEV_PASSWORD="dev_pass"
export STAGING_PASSWORD="staging_pass"
export PROD_PASSWORD="prod_pass"

# Pull from each environment
./mirthsync.sh -s https://mirth-dev:8443/api -u admin -p $DEV_PASSWORD -t ./mirth-dev pull
./mirthsync.sh -s https://mirth-staging:8443/api -u admin -p $STAGING_PASSWORD -t ./mirth-staging pull
./mirthsync.sh -s https://mirth-prod:8443/api -u admin -p $PROD_PASSWORD -t ./mirth-prod pull

# Or use a single directory with branches
./mirthsync.sh -s https://mirth-dev:8443/api -u admin -t ./mirth-config pull
./mirthsync.sh -t ./mirth-config git add
./mirthsync.sh -t ./mirth-config --commit-message "Dev environment snapshot" git commit
cd ./mirth-config && git checkout -b staging && cd ..  # Use native git for branch creation
./mirthsync.sh -s https://mirth-staging:8443/api -u admin -t ./mirth-config pull

Windows

# Create separate directories for each environment
New-Item -ItemType Directory -Force -Path .\mirth-dev, .\mirth-staging, .\mirth-prod

# Set environment-specific passwords
$env:DEV_PASSWORD="dev_pass"
$env:STAGING_PASSWORD="staging_pass"
$env:PROD_PASSWORD="prod_pass"

# Pull from each environment
mirthsync.bat -s https://mirth-dev:8443/api -u admin -p %DEV_PASSWORD% -t .\mirth-dev pull
mirthsync.bat -s https://mirth-staging:8443/api -u admin -p %STAGING_PASSWORD% -t .\mirth-staging pull
mirthsync.bat -s https://mirth-prod:8443/api -u admin -p %PROD_PASSWORD% -t .\mirth-prod pull

# Or use a single directory with branches
mirthsync.bat -s https://mirth-dev:8443/api -u admin -t .\mirth-config pull
mirthsync.bat -t .\mirth-config git add
mirthsync.bat -t .\mirth-config --commit-message "Dev environment snapshot" git commit
cd .\mirth-config; git checkout -b staging; cd ..  # Use native git for branch creation
mirthsync.bat -s https://mirth-staging:8443/api -u admin -t .\mirth-config pull

Environment Management

MirthSync doesn’t have built-in multi-environment support. Use different target directories or Git branches to manage multiple environments. Shell scripts or aliases can simplify switching between servers.

CI/CD Setup

Automated pull in CI/CD pipeline:

Linux

# GitHub Actions, GitLab CI, Jenkins, etc.
# Set MIRTHSYNC_PASSWORD as secret/protected environment variable

# Pull from dev server
./mirthsync.sh \
  -s ${MIRTH_DEV_URL} \
  -u ${MIRTH_USERNAME} \
  -i \
  -t ./src \
  --auto-commit \
  --commit-message "Automated pull from dev - $(date)" \
  --git-author "CI System" \
  --git-email "ci@company.com" \
  pull

# Push to GitHub
./mirthsync.sh -t ./src git push

macOS

# For local CI/CD testing
# Set MIRTHSYNC_PASSWORD as environment variable

# Pull from dev server
./mirthsync.sh \
  -s ${MIRTH_DEV_URL} \
  -u ${MIRTH_USERNAME} \
  -i \
  -t ./src \
  --auto-commit \
  --commit-message "Automated pull from dev - $(date)" \
  --git-author "CI System" \
  --git-email "ci@company.com" \
  pull

# Push to GitHub
./mirthsync.sh -t ./src git push

Windows

# Azure DevOps, Jenkins on Windows, etc.
# Set MIRTHSYNC_PASSWORD as secret/protected environment variable

# Pull from dev server
mirthsync.bat `
  -s ${env:MIRTH_DEV_URL} `
  -u ${env:MIRTH_USERNAME} `
  -i `
  -t .\src `
  --auto-commit `
  --commit-message "Automated pull from dev - $((Get-Date).ToString())" `
  --git-author "CI System" `
  --git-email "ci@company.com" `
  pull

# Push to GitHub
mirthsync.bat -t .\src git push

---

Troubleshooting Setup

”Connection refused” or “Cannot connect”

Check:

1. Server is running: Open Mirth Administrator to verify
2. API port is accessible: Default is 8443
3. URL includes /api: https://mirth.example.com:8443/api
4. Firewall allows connections on port 8443

Test connection:

Linux

# Test if API is accessible
curl -k https://mirth.example.com:8443/api/server/version

macOS

# Test if API is accessible
curl -k https://mirth.example.com:8443/api/server/version

Windows

# Test if API is accessible
Invoke-WebRequest -Uri https://mirth.example.com:8443/api/server/version -SkipCertificateCheck

“Authentication failed”

Check:

1. Username is correct (usually admin)
2. Password is correct
3. User has API access enabled in Mirth Connect
4. MIRTHSYNC_PASSWORD environment variable is set correctly

Verify environment variable:

Linux

echo $MIRTHSYNC_PASSWORD

macOS

echo $MIRTHSYNC_PASSWORD

Windows

echo $env:MIRTHSYNC_PASSWORD

“Target directory not empty”

If the target directory already has files:

Linux

# Use --force to overwrite existing files
./mirthsync.sh -s https://localhost:8443/api -u admin -f -t ./mirth-config pull

macOS

# Use --force to overwrite existing files
./mirthsync.sh -s https://localhost:8443/api -u admin -f -t ./mirth-config pull

Windows

# Use --force to overwrite existing files
mirthsync.bat -s https://localhost:8443/api -u admin -f -t .\mirth-config pull

Orphaned File Warnings

When files exist locally but not on server:

Linux

# See warnings (default behavior)
./mirthsync.sh -s https://localhost:8443/api -u admin -t ./mirth-config pull

# Delete orphaned files automatically
./mirthsync.sh -s https://localhost:8443/api -u admin --delete-orphaned -t ./mirth-config pull

# Delete with interactive confirmation
./mirthsync.sh -s https://localhost:8443/api -u admin --delete-orphaned --interactive -t ./mirth-config pull

macOS

# See warnings (default behavior)
./mirthsync.sh -s https://localhost:8443/api -u admin -t ./mirth-config pull

# Delete orphaned files automatically
./mirthsync.sh -s https://localhost:8443/api -u admin --delete-orphaned -t ./mirth-config pull

# Delete with interactive confirmation
./mirthsync.sh -s https://localhost:8443/api -u admin --delete-orphaned --interactive -t ./mirth-config pull

Windows

# See warnings (default behavior)
mirthsync.bat -s https://localhost:8443/api -u admin -t .\mirth-config pull

# Delete orphaned files automatically
mirthsync.bat -s https://localhost:8443/api -u admin --delete-orphaned -t .\mirth-config pull

# Delete with interactive confirmation
mirthsync.bat -s https://localhost:8443/api -u admin --delete-orphaned --interactive -t .\mirth-config pull

---

Next Steps

Explore CLI Reference

Now that you’ve completed the basic setup, explore the CLI Reference for:

• Complete command documentation
• Advanced flags and options
• Git commands reference
• Troubleshooting and tips

→ View CLI Reference