############################################################ # +------------------------------------------------------+ # # | Notes | # # +------------------------------------------------------+ # ############################################################ # Welcome to the cState configuration file! # # If you are using an earlier version, or one # in the future, such as v8.0 you may see errors # pop up when deploying a cState website. # # Now, onto the fun part. # # Hugo is used for building the status page, # so this file can be used to change how # your status page should behave or look. # # If you want to use special characters, # such as accented letters, you MUST save # the file as UTF-8, not ANSI. # # If cState does not load, ensure that: # - No tabs are present; # YAML only allows spaces # - Indents are correct # YAML hierarchy is based entirely on indentation # - You have "escaped" all apostrophes # in your text: If you want to write "don't", # for example, write "don''t" instead! # Note the doubled apostrophe. # - Text with symbols is enclosed in single # or double quotation marks. # # If you have problems, create an issue on GitHub: # https://github.com/cstate/cstate/issues ############################################################ # +------------------------------------------------------+ # # | Basic metadata | # # +------------------------------------------------------+ # ############################################################ # What is your status page called? # Shows up in the browser bar and meta tags title: Eggsample Status # Should posts, which have a publish date # from the future, be built? Useful for # sharing upcoming maintenance, etc. # # We recommend to keep this at `true`. # BOOLEAN; `true`, `false` buildFuture: true # What language do you want to use for the # html[lang] definition? # # Does not change language of site # itself. # # Default: `en` # ISO 639-1 defines abbreviations. # # See: https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes # Also: https://www.w3schools.com/tags/ref_language_codes.asp languageCode: en # What translation file should cState use? # You can also define whether missing # translations should get placeholders. # # For defaultContentLanguage— # Default: `en` # # For enableMissingTranslationPlaceholders— # do not set it to true for languages other # than English! When tested with Lithuanian, # it would add unnecesary placeholders to # values that were intentionally empty. defaultContentLanguage: en # What is the hostname or path to the root? # Where is the site hosted? # # ❗ cState & Hugo don’t support '/' in # production use. It will break RSS # feeds and breaks permalinks since # version 3. If you are just testing, # localhost should automatically work. # # Example: https://status.example.com/ baseURL: https://cstate.mnts.lt ############################################################ # +------------------------------------------------------+ # # | Preferences | # # +------------------------------------------------------+ # ############################################################ params: # Before setting up your systems, you need # to first define at least one category. # # Categories are shown in the order that # you define in this config file. # # Categories can have a: # - name # - description # - closed boolean `closed: true` # That would collapse the category upon first load # and the user can expand by clicking on the category # (Requires JavaScript.) # - untitled boolean `untitled: true` # This would complerely hide the name of the category. # This is useful, if you do not want to use categories # because you need to set an 'Uncategorized' category. # Or it can be used alongside other categories. # # For help, see the wiki: # https://github.com/cstate/cstate/wiki/Customization categories: - name: North Coast description: The main servers are located here. closed: true - name: East Coast - name: Uncategorized untitled: true # These are your systems. Change them to # change the amount of components. # # For help, see the wiki: # https://github.com/cstate/cstate/wiki/Customization systems: - name: Gateway category: North Coast - name: Backup Gateway category: East Coast - name: API description: The guts of the application. category: Uncategorized - name: Media Proxy description: This is the service responsible for serving images, audio, and video. It is reliant on our CDN. category: Uncategorized # What date format to use? # # Hugo formatting docs: # https://gohugo.io/functions/format/#hugo-date-and-time-templating-reference # # Technical: GOLANG/HUGO .Date.Format & dateFormat # # dateFormat Default: "January 2, 2006 at 3:04 PM" # shortDateFormat Default: "15:04 — Jan 2" dateFormat: January 2, 2006 at 3:04 PM shortDateFormat: 15:04 — Jan 2 # If enabled, will display relative times for incident history and summaries instead of using dateFormat. # # Default: true useRelativeTime: true # What header design should we use? # # Default: true # BOOLEAN; `true`, `false` useLargeHeaderDesign: false # Should incident history be separated # like in an archive view? # # Note: This WILL disable pagination. # # Default: `yearly` # STRING; `monthly`, `yearly`, `none` incidentHistoryFormat: "yearly" # Should incident history be hidden? # # By disabling the incident history, you also disable # the RSS feed. To ensure no incidents are shown, you # should delete them after they are resolved. This option # overrides any other options that tailor your incident # history’s look. # # Default: `false` # BOOLEAN; `true`, `false` disableIncidentHistory: false # Disable dark mode # # If your OS and browser support the # `prefers-color-scheme` media query, # cState will automatically switch to # a darker user interface. # # cState uses its built-in colors for # most of the interface to ensure # a good user experience. # # Default: `false` # BOOLEAN; `true`, `false` disableDarkMode: false # Should we show the logo or the title # of the status page? # # Default: false # BOOLEAN; `true`, `false` useLogo: true # Where is the logo located, if one is # present at all? # # Recommended: png is best used for # images like logos. # # Recommended: png, bmp, jpg, or gif # for best browser support! logo: logo.png # This is the description that is shown # on the footer and meta tags. # # Default: We continuously monitor the status of our services and if there are any interruptions, a note will be posted here. description: We continuously monitor the status of our services and if there are any interruptions, a note will be posted here. # Tabs on homepage # Uncomment to enable. # # Format: # customTabs: # - # name: Name # link: https://example.com # Disable complex server-side # calculations that may impact # your build performance # # Disables math calculations # for average downtime on # systems ("/affected/") pages # # Default: false # BOOLEAN; `true`, `false` disableComplexCalculations: false # Incident posts shown # in one page # # NUMERIC; Default: `10` incidentPostsPerPage: 10 # Colors throughout cState # # We recommend using HEX # (with the # symbol). # # Defaults: # # brand: "#0a0c0f" # ok: "#008000" # disrupted: "#cc4400" # down: "#e60000" # notice: "#24478f" brand: "#0a0c0f" ok: "#008000" disrupted: "#cc4400" down: "#e60000" notice: "#24478f" # If the status page shows that # there are disruptions or outages # happening, should it keep the # brand header color or drop it # and use the status indication # colors that were just defined? # # Default: `true` # BOOLEAN; `true`, `false` alwaysKeepBrandColor: true # Introduced in v4.0.1 for consistent # site title text color. # # If you do not use the logo, what color # should the site text color be? # # Removing this option will not force # any site text color. This is likely # unwanted behavior. # # Default: `white` # STRING; `white`, `black`, or nothing headerTextColor: white # Google Analytics tracking code # # By default, cState does not use # Google Analytics. If you choose # to use it, you may change the # placeholder code below to your # own and thereby enable the # tracking service. # # To disable the analytics, change # the value to the default: # # Default: UA-00000000-1 googleAnalytics: UA-00000000-1 # These options affect the core of cState. # Please do not change them if you do not # know what you are doing. theme: cstate preserveTaxonomyNames: true taxonomies: affected: affected outputs: page: - html - json section: - html - json - rss home: - html - json - rss - svg outputFormats: svg: isPlainText: true mediaType: image/svg+xml