GitHub Readme Stats for Docker

Annoying "maximum retries exceeded" errors? Self-host private github-readme-stats instance on Docker!

---

Features

• No "maximum retries exceeded" errors due to self-hosting instead of using shared instance
• Images for arm/arm64 available for running on Raspberry Pi or other single board computers
• Permits requests from different users than the configured GITHUB_USER to prevent server overload
• Includes statistics of your private repositories due to using your own GITHUB_TOKEN
• You don't have to pass your GITHUB_TOKEN to the 3rd-party hoster Vercel (I don't trust them)

---

Setup

1. Create GITHUB_TOKEN:

   • Go to Settings, then Developer settings
   • Personal access tokens (classic) → Generate new token (classic)
   • Select scopes: repo:status, repo_deployment, public_repo
   • Generate token

2. Start Docker container:

   • Environment variables have to be updated
   • The container will only allow API requests to the configured GITHUB_USER
   • This example starts the container on port 8080

docker run -it -p 8080:80 -e GITHUB_USER=Crusader99 -e GITHUB_TOKEN=ghp_eTwj... crusaders/github-readme-stats-docker

3. Request custom profile stats:
   • Example: http://localhost:8080/top-langs?username=Crusader99&layout=compact
   • Note: The username parameter must match the configured GITHUB_USER environment variable
   • For more examples, refer to the documentation of github-readme-stats

---

License

This project is licensed under the MIT license.