Config Object

Default Config

Full JSON Config Object Defaults

{
  "accessControl": {
    "adminApi": {
      "enable": true,
      "basicAuth": {
        "enable": false,
        "username": "",
        "password": ""
      }
    }
  },
  "appendImagizerUserAgent": false,
  "addRequestHeaders": [],
  "addResponseHeaders": [],
  "allowAnimatedGifs": false,
  "allowAnimatedGifsParam": false,
  "allowDynamicOrigin": true,
  "allowOriginalImageRequest": true,
  "allowNonImageFiles": false,
  "applicationWorkers": {
    "autoConfig": true,
    "process": 10,
    "queue": 0
  },
  "autoQuality": {
    "method": "ssim",
    "preset": "medium",
    "presets": {
      "ssim": {
        "low": 0.999,
        "medium": 0.9999,
        "high": 0.99995,
        "veryhigh": 0.99999
      },
      "mpe": {
        "low": 1.5,
        "medium": 1,
        "high": 0.8,
        "veryhigh": 0.6
      },
      "smallfry": {
        "low": 100.75,
        "medium": 102.25,
        "high": 103.8,
        "veryhigh": 105.5
      }
    },
    "qualityMin": 40,
    "qualityMax": 90
  },
  "awsAuthorization": {
    "enable": false,
    "bucket": "",
    "key": "",
    "secret": "",
    "sessionToken": "",
    "region": "",
    "pathPrefix": "",
    "endpoint": ""
  },
  "awsSystemsManager": {
    "enable": false,
    "region": "",
    "key": "",
    "secret": ""
  },
  "backBlazeB2": {
    "enable": false,
    "keyId": "",
    "applicationKey": "",
    "bucket": ""
  },
  "backend": "http://s3.amazonaws.com",
  "backendTimeout": 15,
  "backendConnectTimeout": 3,
  "backendSslVersion": "CURL_SSLVERSION_DEFAULT",
  "blacklistPattern": "",
  "bucketsAllowed": [],
  "cache": "memory",
  "cacheControl": {
    "override": false,
    "browserCacheTtl": 1800,
    "serverCacheTtl": 2678400
  },
  "cluster": {
    "enable": false,
    "hashBalanceFactor": 125,
    "includeQueryStringInHash": false,
    "awsAutoScaleSync": false,
    "awsAutoScalingGroupDiscovery": {
      "enable": false,
      "region": "us-east-1",
      "tags": []
    },
    "nodes": [],
    "includeLocalBackupServer": true,
    "digitalOcean": {
      "enable": false,
      "token": "",
      "tag": ""
    },
    "awsServiceDiscovery": {
      "enable": false,
      "region": "us-east-1",
      "namespaceName": "",
      "serviceName": ""
    }
  },
  "consul": {
    "enable": false,
    "endpoint": "",
    "method": "PUT",
    "payload": null
  },
  "defaultImages": {
    "missing": "",
    "error": "",
    "shouldProcess": false,
    "return200Response": true
  },
  "defaultImageParams": [],
  "defaultMobileImageParams": [],
  "displayWelcomePage": true,
  "enablePostToProcess": false,
  "healthCheck": {
    "enable": true,
    "memoryThreshold": 95,
    "cpuThreshold": 95,
    "rootDiskThreshold": 90,
    "tmpDiskThreshold": 90,
    "http5XXThreshold": 0,
    "checkInterval": 15,
    "logInterval": 60,
    "logStats": true
  },
  "fallbackBackend": {
    "enable": false,
    "awsAuthorization": {
      "enable": false,
      "bucket": "",
      "key": "",
      "secret": "",
      "sessionToken": "",
      "region": "",
      "pathPrefix": "",
      "endpoint": ""
    },
    "backBlazeB2": {
      "enable": false,
      "keyId": "",
      "applicationKey": "",
      "bucket": ""
    },
    "backend": "",
    "backendTimeout": 15,
    "backendConnectTimeout": 3,
    "fallbackErrorCodes": [
      404,
      403
    ]
  },
  "faceDetectionWidth": 600,
  "hostsAllowed": [],
  "hostsAllowedRegex": [],
  "hostConfigs": [],
  "hostname": {
    "staticHostname": "",
    "reverseDnsLookup": false
  },
  "ignoreCertWarnings": false,
  "ignoreFormats": [],
  "imageParamsAllowed": [],
  "imageParamValidations": [],
  "libjpeg": 0,
  "logging": {
    "enable": false,
    "appLogLevel": "info",
    "cloudWatch": {
      "enable": false,
      "region": "us-east-1",
      "key": "",
      "secret": ""
    },
    "dataDog": {
      "enable": false,
      "key": "",
      "namespace": "imagizer",
      "tags": []
    },
    "legacy": false,
    "local": false,
    "services": [
      "imagizer_access",
      "imagizer_access_err",
      "imagizer_admin_access",
      "imagizer_admin_access_err",
      "imagizer_app",
      "imagizer_system",
      "imagizer_stats_collector",
      "imagizer_health"
    ],
    "syslog": {
      "enable": false,
      "server": "",
      "port": 514,
      "facility": "local7",
      "protocol": "udp"
    },
    "trustedProxies": []
  },
  "maxImageDimensions": {
    "enable": true,
    "width": 5000,
    "height": 5000
  },
  "nessusAgent": {
    "enable": false,
    "key": "",
    "flags": [
      "--cloud"
    ]
  },
  "passThroughRequestHeaders": [],
  "passThroughResponseHeaders": [],
  "passNonImagizerParamsToOrigin": true,
  "presetColors": [],
  "qualityPresets": {
    "low": 50,
    "medium": 75,
    "high": 90,
    "veryhigh": 100
  },
  "stats": {
    "enable": false,
    "ganglia": {
      "enable": false,
      "host": "",
      "port": 8649,
      "protocol": "udp",
      "spoofHostFromInterface": ""
    },
    "cloudWatch": {
      "enable": false,
      "region": "us-east-1",
      "key": "",
      "secret": ""
    },
    "dataDog": {
      "enable": false,
      "key": "",
      "namespace": "imagizer",
      "tags": []
    },
    "prometheus": {
      "enable": false,
      "namespace": "imagizer"
    }
  },
  "secureWebProxy": {
    "enable": false,
    "host": "",
    "port": 0
  },
  "sentinelOne": {
    "enable": false,
    "registered": false,
    "token": ""
  },
  "separateMobileCache": false,
  "separateWebpCache": true,
  "separateHostCache": false,
  "signedUrls": {
    "enable": false,
    "signatureKeys": [],
    "onlyParameters": []
  },
  "svgSanitize": "strip",
  "upscaleAllowed": false,
  "urlRewrites": [],
  "webProxy": {
    "enable": false,
    "host": "",
    "port": 0
  },
  "whitelistPattern": "",
  "layers": {
    "legacyTextRender": false
  }
}
Last Updated:
Contributors: Nicholas Pettas