@@ -83,7 +83,7 @@ defaultContentLanguage: en
8383# What is the hostname or path to the root?
8484# Where is the site hosted?
8585#
86- # 💥 cState & Hugo don’t support '/' in
86+ # ❗ cState & Hugo don’t support '/' in
8787# production use. It will break RSS
8888# feeds and breaks permalinks since
8989# version 3. If you are just testing,
@@ -99,17 +99,51 @@ baseURL: https://cstate.mnts.lt
9999# ###########################################################
100100
101101params :
102+ # Before setting up your systems, you need
103+ # to first define at least one category.
104+ #
105+ # Categories are shown in the order that
106+ # you define in this config file.
107+ #
108+ # Categories can have a:
109+ # - name
110+ # - description
111+ # - closed boolean `closed: true`
112+ # That would collapse the category upon first load
113+ # and the user can expand by clicking on the category
114+ # (Requires JavaScript.)
115+ # - untitled boolean `untitled: true`
116+ # This would complerely hide the name of the category.
117+ # This is useful, if you do not want to use categories
118+ # because you need to set an 'Uncategorized' category.
119+ # Or it can be used alongside other categories.
120+ #
121+ # For help, see the wiki:
122+ # https://github.com/cstate/cstate/wiki/Customization
123+ categories :
124+ - name : North Coast
125+ description : The main servers are located here.
126+ closed : true
127+ - name : East Coast
128+ - name : Uncategorized
129+ untitled : true
130+
102131 # These are your systems. Change them to
103132 # change the amount of components.
104133 #
105134 # For help, see the wiki:
106135 # https://github.com/cstate/cstate/wiki/Customization
107136 systems :
108137 - name : Gateway
138+ category : North Coast
139+ - name : Backup Gateway
140+ category : East Coast
109141 - name : API
110142 description : The guts of the application.
143+ category : Uncategorized
111144 - name : Media Proxy
112145 description : This is the service responsible for serving images, audio, and video. It is reliant on our CDN.
146+ category : Uncategorized
113147
114148 # What date format to use?
115149 #
@@ -129,6 +163,30 @@ params:
129163 # BOOLEAN; `true`, `false`
130164 useLargeHeaderDesign : false
131165
166+ # Should incident history be separated
167+ # like in an archive view?
168+ #
169+ # Note: This WILL disable pagination.
170+ #
171+ # Default: `yearly`
172+ # STRING; `monthly`, `yearly`, `none`
173+ incidentHistoryFormat : " yearly"
174+
175+ # Disable dark mode
176+ #
177+ # If your OS and browser support the
178+ # `prefers-color-scheme` media query,
179+ # cState will automatically switch to
180+ # a darker user interface.
181+ #
182+ # cState uses its built-in colors for
183+ # most of the interface to ensure
184+ # a good user experience.
185+ #
186+ # Default: false
187+ # BOOLEAN; `true`, `false`
188+ disableDarkMode : false
189+
132190 # Should we show the logo or the title
133191 # of the status page?
134192 #
@@ -179,20 +237,22 @@ params:
179237 incidentPostsPerPage : 10
180238
181239 # Colors throughout cState
182- # HEX codes without the #
240+ #
241+ # We recommend using HEX
242+ # (with the # symbol).
183243 #
184244 # Defaults:
185245 #
186- # brand: "0a0c0f"
187- # ok: "008000"
188- # disrupted: "cc4400"
189- # down: "e60000"
190- # notice: "24478f"
191- brand : " 0a0c0f"
192- ok : " 008000"
193- disrupted : " cc4400"
194- down : " e60000"
195- notice : " 24478f"
246+ # brand: "# 0a0c0f"
247+ # ok: "# 008000"
248+ # disrupted: "# cc4400"
249+ # down: "# e60000"
250+ # notice: "# 24478f"
251+ brand : " # 0a0c0f"
252+ ok : " # 008000"
253+ disrupted : " # cc4400"
254+ down : " # e60000"
255+ notice : " # 24478f"
196256
197257 # If the status page shows that
198258 # there are disruptions or outages
@@ -229,3 +289,16 @@ preserveTaxonomyNames: true
229289
230290taxonomies :
231291 affected : affected
292+
293+ outputs :
294+ page :
295+ - html
296+ - json
297+ section :
298+ - html
299+ - json
300+ - rss
301+ home :
302+ - html
303+ - json
304+ - rss
0 commit comments