config.yml 9.56 KB
Newer Older
Mantas's avatar
v2-rc1  
Mantas committed
1
2
3
4
5
6
7
8
9
############################################################
# +------------------------------------------------------+ #
# |                       Notes                          | #
# +------------------------------------------------------+ #
############################################################

# Welcome to the cState configuration file!
#
# If you are using an earlier version, or one
10
# in the future, such as v8.0 you may see errors
Mantas's avatar
v2-rc1  
Mantas committed
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
# 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:
36
# https://github.com/cstate/cstate/issues
Mantas's avatar
v2-rc1  
Mantas committed
37
38
39
40
41
42
43
44
45

############################################################
# +------------------------------------------------------+ #
# |                  Basic metadata                      | #
# +------------------------------------------------------+ #
############################################################

# What is your status page called?
# Shows up in the browser bar and meta tags
anarcat's avatar
anarcat committed
46
title: Tor Project status
Mantas's avatar
v2-rc1  
Mantas committed
47

48
49
50
51
52
53
54
55
56
57
# 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?
Mantas's avatar
v2-rc1  
Mantas committed
58
#
59
60
61
62
# Does not change language of site
# itself.
#
# Default: `en`
Mantas's avatar
v2-rc1  
Mantas committed
63
# ISO 639-1 defines abbreviations.
64
#
Mantas's avatar
v2-rc1  
Mantas committed
65
66
67
68
# See:  https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes
# Also: https://www.w3schools.com/tags/ref_language_codes.asp
languageCode: en

69
70
71
72
73
74
75
76
77
78
79
80
81
82
# 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

Mantas's avatar
v2-rc1  
Mantas committed
83
84
85
# What is the hostname or path to the root?
# Where is the site hosted?
#
Mantas Vilčinskas's avatar
v4.0    
Mantas Vilčinskas committed
86
# ❗ cState & Hugo don’t support '/' in
87
88
89
90
# production use. It will break RSS
# feeds and breaks permalinks since
# version 3. If you are just testing,
# localhost should automatically work.
Mantas's avatar
v2-rc1  
Mantas committed
91
92
#
# Example: https://status.example.com/
anarcat's avatar
anarcat committed
93
baseURL: https://status.torproject.org/
Mantas's avatar
v2-rc1  
Mantas committed
94
95
96
97
98
99
100
101

############################################################
# +------------------------------------------------------+ #
# |                   Preferences                        | #
# +------------------------------------------------------+ #
############################################################

params:
Mantas Vilčinskas's avatar
v4.0    
Mantas Vilčinskas committed
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
  # 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:
anarcat's avatar
anarcat committed
124
125
126
    - name: Tor network
    - name: TPA
      description: internal Tor services
Mantas Vilčinskas's avatar
v4.0    
Mantas Vilčinskas committed
127
128
129
130
      closed: true
    - name: Uncategorized
      untitled: true

Mantas's avatar
v2-rc1  
Mantas committed
131
132
133
134
  # These are your systems. Change them to
  # change the amount of components.
  #
  # For help, see the wiki:
135
  # https://github.com/cstate/cstate/wiki/Customization
Mantas's avatar
v2-rc1  
Mantas committed
136
  systems:
anarcat's avatar
anarcat committed
137
138
139
140
141
142
143
144
145
    - name: v3 services
      category: Tor network
    - name: v2 services
      category: Tor network
    - name: directory authorities
      description: whatever it is that those things do
      category: Tor network
    - name: check.tpo
      description: the check.torproject.org website
anarcat's avatar
anarcat committed
146
      category: Tor network
anarcat's avatar
anarcat committed
147
148
    - name: GitLab
      description: gitlab.torproject.org
anarcat's avatar
anarcat committed
149
150
151
152
153
154
155
156
157
158
159
160
161
      category: TPA
    - name: Email
      description: general email delivery
      category: TPA
    - name: lists
      description: mailing lists (mailman)
      category: TPA
    - name: gitolite
      description: read/write access to git
      category: TPA
    - name: websites
      description: the many websites under torproject.org
      category: TPA
anarcat's avatar
anarcat committed
162
    - name: other
Mantas Vilčinskas's avatar
v4.0    
Mantas Vilčinskas committed
163
      category: Uncategorized
Mantas's avatar
v2-rc1  
Mantas committed
164

165
166
167
168
169
170
171
172
173
174
175
176
  # 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

Mantas's avatar
v2-rc1  
Mantas committed
177
178
179
180
181
182
  # What header design should we use?
  #
  # Default: true
  # BOOLEAN; `true`, `false`
  useLargeHeaderDesign: false

Mantas Vilčinskas's avatar
v4.0    
Mantas Vilčinskas committed
183
184
185
186
187
188
189
190
191
  # Should incident history be separated
  # like in an archive view?
  #
  # Note: This WILL disable pagination.
  #
  # Default: `yearly`
  # STRING; `monthly`, `yearly`, `none`
  incidentHistoryFormat: "yearly"

Mantas Vilčinskas's avatar
Mantas Vilčinskas committed
192
193
194
195
196
197
198
199
200
201
202
203
  # 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

Mantas Vilčinskas's avatar
v4.0    
Mantas Vilčinskas committed
204
205
206
207
208
209
210
211
212
213
214
  # 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.
  #
Mantas Vilčinskas's avatar
v4.0.1    
Mantas Vilčinskas committed
215
  # Default: `false`
Mantas Vilčinskas's avatar
v4.0    
Mantas Vilčinskas committed
216
217
218
  # BOOLEAN; `true`, `false`
  disableDarkMode: false

Mantas's avatar
v2-rc1  
Mantas committed
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
  # 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!
Mantas Vilčinskas's avatar
Mantas Vilčinskas committed
234
  logo: logo.png
Mantas's avatar
v2-rc1  
Mantas committed
235
236

  # This is the description that is shown
237
  # on the footer and meta tags.
Mantas's avatar
v2-rc1  
Mantas committed
238
239
  #
  # Default: We continuously monitor the status of our services and if there are any interruptions, a note will be posted here.
240
241
242
243
244
  description: |
    We continuously monitor the status of our services and if there
    are any interruptions, a note will be posted here. If you need to
    do a modification on this page, [follow the
    documentation](https://gitlab.torproject.org/tpo/tpa/team/-/wikis/service/status) ([mirror](https://web.archive.org/web/2/https://gitlab.torproject.org/tpo/tpa/team/-/wikis/service/status)).
Mantas's avatar
v2-rc1  
Mantas committed
245
246
247
248
249
250
251
252
253
254

  # Tabs on homepage
  # Uncomment to enable.
  #
  # Format:
  # customTabs:
  #  -
  #    name: Name
  #    link: https://example.com

Mantas Vilčinskas's avatar
v4.1.0    
Mantas Vilčinskas committed
255
256
257
  # Disable complex server-side
  # calculations that may impact
  # your build performance
Mantas's avatar
v2-rc1  
Mantas committed
258
  #
Mantas Vilčinskas's avatar
v4.1.0    
Mantas Vilčinskas committed
259
260
261
  # Disables math calculations
  # for average downtime on
  # systems ("/affected/") pages
Mantas's avatar
v2-rc1  
Mantas committed
262
  #
Mantas Vilčinskas's avatar
v4.1.0    
Mantas Vilčinskas committed
263
  # Default: false
Mantas's avatar
v2-rc1  
Mantas committed
264
  # BOOLEAN; `true`, `false`
Mantas Vilčinskas's avatar
v4.1.0    
Mantas Vilčinskas committed
265
  disableComplexCalculations: false
Mantas's avatar
v2-rc1  
Mantas committed
266
267
268
269
270
271
272
273

  # Incident posts shown
  # in one page
  #
  # NUMERIC; Default: `10`
  incidentPostsPerPage: 10

  # Colors throughout cState
Mantas Vilčinskas's avatar
v4.0    
Mantas Vilčinskas committed
274
275
276
  #
  # We recommend using HEX
  # (with the # symbol).
Mantas's avatar
v2-rc1  
Mantas committed
277
278
279
  #
  # Defaults:
  #
Mantas Vilčinskas's avatar
v4.0    
Mantas Vilčinskas committed
280
281
282
283
284
  # brand: "#0a0c0f"
  # ok: "#008000"
  # disrupted: "#cc4400"
  # down: "#e60000"
  # notice: "#24478f"
Duncan's avatar
Duncan committed
285
286
  brand: "#7D4698"
  ok: "#68B030"
Mantas Vilčinskas's avatar
v4.0    
Mantas Vilčinskas committed
287
  disrupted: "#cc4400"
Duncan's avatar
Duncan committed
288
289
  down: "#EF243E"
  notice: "#7D4698"
Mantas's avatar
v2-rc1  
Mantas committed
290
291
292
293
294
295
296
297

  # 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?
  #
Mantas Vilčinskas's avatar
v4.0.1    
Mantas Vilčinskas committed
298
  # Default: `true`
Mantas's avatar
v2-rc1  
Mantas committed
299
300
  # BOOLEAN; `true`, `false`
  alwaysKeepBrandColor: true
Mantas Vilčinskas's avatar
v4.0.1    
Mantas Vilčinskas committed
301
302
303
304
305
306
307
308
309
310
311
312
313
314
  
  # 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
Mantas's avatar
v2-rc1  
Mantas committed
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335

  # 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

336
337
338
339
preserveTaxonomyNames: true

taxonomies:
  affected: affected
Mantas Vilčinskas's avatar
v4.0    
Mantas Vilčinskas committed
340
341
342
343
344
345
346
347
348

outputs:
  page:
    - html
    - json
  home:
    - html
    - json
    - rss
Mantas Vilčinskas's avatar
v4.1.0    
Mantas Vilčinskas committed
349
350
351
352
353
    - svg

outputFormats:
  svg:
    isPlainText: true
Mantas Vilčinskas's avatar
Mantas Vilčinskas committed
354
    mediaType: image/svg+xml