settings.example.json

{
  "//": "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"
    },
    "//": ""
  }
}