Configuration

Statusfy is easy to configure, supporting different files formats. You define one main config file and the System does its job.

Config File

Without any configuration, Statusfy will use default values in order to make work properly your Status Page System. The configuration file must be placed at the root of your project:

.
├─ config.js
└─ package.json

The essential file for configuring a Statusfy site is ./config.js, which should export a JavaScript object:

module.exports = {
  title: 'Hello Statusfy',
  description: 'Just playing around'
}

Consult the Config Reference for a full list of options.

Alternative Config Formats

You can also use YAML (./config.yml) or TOML (./config.toml) formats for the configuration file:

YAML

YAML is a data serialization language designed to be human-readable. Currently, Statusfy supports the latest specification, version 1.2.

title: Hello Statusfy
description: Just playing around

TOML

TOML is another alternative data serialization language, designed to be easy to read with a "minimal" semantics. Statusfy supports version 0.4.0 of the specification.

title = "Hello Statusfy"
description = "Just playing around"

Example File

module.exports = {
  title: 'Title',
  description: 'Description',
  baseUrl: 'https://demo.statusfy.co',
  analytics: {
    ga: 'UA-XXXXXXXXX-Y',
  },
  defaultLocale: 'en',
  locales: [
    { code: 'en', iso: 'en-US', name: 'English' },
    { code: 'es', iso: 'es-ES', name: 'Español' }
  ],
  content: {
    frontMatterFormat: 'yaml',
    systems: [
      'cdn',
      'conversions',
      'site-delivery',
      'api'
    ]
  },
  theme: {
    scheduled: {
      position: 'aboveGlobalStatus'
    }
  },
  head: {
    link: [
      { rel: 'mask-icon', href: '/icons/safari-pinned-tab.svg', color: '#3e4e88' }
    ]
  }
}