Get Started

Deploying IronDiff is simple and takes only a few minutes. Choose between a Docker container (recommended for Linux/macOS servers) or a native Windows agent (ideal for Windows-only environments or RMM deployments).

Security First: Zero Inbound Firewall Rules Required. The IronDiff on-prem agent works by pulling configurations locally and pushing them outbound to the IronDiff cloud. This architecture ensures you never need to open inbound firewall rules to your internal network.

1. Create an Account

Before deploying, create an account to manage your licenses and view your backup dashboard.

Visit the IronDiff Portal to register.

Option A: Docker Agent

2. Prepare Working Directory

mkdir irondiff && cd irondiff

3. Deploy and Configure

Start the Backup Engine:

docker run -d \
  --name irondiff \
  --restart unless-stopped \
  -p 5000:5000 \
  -v ./config:/app/config \
  -v ./data:/app/data \
  -e TZ=America/Denver \
  -e LICENSE_KEY=your-license-key-here \
  irondiff/irondiff --daemon

Start the Auto-Updater (Recommended):

docker run -d \
  --name irondiff-updater \
  --restart unless-stopped \
  -v /var/run/docker.sock:/var/run/docker.sock \
  -e DOCKER_API_VERSION=1.44 \
  containrrr/watchtower \
  --interval 86400 --cleanup \
  irondiff

4. Complete Setup

Open your browser to https://localhost:5000, log in with your portal credentials, and add your network devices.

Option B: Windows Agent

2. Download the Installer

Download IronDiffAgent.exe from the IronDiff Portal Settings page. It’s a single self-contained file.

3. Run the Installer

Double-click IronDiffAgent.exe and accept the Windows SmartScreen prompt (click “More info” → “Run anyway”). The installer will set up the Windows service and open the local web UI automatically.

For scripted/RMM deployment (Syncro, ConnectWise, etc.):

.\IronDiffAgent.exe install --license-key "YOUR-KEY" --site-name "Customer Name" --group-name "Main Office" --silent

Auto-updates are built in — the agent checks for new versions every 6 hours.

4. Complete Setup

Open your browser to https://localhost:5000, log in with your portal credentials, and add your network devices.

Environment Details

  • Port 5000: Used for the web configuration interface.
  • Docker Volumes: The ./config and ./data directories will be automatically created on your host to persist your settings and backup archives.
  • Windows Install Path: C:\Program Files\IronDiff\
  • Timezone: The TZ environment variable (Docker) or system timezone (Windows) ensures your backup schedule aligns with your local time.

For detailed documentation, see the full installation guide.