diff options
Diffstat (limited to 'exampleSite/config.yml')
| -rw-r--r-- | exampleSite/config.yml | 181 |
1 files changed, 181 insertions, 0 deletions
diff --git a/exampleSite/config.yml b/exampleSite/config.yml new file mode 100644 index 0000000..f731012 --- /dev/null +++ b/exampleSite/config.yml @@ -0,0 +1,181 @@ +############################################################ +# +------------------------------------------------------+ # +# | Notes | # +# +------------------------------------------------------+ # +############################################################ + +# Welcome to the cState configuration file! +# +# 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/mistermantas/cstate/issues + +############################################################ +# +------------------------------------------------------+ # +# | Basic metadata | # +# +------------------------------------------------------+ # +############################################################ + +# What is your status page called? +# Shows up in the browser bar and meta tags +title: Example Chat App Status + +# What language is this page in? +# Only alters the html[lang] attribute +languageCode: en-US + +# What is the hostname or path to the root? +# Where is the site hosted? +# +# Slash enables relative links. +# +# Default: / +# Example: https://status.example.com/ +baseURL: / + +############################################################ +# +------------------------------------------------------+ # +# | Preferences | # +# +------------------------------------------------------+ # +############################################################ + +# 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 + +params: + # These are your systems. Change them to + # change the amount of components. + systems: + #- + # name: Client Area + # codename: panel + #- + # name: Minecraft + # codename: mc + #- + # name: Web Hosting + # codename: web + - Gateway + - API + - Media Proxy + + # What header design should we use? + # Default: true + # BOOLEAN; `true`, `false` + useLargeHeaderDesign: false + + # Should we show the logo or the title + # of the status page? + useLogo: false + + # Where is the logo located, if one is + # present at all? + # + # Recommended: png or jpg for best + # browser support! + # logo: /logo.png + + # This is the description that is shown + # in the footer and meta tags. + description: We continuously monitor the status of our services and if there are any interruptions, a note will be posted here. + + # Cplors throughout cState + # + # Defaults: + # + # brand: #181818 + # ok: 228B22 + # warning: DC143C + # down: FF8C00 + # notice: 708090 + brand: 181818 + ok: 228B22 + disrupted: FF8C00 + down: DC143C + notice: 708090 + border: dfdfdf + faded: ccc + + # 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 + +############################################################ +# +------------------------------------------------------+ # +# | Developer | # +# +------------------------------------------------------+ # +############################################################ + + # Custom CSS file + # If you want to add any + # custom styling, you may + # link to one file with all + # your modifications here. + # + # This has *intentionally* + # been left uncommented, + # as it is not an advanced + # feature for developers. + # + # customCSS: /custom.css + + # Custom JavaScript file + # If you want to add any + # custom scripting, you may + # link to one file with all + # your modifications here. + # + # This has *intentionally* + # been left uncommented, + # as it is not an advanced + # feature for developers. + # + # customJS: /custom.js + +############################################################ +# +------------------------------------------------------+ # +# | For developers | # +# +------------------------------------------------------+ # +############################################################ + +# These options affect the core of cState. +# Please do not change them if you do not +# know what you are doing. +theme: cstate + +# If you are developing locally and want +# to contribute to the cState Git repo, +# please uncomment this option but do not +# forget to re-comment it when +# themesDir: ../.. |