Files

1.1 KiB

Get dynamically generated GitHub stats on your READMEs, with the ease of docker!

Fork of https://github.com/anuraghazra/github-readme-stats, gently wrapped in docker.

Steps to setup:

  • clone this repo into a folder.
  • copy docker-compose.yml.example to docker-compose.yml.
  • copy env.example to .env and update.
  • copy Caddyfile.example to Caddyfile and update.
  • and start with docker compose up -d.

docker-compose.yml.example has a very simple Caddy reverse proxy, for automatic https.

Files have example in their name, so that when you update, your local settings won't be overridden.

git clone https://code.digitaladapt.com/andrew/github-readme-stats.git
cd github-readme-stats
cp docker-compose.yml.example docker-compose.yml
cp env.example .env
vim .env
# add your github token

cp Caddyfile.example Caddyfile
vim Caddyfile
# configure your domain

docker compose up -d

You might ask, why should I trust your docker image?

The answer is, you don't have to, there isn't an image, just a few commands in the Dockerfile, which you can and should look at.