Configuration

Options available in nimbus.config.json.

{
	"target": "s3://my-bucket/backups",
	"interval": "15m",
	"concurrency": 4,
	"dryRun": false,
	"hooks": {
		"postSync": "plugins/notify-slack.js"
	}
}
Option Type Default Description
target string โ€” Destination URI for synced files.
interval string "1h" How often to run an automatic sync.
concurrency number 2 Parallel file transfers.
dryRun boolean false Log actions without transferring.
hooks object {} Paths to scripts run on lifecycle events (see Plugins).

Per-environment overrides

Nimbus merges nimbus.<env>.config.json over the base config when NIMBUS_ENV is set:

NIMBUS_ENV=staging nimbus sync
nimbus.config.json          # base
nimbus.staging.config.json  # merged on top when NIMBUS_ENV=staging

Validating config

nimbus config validate

Catches typos and unknown keys before they cause a failed sync.