/
settings.example.json
221 lines (220 loc) 路 9.65 KB
/
settings.example.json
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
{
"//": "Example of configuration for metrics web instance",
"//": "====================================================================",
"token": "GITHUB API TOKEN", "//": "GitHub Personal Token (required)",
"modes": ["embed", "insights"], "//": "Web instance enabled modes",
"restricted": [], "//": "Authorized users (empty to disable)",
"maxusers": 0, "//": "Maximum users, (0 to disable)",
"cached": 3600000, "//": "Cache time rendered metrics (0 to disable)",
"ratelimiter": null, "//": "Rate limiter (see express-rate-limit documentation)",
"port": 3000, "//": "Listening port",
"optimize": true, "//": "SVG optimization",
"debug": false, "//": "Debug logs",
"debug.headless": false, "//": "Debug puppeteer process",
"mocked": false, "//": "Use mocked data instead of live APIs (use 'force' to use mocked token even if real token are defined)",
"repositories": 100, "//": "Number of repositories to use",
"padding": ["0", "8 + 11%"], "//": "Image padding (default)",
"outputs": ["svg", "png", "json"], "//": "Image output formats (empty to enable all)",
"hosted": {
"by": "", "//": "Web instance host (displayed in footer)",
"link": "", "//": "Web instance host link (displayed in footer)"
},
"oauth":{
"id": null, "//": "GitHub OAUTH client id",
"secret": null, "//": "GitHub OAUTH client secret",
"url":"https://example.com", "//": "GitHub OAUTH callback url (must be the same as the web instance host)"
},
"api":{
"rest": null, "//": "GitHub REST API custom endpoint",
"graphql": null, "//": "GitHub GraphQL API custom endpoint"
},
"control":{
"token": null, "//": "Control token (can be used by external services to perform actions on instance, such as stopping it for redeploys)"
},
"community": {
"templates": [], "//": "Additional community templates to setup"
},
"templates": {
"default": "classic", "//": "Default template",
"enabled": [], "//": "Enabled templates (empty to enable all)"
},
"extras": {
"default": false, "//": "Default extras state (advised to let 'false' unless in debug mode)",
"features": false, "//": "Enable extra features (advised to let 'false' on web instances), see below for supported features",
"//": "________________________________________________________________________",
"//": "metrics.setup.community.templates | Allow community templates download",
"//": "metrics.setup.community.presets | Allow community presets usage",
"//": "metrics.api.github.overuse | Allow GitHub API intensive requests",
"//": "metrics.api.* | Allow use of external API requests",
"//": "metrics.cpu.overuse | Allow CPU intensive requests",
"//": "metrics.run.tempdir | Allow access to temporary directory (I/O operations may be performed)",
"//": "metrics.run.git | Allow to run git",
"//": "metrics.run.licensed | Allow to run licensed",
"//": "metrics.run.user.cmd | Allow to run ANY command by user (USE WITH CAUTION!)",
"//": "metrics.run.puppeteer.scrapping | Allow to run puppeteer to scrape data",
"//": "metrics.run.puppeteer.user.css | Allow to run CSS by user during puppeteer render",
"//": "metrics.run.puppeteer.user.js | Allow to run JavaScript by user during puppeteer render",
"//": "metrics.npm.optional.* | Allow use of specified dependency",
"//": "________________________________________________________________________",
"//": "Additional extra features when user is logged with GitHub",
"logged": [
"metrics.api.github.overuse"
]
},
"plugins.default": false, "//": "Default plugin state (advised to let 'false' unless in debug mode)",
"plugins": { "//": "Global plugin configuration",
"isocalendar":{
"enabled": false, "//": "Enable isocalendar plugin"
},
"languages":{
"enabled": false, "//": "Enable languages plugin"
},
"stargazers":{
"worldmap.token": null, "//": "Stargazers worldmap token",
"enabled": false, "//": "Enable stargazers plugin"
},
"lines":{
"enabled": false, "//": "Enable lines plugin"
},
"topics":{
"enabled": false, "//": "Enable topics plugin"
},
"stars":{
"enabled": false, "//": "Enable stars plugin"
},
"licenses":{
"enabled": false, "//": "Enable licenses plugin"
},
"habits":{
"enabled": false, "//": "Enable habits plugin"
},
"contributors":{
"enabled": false, "//": "Enable contributors plugin"
},
"followup":{
"enabled": false, "//": "Enable followup plugin"
},
"reactions":{
"enabled": false, "//": "Enable reactions plugin"
},
"people":{
"enabled": false, "//": "Enable people plugin"
},
"sponsorships":{
"enabled": false, "//": "Enable sponsorships plugin"
},
"sponsors":{
"enabled": false, "//": "Enable sponsors plugin"
},
"repositories":{
"enabled": false, "//": "Enable repositories plugin"
},
"discussions":{
"enabled": false, "//": "Enable discussions plugin"
},
"starlists":{
"enabled": false, "//": "Enable starlists plugin"
},
"calendar":{
"enabled": false, "//": "Enable calendar plugin"
},
"achievements":{
"enabled": false, "//": "Enable achievements plugin"
},
"notable":{
"enabled": false, "//": "Enable notable plugin"
},
"activity":{
"enabled": false, "//": "Enable activity plugin"
},
"traffic":{
"enabled": false, "//": "Enable traffic plugin"
},
"code":{
"enabled": false, "//": "Enable code plugin"
},
"gists":{
"enabled": false, "//": "Enable gists plugin"
},
"projects":{
"enabled": false, "//": "Enable projects plugin"
},
"introduction":{
"enabled": false, "//": "Enable introduction plugin"
},
"skyline":{
"enabled": false, "//": "Enable skyline plugin"
},
"support":{
"enabled": false, "//": "Enable support plugin"
},
"pagespeed":{
"token": "PageSpeed token",
"enabled": false, "//": "Enable pagespeed plugin"
},
"tweets":{
"token": "Twitter API token",
"enabled": false, "//": "Enable tweets plugin"
},
"stackoverflow":{
"enabled": false, "//": "Enable stackoverflow plugin"
},
"anilist":{
"enabled": false, "//": "Enable aniList plugin"
},
"music":{
"token": "Music provider token",
"enabled": false, "//": "Enable music plugin"
},
"posts":{
"enabled": false, "//": "Enable posts plugin"
},
"rss":{
"enabled": false, "//": "Enable rss plugin"
},
"wakatime":{
"token": "WakaTime API token",
"enabled": false, "//": "Enable wakatime plugin"
},
"leetcode":{
"enabled": false, "//": "Enable leetcode plugin"
},
"steam":{
"token": "Steam token",
"enabled": false, "//": "Enable steam plugin"
},
"16personalities":{
"enabled": false, "//": "Enable 16personalities plugin"
},
"chess":{
"token": "Chess platform token",
"enabled": false, "//": "Enable chess plugin"
},
"crypto":{
"enabled": false, "//": "Enable crypto plugin"
},
"fortune":{
"enabled": false, "//": "Enable fortune plugin"
},
"nightscout":{
"enabled": false, "//": "Enable nightscout plugin"
},
"poopmap":{
"token": "PoopMap API token",
"enabled": false, "//": "Enable poopmap plugin"
},
"screenshot":{
"enabled": false, "//": "Enable screenshot plugin"
},
"splatoon":{
"token": "Splatnet token",
"statink.token": null, "//": "stat.ink token",
"enabled": false, "//": "Enable splatoon plugin"
},
"stock":{
"token": "Yahoo Finance token",
"enabled": false, "//": "Enable stock plugin"
},
"//": ""
}
}