sonarqube/README.md
Guillaume "B.B." Van Hemmen 6bac073d56 #0000 - Add Docker Compose setup for SonarQube with configuration
Introduce Docker Compose setup to deploy SonarQube with PostgreSQL and Traefik integration. Added necessary configuration files including `.env.dist`, `.gitignore`, and `LICENSE`. Updated README with detailed installation and usage instructions.
2024-10-10 17:30:32 +02:00

1.5 KiB

SonarQube

Introduction

This project provides a Docker Compose setup for quickly setting up a SonarQube instance. SonarQube is an open-source platform for continuous inspection of code quality to perform automatic reviews with static analysis of code to detect bugs, code smells, and security vulnerabilities.

Table of contents

  1. Introduction
  2. Table of contents
  3. Prerequisites
  4. Installation
  5. Usage
  6. License

Prerequisites

  • Docker: Make sure Docker is installed and running on your system.
  • Docker Compose: You also need Docker Compose to orchestrate the container setup.
  • To have deployed Traefik standalone or Traefik Authelia

Installation

  1. Clone the repository:

    git clone https://git.van-hemmen.com/GuillaumeHemmen-DockerCompose-Infra/sonarqube.git
    cd sonarqube
    
  2. Copy the environment variable template:

    cp .env.dist .env
    
  3. Customize the .env file as necessary for your environment.

Usage

Start the Traefik service with Docker Compose:

```bash
docker compose up -d
```

Access SonarQube by navigating to https://<SONAR_FQDN> in your web browser.

License

This project is licensed under the terms of the MIT license. See the LICENSE file for details.