/docker-shields

Shields.io in a Docker image :whale:

Travis Pulls Layers Size Release Badges Beevelop

Shields.io for Docker 🐳

Run with Docker Compose

The docker-compose.yml file allows you to run Shields with Varnish as cache server. This should increase Shields' performance and should generally reduce the server load.

# Clone this repo
# Adapt docker-compose.yml for your needs (e.g. INFOSITE)
docker-compose up -d
docker-compose logs -f

Run manually

docker run -d --name shields -p 80:80 \
    -e INFOSITE="http://shields.example.com" \
    beevelop/shields

Navigate to your Shields instance at http://shields.example.com/try.html (try.html is necessary, as the root redirects to shields.io).

Configuration

  • GH_CLIENT_ID (default: null)
  • GH_CLIENT_SECRET (default:null)
  • INFOSITE (default: "http://shields.io")

Attention: You should definitely specify the GH_CLIENT_* variables to prevent reaching the request quota of 60 req / hour