Skip to content

FedericoCeratto/github-traffic-charts

Repository files navigation

GitHub traffic charts

badge badge License

GitHub publishes project view and clone metrics only for the owner and with 14 days of history.

This daemon collect metrics for multiple users/orgs/projects and generates HTML charts every day.

It requires a GitHub "Personal access token" with "repo" scope.

System-wide installation

Install nim on Debian/Ubuntu with:

sudo apt install nim

Build and install the package with:

nimble build_deb
sudo dpkg -i ../github-traffic-charts_*.deb

Configure /etc/github_traffic_charts.conf.json and restart the daemon

Find outputs in /var/lib/github_traffic_charts/output/

Monitor with:

sudo journalctl -f -u github-traffic-charts

Local run

Build a binary with:

nimble build

Configure ./github_traffic_charts.conf.json

Run:

./github-traffic-charts

Configuration

If the user:…​ or org:…​ blocks are left empty, the daemon will scan all existing projects.

Example:

{
  "format-version": 1,
  "charted-days": 14,
  "charted-weeks": 4,
  "max-repos-per-chart": 12,
  "token": "REPLACEME",
  "repos": {
    "user:REPLACEME": [
    ],
    "user:REPLACEME": [
    ],
    "org:REPLACEME": [
    ],
  }
}

Releases

No releases published

Packages

No packages published

Languages