settings.example.json

{
  "//":"This is an example of configuration file for web instance",
  "//":"It is not needed when using metrics as GitHub action",

  "token":"MY GITHUB API TOKEN",  "//":"Your own GitHub API token (required)",
  "restricted":[],                "//":"List of authorized users, leave empty for unrestricted",
  "cached":3600000,               "//":"Cached time for generated images, 0 to disable",
  "maxusers":0,                   "//":"Maximum number of users, 0 for unlimited",
  "ratelimiter":null,             "//":"Rate limiter (see express-rate-limit documentation for options)",
  "port":3000,                    "//":"Listening port",
  "optimize":true,                "//":"Optimize SVG image",
  "debug":false,                  "//":"Debug mode",
  "mocked":false,                 "//":"Use mocked data",
  "repositories":100,             "//":"Number of repositories to use to compute metrics",
  "community":{                   "//":"Community settings",
    "templates":[],               "//":"Community templates"
  },
  "templates":{                   "//":"Template configuration",
    "default":"classic",          "//":"Default template",
    "enabled":[],                 "//":"Enabled templates, leave empty to enable all templates"
  },
  "plugins":{                     "//":"Additional plugins (optional)",
    "pagespeed":{                 "//":"Pagespeed plugin",
      "enabled":false,             "//":"Enable or disable PageSpeed metrics",
      "token":null,               "//":"Pagespeed token (optional)"
    },
    "traffic":{                   "//":"Traffic plugin (GitHub API token must be RW for this to work)",
      "enabled":false,            "//":"Enable or disable repositories total page views is last two weeks"
    },
    "lines":{                     "//":"Lines plugin",
      "enabled":false,            "//":"Enable or disable repositories total lines added/removed"
    },
    "habits":{                    "//":"Habits plugin",
      "enabled":false,            "//":"Enable or disable coding habits metrics",
      "from":200,                 "//":"Number of activity events to base habits on (up to 1000)"
    },
    "languages":{                 "//":"Languages plugin",
      "enabled":false,             "//":"Enable or disable most used languages metrics"
    },
    "followup":{                  "//":"Follow-up plugin",
      "enabled":false,             "//":"Enable or disable owned repositories issues and pull requests metrics"
    },
    "music":{                     "//":"Music plugin",
      "enabled":false,            "//":"Enable or disable music recently played / random track from playlist",
      "token":null,               "//":"Music provider token (may be required depending on provider)"
    },
    "posts":{                     "//":"Posts plugin",
      "enabled":false,            "//":"Enable or disable recents posts"
    },
    "isocalendar":{               "//":"Isometric calendar plugin",
      "enabled":false,            "//":"Enable or disable isometric calendar"
    },
    "gists":{                     "//":"Gists plugin",
      "enabled":false,            "//":"Enable or disable gists metrics"
    },
    "topics":{                    "//":"Topics plugin",
      "enabled":false,            "//":"Enable or disable starred topics display"
    },
    "projects":{                  "//":"Projects plugin",
      "enabled":false,            "//":"Enable or disable personal projects display"
    },
    "tweets":{                    "//":"Tweets plugin",
      "enabled":false,            "//":"Enable or disable recent tweets display",
      "token":null,               "//":"Twitter token (required when enabled)"
    },
    "stars":{                     "//":"Stars plugin",
      "enabled":false,            "//":"Enable or disable recently starred repositories display"
    },
    "stargazers":{                "//":"Stargazers plugin",
      "enabled":false,            "//":"Enable or disable stargazers charts display"
    },
    "activity":{                  "//":"Activity plugin",
      "enabled":false,            "//":"Enable or disable recent activity display"
    },
    "people":{                    "//":"People plugin",
      "enabled":false,            "//":"Enable or disable people display"
    },
    "anilist":{                   "//":"Anilist plugin",
      "enabled":false,            "//":"Enable or disable anilist display"
    }
  }
}