Configuration Schema

Complete reference for the docsync.config.json configuration file.

Configuration Editor — Visual editor for docsync.config.json

Root Properties

JSON

{
  "baseUrl": "http://localhost:3000",
  "assetDir": ".reshot/output",
  "concurrency": 2,
  "timeout": 45000,
  "headless": true,
  "viewport": {},
  "storage": {},
  "diffing": {},
  "variants": {},
  "scenarios": []
}

Property	Type	Required	Default	Description
`baseUrl`	string	✓	-	Base URL for your application
`assetDir`	string	✗	`.reshot/output`	Output directory
`concurrency`	number	✗	`2`	Parallel browsers
`timeout`	number	✗	`45000`	Timeout in ms
`headless`	boolean	✗	`true`	Headless mode
`viewport`	object	✗	`{}`	Default viewport
`storage`	object	✗	`{}`	Storage config
`diffing`	object	✗	`{}`	Diff settings
`variants`	object	✗	`{}`	Variant dimensions
`scenarios`	array	✓	`[]`	Scenario definitions

Viewport

JSON

{
  "viewport": {
    "width": 1280,
    "height": 720,
    "deviceScaleFactor": 2
  }
}

Property	Type	Default	Description
`width`	number	`1280`	Width in pixels
`height`	number	`720`	Height in pixels
`deviceScaleFactor`	number	`1`	Pixel density

Storage

Platform Mode

JSON

{ "storage": { "type": "reshot" } }

S3

JSON

{
  "storage": {
    "type": "s3",
    "bucket": "my-bucket",
    "region": "us-east-1",
    "pathPrefix": "docs",
    "publicDomain": "https://cdn.example.com"
  }
}

R2

JSON

{
  "storage": {
    "type": "r2",
    "bucket": "my-bucket",
    "accountId": "account-id",
    "publicDomain": "https://cdn.example.com"
  }
}

Local

JSON

{
  "storage": {
    "type": "local",
    "outputDir": "./public/assets",
    "publicDomain": "/assets"
  }
}

Diffing

JSON

{
  "diffing": {
    "enabled": true,
    "threshold": 0.1,
    "includeAA": false
  }
}

Property	Type	Default	Description
`enabled`	boolean	`true`	Enable diffing
`threshold`	number	`0.1`	Sensitivity (0-1)
`includeAA`	boolean	`false`	Include anti-aliasing

Scenarios

JSON

{
  "scenarios": [
    {
      "name": "login-flow",
      "timeout": 60000,
      "viewport": { "width": 1920, "height": 1080 },
      "steps": []
    }
  ]
}

Property	Type	Required	Description
`name`	string	✓	Unique scenario name
`timeout`	number	✗	Override global timeout
`viewport`	object	✗	Override global viewport
`steps`	array	✓	Step definitions

Steps

See Step API Reference for all step types.