metrics/settings.example.json at master · Uncodedtech/metrics · GitHub

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
{
  "//": "Example of configuration for metrics web instance",
  "//": "====================================================================",

  "token": "MY GITHUB API TOKEN",  "//": "GitHub Personal Token (required)",
  "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)",
  "hosted": {
    "by": "",                      "//": "Web instance host (displayed in footer)",
    "link": "",                    "//": "Web instance host link (displayed in footer)"
  },
  "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)",
    "presets": false,              "//": "Allow use of 'config.presets' option",
    "css": false,                  "//": "Allow use of 'extras.css' option",
    "js": false,                   "//": "Allow use of 'extras.js' option",
    "features": false,             "//": "Enable extra features (advised to let 'false' on web instances)"
  },
  "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"
    },
    "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"
    },
    "stargazers":{
      "enabled": false,            "//": "Enable stargazers plugin"
    },
    "projects":{
      "enabled": false,            "//": "Enable projects plugin"
    },
    "code":{
      "enabled": false,            "//": "Enable code plugin"
    },
    "activity":{
      "enabled": false,            "//": "Enable activity plugin"
    },
    "achievements":{
      "enabled": false,            "//": "Enable achievements plugin"
    },
    "notable":{
      "enabled": false,            "//": "Enable notable plugin"
    },
    "discussions":{
      "enabled": false,            "//": "Enable discussions plugin"
    },
    "support":{
      "enabled": false,            "//": "Enable support plugin"
    },
    "lines":{
      "enabled": false,            "//": "Enable lines plugin"
    },
    "traffic":{
      "enabled": false,            "//": "Enable traffic plugin"
    },
    "repositories":{
      "enabled": false,            "//": "Enable repositories plugin"
    },
    "gists":{
      "enabled": false,            "//": "Enable gists plugin"
    },
    "introduction":{
      "enabled": false,            "//": "Display account or repository introduction"
    },
    "sponsors":{
      "enabled": false,            "//": "Enable sponsors plugin"
    },
    "starlists":{
      "enabled": false,            "//": "Enable starlists plugin"
    },
    "skyline":{
      "enabled": false,            "//": "Enable skyline plugin"
    },
    "pagespeed":{
      "token": null,               "//":"PageSpeed token\n\nAlthough not mandatory, it strongly advised to create one to avoid triggering the rate limiter. See [PageSpeed documentation](https://developers.google.com/speed/docs/insights/v5/get-started) for more informations.\n",
      "enabled": false,            "//": "Enable pagespeed plugin"
    },
    "music":{
      "token": null,               "//":"Music provider token\n\nBelow is the expected token format for each provider:\n- `apple`: *(not supported)*\n- `spotify`: \"client_id, client_secret, refresh_token\"\n- `lastfm`: \"api_key\"\n- `youtube`: \"cookie\"\n",
      "enabled": false,            "//": "Enable music plugin"
    },
    "stackoverflow":{
      "enabled": false,            "//": "Enable stackoverflow plugin"
    },
    "anilist":{
      "enabled": false,            "//": "Enable aniList plugin"
    },
    "tweets":{
      "token": null,               "//":"Twitter API token",
      "enabled": false,            "//": "Enable tweets plugin"
    },
    "posts":{
      "enabled": false,            "//": "Enable posts plugin"
    },
    "rss":{
      "enabled": false,            "//": "Enable rss plugin"
    },
    "wakatime":{
      "token": null,               "//":"WakaTime API token",
      "enabled": false,            "//": "Enable wakatime plugin"
    },
    "fortune":{
      "enabled": false,            "//": "Enable fortune plugin"
    },
    "nightscout":{
      "enabled": false,            "//": "Enable nightscout plugin"
    },
    "poopmap":{
      "token": null,               "//":"PoopMap API token",
      "enabled": false,            "//": "Enable poopmap plugin"
    },
    "screenshot":{
      "enabled": false,            "//": "Enable screenshot plugin"
    },
    "stock":{
      "token": null,               "//":"Yahoo Finance token",
      "enabled": false,            "//": "Enable stock plugin"
    },
    "//": ""
  }
}