https://github.com/beevelop/docker-shields

Shields.io in a Docker image :whale:
https://github.com/beevelop/docker-shields

badges docker docker-compose docker-image

Last synced: 10 months ago
JSON representation

Shields.io in a Docker image :whale:

• Host: GitHub
• URL: https://github.com/beevelop/docker-shields
• Owner: beevelop
• Created: 2016-03-04T18:36:18.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2018-02-24T09:40:44.000Z (almost 8 years ago)
• Last Synced: 2025-04-14T23:15:59.995Z (10 months ago)
• Topics: badges, docker, docker-compose, docker-image
• Size: 5.86 KB
• Stars: 18
• Watchers: 4
• Forks: 62
• Open Issues: 5
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
[![Travis](https://shields.beevelop.com/travis/beevelop/docker-shields.svg?style=flat-square)](https://travis-ci.org/beevelop/docker-shields)

[![Pulls](https://shields.beevelop.com/docker/pulls/beevelop/shields.svg?style=flat-square)](https://links.beevelop.com/d-shields)

[![Layers](https://shields.beevelop.com/docker/image/layers/beevelop/shields/latest.svg?style=flat-square)](https://links.beevelop.com/d-shields)

[![Size](https://shields.beevelop.com/docker/image/image-size/beevelop/shields/latest.svg?style=flat-square)](https://links.beevelop.com/d-shields)

[![Release](https://shields.beevelop.com/github/release/beevelop/docker-shields.svg?style=flat-square)](https://github.com/beevelop/docker-shields/releases)

![Badges](https://shields.beevelop.com/badge/badges-7-brightgreen.svg?style=flat-square)

[![Beevelop](https://links.beevelop.com/honey-badge)](https://beevelop.com)

# [Shields.io](https://github.com/badges/shields) for Docker :whale:

## 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.

```bash

# Clone this repo

# Adapt docker-compose.yml for your needs (e.g. INFOSITE)

docker-compose up -d

docker-compose logs -f

```

## Run manually

```bash

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