1- url : " YOUR_URL"
1+ #
2+ # ____ ________ __
3+ # / __/__ ___ ___ ___/ /_ __/______ _____/ /_____ ____
4+ # _\ \/ _ \/ -_) -_) _ / / / / __/ _ `/ __/ '_/ -_) __/
5+ # ___/ .__/\__/\__/\_,_/ /_/ /_/ \_,_/\__/_/\_\\__/_/
6+ # /_/
7+ # https://speedtracker.org
8+ #
29
3- encryptionKey : " YOUR_ENCRYPTION_KEY
10+
11+ # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
12+ # #
13+ # > url #
14+ # #
15+ # The full URL to your SpeedTracker website. For most people, this will be #
16+ # something like "https://yourusername.github.io/speedtracker", unless you #
17+ # want to use a custom domain. #
18+ # #
19+ # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
20+
21+ url : " https://yourusername.github.io/speedtracker"
22+
23+
24+ # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
25+ # #
26+ # (!) PLEASE NOTE: #
27+ # #
28+ # This config file will be visible to the public eye, unless you're running #
29+ # a private repository. For this reason, we need to obfuscate any sensitive #
30+ # information. #
31+ # #
32+ # Think of a key/password to encrypt your data. You'll need to supply this #
33+ # key with every request you make to SpeedTracker. #
34+ # #
35+ # The encrypt tool (https://speedtracker.org) allows you to encrypt any #
36+ # given text with a key of your choice. Read on. #
37+ # #
38+ # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
39+
40+
41+ # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
42+ # #
43+ # > encryptionKey #
44+ # #
45+ # Open the encrypt tool (https://speedtracker.org) and insert your key on #
46+ # the first input field. Leave the "What do you want to encrypt?" field #
47+ # blank and use the result on the encryptionKey field. #
48+ # #
49+ # e.g. The key "foobar123" will generate "0a5f0c0670219dc049" #
50+ # #
51+ # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
52+
53+ encryptionKey : " 0a5f0c0670219dc049"
54+
55+
56+ # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
57+ # #
58+ # > wptKey #
59+ # #
60+ # Open the encrypt tool (https://speedtracker.org), insert your key on the #
61+ # first input field (e.g. foobar123) and your WebPageTest API key as the #
62+ # text to encrypt. Use the result on the wptKey field. #
63+ # #
64+ # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
465
566wptKey : " YOUR_WEBPAGETEST_KEY"
667
7- alerts :
8- mainAlert :
9- type : " email"
10- recipients : ["ENCRYPTED_EMAIL_ADDRESS"]
11- slackAlert :
12- type : " slack"
13- hookUrl : " ENCRYPTED_SLACK_HOOK_URL"
14- channel : " #speedtracker"
15- username : " SpeedTracker"
16- iconEmoji : " :grimacing:"
68+
69+ # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
70+ # #
71+ # > alerts #
72+ # #
73+ # You can define alerts to be triggered when certain events occur (like a #
74+ # metric going over its specified budget). An alert is defined by an id #
75+ # (e.g. emailAlert) and depending on the type (email or slack) it accepts #
76+ # different parameters. #
77+ # #
78+ # Check https://speedtracker.org/docs#alerts for more information. #
79+ # #
80+ # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
81+
82+ # alerts:
83+ # emailAlert:
84+ # type: "email"
85+ # recipients: ["ENCRYPTED_EMAIL_ADDRESS"]
86+ # otherEmailAlert:
87+ # type: "email"
88+ # recipients: ["ENCRYPTED_EMAIL_ADDRESS2", "ENCRYPTED_EMAIL_ADDRESS3"]
89+ # slackAlert:
90+ # type: "slack"
91+ # hookUrl: "ENCRYPTED_SLACK_HOOK_URL"
92+ # channel: "#speedtracker"
93+ # username: "SpeedTracker"
94+ # iconEmoji: ":grimacing:"
0 commit comments