Poliage

Configuration Schema

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

Root Properties

{
  "baseUrl": "http://localhost:3000",
  "assetDir": ".poliage/output",
  "concurrency": 2,
  "timeout": 45000,
  "headless": true,
  "viewport": {},
  "storage": {},
  "diffing": {},
  "variants": {},
  "scenarios": []
}
PropertyTypeRequiredDefaultDescription
baseUrlstring-Base URL for your application
assetDirstring.poliage/outputOutput directory
concurrencynumber2Parallel browsers
timeoutnumber45000Timeout in ms
headlessbooleantrueHeadless mode
viewportobject{}Default viewport
storageobject{}Storage config
diffingobject{}Diff settings
variantsobject{}Variant dimensions
scenariosarray[]Scenario definitions


Viewport

{
  "viewport": {
    "width": 1280,
    "height": 720,
    "deviceScaleFactor": 2
  }
}
PropertyTypeDefaultDescription
widthnumber1280Width in pixels
heightnumber720Height in pixels
deviceScaleFactornumber1Pixel density


Storage

Platform Mode

{ "storage": { "type": "poliage" } }

S3

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

R2

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

Local

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


Diffing

{
  "diffing": {
    "enabled": true,
    "threshold": 0.1,
    "includeAA": false
  }
}
PropertyTypeDefaultDescription
enabledbooleantrueEnable diffing
thresholdnumber0.1Sensitivity (0-1)
includeAAbooleanfalseInclude anti-aliasing


Scenarios

{
  "scenarios": [
    {
      "name": "login-flow",
      "timeout": 60000,
      "viewport": { "width": 1920, "height": 1080 },
      "steps": []
    }
  ]
}
PropertyTypeRequiredDescription
namestringUnique scenario name
timeoutnumberOverride global timeout
viewportobjectOverride global viewport
stepsarrayStep definitions


Steps

See Step API Reference for all step types.