azion.config.js file

The azion.config.js file is a configuration file created during the application’s build process, based on the chosen preset, and serves as the source of truth for the configuration. Each preset provides a set of default settings, which can be replaced by the user. If the file is deleted, the default configuration will be recreated the next time the build process is triggered.

The configurations set by this file include:

Origins
Cache Settings
Rules Engine
Network List

The following tables explain the properties of this configuration file.

origin

Property	Type	Expected values	Error message
name	string		The ‘name’ field must be a string
type	string	`single_origin` (default) `load_balancer` `live_ingest**` `object_storage`	The ‘type’ field must be a string
bucket	string, null		The ‘bucket’ field must be a string or null
prefix	string, null		The ‘prefix’ field must be a string or null
addresses	array		The ‘address’ field must be a string
hostHeader	string		The ‘hostHeader’ field must be a string
additionalProperties	boolean		No additional properties are allowed in origin item objects

cache

Property	Type	Expected values	Error message
name	string		The ‘name’ field must be a string
stale	boolean		The ‘stale’ field must be a boolean
queryStringSort	boolean		The ‘queryStringSort’ field must be a boolean
methods -> post	boolean		The ‘post’ field must be a boolean
methods -> options	boolean		The ‘options’ field must be a boolean
methods -> additionalProperties	boolean		No additional properties are allowed in the ‘methods’ object
browser -> maxAgeSeconds	number OR string (mathematical expression)	0 ≤ value ≥ 31536000	The ‘maxAgeSeconds’ field must be a number or a valid mathematical expression
browser -> additionalProperties	boolean		No additional properties are allowed in the ‘browser’ object
browser -> required	array		The ‘maxAgeSeconds’ field is required in the ‘browser’ object
edge -> maxAgeSeconds	number OR string (a mathematical expression)	60 ≤ value ≥ 31536000	The ‘maxAgeSeconds’ field must be a number or a valid mathematical expression
edge -> additionalProperties	boolean		No additional properties are allowed in the ‘edge’ object
edge -> required	array		The ‘maxAgeSeconds’ field is required in the ‘edge’ object

rules

Request rules

Property	Type	Error message
name	string	The ‘name’ field must be a string
match	string	The ‘match’ field must be a string
setOrigin -> name	string	The ‘name’ field must be a string
setOrigin -> type	string	The ‘type’ field must be a string
setOrigin -> additionalProperties	boolean	No additional properties are allowed in the ‘setOrigin’ object
setOrigin -> required	array	The ‘name or type’ field is required in the ‘setOrigin’ object
behavior -> rewrite	function	The behavior of the rewrite
setHeaders	string, null	The ‘setHeaders’ field must be a string or null
forwardCookies	boolean, null	The ‘forwardCookies’ field must be a boolean or null
setCookie	string, null	The ‘setCookie’ field must be a string or null
deliver	boolean, null	The ‘deliver’ field must be a boolean or null
runFunction -> path	string	The ‘path’ field must be a string
runFunction -> name	string, null	The ‘name’ field can be a string or null
runFunction -> additionalProperties	boolean	No additional properties are allowed in the ‘runFunction’ object
runFunction -> required	array	The ‘path’ field is required in the ‘runFunction’ object
cache	string OR object	The ‘cache’ field must be either a string or an object with specified properties
cache -> name (when cache is an object)	string	The ‘name’ field must be a string
cache -> browser_cache_settings_maximum_ttl (when cache is an object)	number, null	The ‘browser_cache_settings_maximum_ttl’ field must be a number or null
cache -> cdn_cache_settings_maximum_ttl (when cache is an object)	number, null	The ‘cdn_cache_settings_maximum_ttl’ field must be a number or null
cache -> additionalProperties (when cache is an object)	boolean	No additional properties are allowed in the cache object
cache -> required (when cache is an object)	array	The ‘name’ field is required in the cache object
redirectTo301	string	The ‘redirectTo301’ field must be a string
enableGZIP	boolean	The ‘enableGZIP’ field must be a boolean
redirectTo302	string	The ‘redirectTo302’ field must be a string
filterCookie	string	The ‘filterCookie’ field must be a string
variable	string	The ‘variable’ field must be a string
bypassCache	boolean	The ‘bypassCache’ field must be a boolean
redirectHttps	boolean	The ‘redirectHttps’ field must be a boolean

Response rules

Property	Type	Error message
name	string	The ‘name’ field must be a string
description	string	The ‘description’ field must be a string
active	boolean	The ‘active’ field must be a boolean
match	string	The ‘match’ field must be a string
variable	string	The ‘variable’ field must be a string
behavior -> setCookie	string, null	The ‘setCookie’ field must be a string or null
behavior -> setHeaders	array of strings	Each item in ‘setHeaders’ must be a string
behavior -> deliver	boolean, null	The ‘deliver’ field must be a boolean or null
behavior -> capture -> match	string	The ‘match’ field must be a string
behavior -> capture -> captured	string	The ‘captured’ field must be a string
behavior -> capture -> subject	string	The ‘subject’ field must be a string
behavior -> enableGZIP	boolean, null	The ‘enableGZIP’ field must be a boolean or null
behavior -> filterCookie	string, null	The ‘filterCookie’ field must be a string or null
behavior -> filterHeader	string, null	The ‘filterHeader’ field must be a string or null
behavior -> runFunction -> path	string	The ‘path’ field must be a string
behavior -> runFunction -> name	string, null	The ‘name’ field can be a string or null
behavior -> redirectTo301	string, null	The ‘redirectTo301’ field must be a string or null
behavior -> redirectTo302	string, null	The ‘redirectTo302’ field must be a string or null

network list

Property	Type	Error message
id	number	The ‘id’ field must be a number
listType	string	The ‘listType’ field must be a string
listContent	array	The ‘listContent’ field must be an array of strings

For further information, access azion.config.js schema in Vulcan repository.

Example

module.exports = {
    origin: [
      {
        name: 'myneworigin',
        type: 'object_storage',
        bucket: 'blue-courage',
        prefix: '0101010101001',
      },
    ],
    cache: [
      {
        name: 'mycache',
        stale: false,
        queryStringSort: false,
        methods: {
          post: false,
          options: false,
        },
        browser: {
          maxAgeSeconds: 1000 * 5,
        },
        edge: {
          maxAgeSeconds: 1000,
        },
      },
    ],
    rules: {
      request: [
        {
          name: 'name1',
          cache: 'mycache',
          match: '^(./)([^/])$',
          behavior: {
            rewrite: `/index.html`,
          },
        },
        {
          name: 'name1qwqqeweqwe',
          match: '^(./)([^/])$',
          behavior: {
          rewrite: `/index.html`,
          },
          setCookie: '',
          setHeaders: '',
          forwardCookies: false,
          },
        {
          name: 'name2',
          match: '/^/_statics/;', // start with /_statics
          setOrigin: {
            name: 'myneworigin',
            type: 'object_storage',
          },
          deliver: true,
        },
        {
          name: 'name3',
          match: '/^compute/;', // start with /compute
          runFunction: {
            path: '.edge/worker.js',
          },
        },
      ],
    },
  };