ph1p/sonar-badges

a small docker container to enable badges with private sonarqube instances

Sonarqube Badges

This small project offers you a way to get your sonarqube badges out of your secured sonarqube instance.

Environment variables

Set these variables:

SERVER_URL (default: "")

<= v7.x.x
USERNAME (default: "")
PASSWORD (default: "")

>= v8.x.x
TOKEN (default: "")

I would recommend that you create an additional user within your instance and grant this user permissions.

Optional

• ENABLE_REQUEST_LOG (default: false")
• PORT (defaul: 8080)

Howto

• download docker-compose.yml
• set environment variables
• run docker-compose up -d
• open http://localhost:8080/KEY/METRIC.svg?branch=BRANCH

METRIC: a metric key from the list down below

KEY: the project key inside your sonarqube instance

BRANCH: the analyzed branch (this is optional!) https://github.com/mc1arke/sonarqube-community-branch-plugin

Metric Types

• bugs
• code_smells
• coverage
• duplicated_lines_density
• ncloc
• sqale_rating
• alert_status
• reliability_rating
• security_rating
• sqale_index
• vulnerabilities