generated from cstate/example
-
Notifications
You must be signed in to change notification settings - Fork 0
/
config.yml
426 lines (389 loc) · 11.6 KB
/
config.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
############################################################
# +------------------------------------------------------+ #
# | 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: Mixr 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:
# baseUrl: https://status.example.com/
#
# For testing:
# baseUrl: http://localhost
#
# Broken example:
# baseUrl: /
baseURL: https://signal18.github.io/cstate-mixr
# For features like Last modified, you
# need to use a Git repository. If you
# are using Netlify, you are already
# using Git (with GitHub, GitLab, etc)
#
# So, should Git information be used
# for this website?
#
# We recommend to keep this at `true`.
# BOOLEAN; `true`, `false`
enableGitInfo: true
############################################################
# +------------------------------------------------------+ #
# | 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.
#
# These are case sensitive.
#
# For help, see the wiki:
# https://github.com/cstate/cstate/wiki/Customization
categories:
- name: North East America
description: Some servers are located here.
closed: false
- name: Ouest South America
description: Some servers are located here.
closed: false
- name: Europe
description: Some servers are located here.
- name: Uncategorized
untitled: true
- name: Empty Category
systems:
- name: Backup Gateway
category: Uncategorized
- name: MixR API
category: North East America
link: http://ca.mixr.net/
description: This is the service responsible for serving API. It is reliant on our CDN.
- name: MixR S3
link: http://s3-ca.mixr.net/
description: This is the service responsible for serving images, audio, and video. It is reliant on our CDN.
category: North East America
- name: MixR API
category: Ouest South America
link: http://us.mixr.net/
description: This is the service responsible for serving API. It is reliant on our CDN.
- name: MixR S3
link: http://s3-us.mixr.net/
description: This is the service responsible for serving images, audio, and video. It is reliant on our CDN.
category: Ouest South America
- name: MixR API
category: Europe
link: http://fr.mixr.net/
description: This is the service responsible for serving API. It is reliant on our CDN.
- name: MixR S3
link: http://s3-fr.mixr.net/
description: This is the service responsible for serving images, audio, and video. It is reliant on our CDN.
category: Europe
# 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 UTC
shortDateFormat: 15:04 UTC — Jan 2
# Should relative time (x min ago) be used?
#
# IMPORTANT: In the frontmatter, the dates MUST be in
# the UTC time zone for this to work preperly. If you
# use Netlify CMS, all good — the CMS picks UTC time
# by default. Otherwise, there may be very inaccurate
# times if multiple time zones are in your issue files.
#
# FOR YOUR CONSIDERATION: This feature was introduced in
# v5. It may be a breaking change in the case when you
# wish to use relative time but old issues do not have
# UTC time (and therefore are out of sync by ±24 hours)
#
# Read the wiki for more:
# https://github.com/cstate/cstate/wiki/Customization#time
#
# If enabled, will display relative times in places like
# the incident history and summaries instead of using
# dateFormat and shortDateFormat (except for if you use
# the old shortcode).
#
# Default: `true`
# BOOLEAN; `true`, `false`
useRelativeTime: true
# If enabled, doesn't show seconds on relative times.
#
# With option ON (true):
# "Last checked <1 min ago"
#
# With option OFF (false; default):
# "Last checked 20s ago"
#
# Default: `false`
# BOOLEAN; `true`, `false`
skipSeconds: false
# Should there be an automatic "Last updated"
# text shown below issues?
#
# Default: `true`
# BOOLEAN; `true`, `false`
enableLastMod: 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-mixr.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
term:
- html
- json
- rss
- svg
outputFormats:
svg:
isPlainText: true
mediaType: image/svg+xml