Files
metrics/settings.example.json
2022-01-13 04:45:02 +00:00

157 lines
6.1 KiB
JSON
Generated

{
"//": "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)",
"css": false, "//": "Allow use of 'extras.css' 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, "//": "Display an isometric view of your commits calendar"
},
"languages":{
"enabled": false, "//": "Display most used languages metrics"
},
"topics":{
"enabled": false, "//": "Display starred topics"
},
"stars":{
"enabled": false, "//": "Display recently starred repositories"
},
"licenses":{
"enabled": false, "//": "Display licenses informations"
},
"habits":{
"enabled": false, "//": "Display coding habits metrics"
},
"contributors":{
"enabled": false, "//": "Display repository contributors"
},
"followup":{
"enabled": false, "//": "Display follow-up of repositories issues and pull requests"
},
"reactions":{
"enabled": false, "//": "Display average issue comments reactions"
},
"people":{
"enabled": false, "//": "Display GitHub users from various affiliations"
},
"stargazers":{
"enabled": false, "//": "Display stargazers metrics"
},
"projects":{
"enabled": false, "//": "Display active projects"
},
"code":{
"enabled": false, "//": "Display a random code snippet from recent activity"
},
"activity":{
"enabled": false, "//": "Display recent activity"
},
"achievements":{
"enabled": false, "//": "Display achievements"
},
"notable":{
"enabled": false, "//": "Display notable contributions in organizations"
},
"discussions":{
"enabled": false, "//": "GitHub discussions metrics"
},
"support":{
"enabled": false, "//": "GitHub Community Support metrics"
},
"lines":{
"enabled": false, "//": "Display lines of code metrics"
},
"traffic":{
"enabled": false, "//": "Display repositories traffic metrics"
},
"repositories":{
"enabled": false, "//": "Display chosen featured repositories"
},
"gists":{
"enabled": false, "//": "Display gists metrics"
},
"introduction":{
"enabled": false, "//": "Display account or repository introduction"
},
"sponsors":{
"enabled": false, "//": "Display GitHub sponsors"
},
"skyline":{
"enabled": false, "//": "Display GitHub Skyline 3D calendar"
},
"starlists":{
"enabled": false, "//": "Display star lists"
},
"pagespeed":{
"token": null, "//":"PageSpeed token",
"enabled": false, "//": "Display a website Google PageSpeed metrics"
},
"music":{
"token": null, "//":"Music provider personal token",
"enabled": false, "//": "Display your music tracks"
},
"tweets":{
"token": null, "//":"Twitter API token",
"enabled": false, "//": "Display recent tweets"
},
"anilist":{
"enabled": false, "//": "Display data from your AniList account"
},
"stackoverflow":{
"enabled": false, "//": "Stackoverflow metrics"
},
"posts":{
"enabled": false, "//": "Display recent posts"
},
"rss":{
"enabled": false, "//": "Display RSS feed"
},
"wakatime":{
"token": null, "//":"WakaTime API token",
"enabled": false, "//": "Display WakaTime stats"
},
"stock":{
"token": null, "//":"Yahoo Finance token",
"enabled": false, "//": "Display stock prices of a given company"
},
"nightscout":{
"enabled": false, "//": "Displays Blood Glucose"
},
"poopmap":{
"token": null, "//":"PoopMap API token",
"enabled": false, "//": "Display PoopMap stats"
},
"screenshot":{
"enabled": false, "//": "Display a screenshot of any website"
},
"//": ""
}
}