sonarqube/README.md

# 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](#introduction)
2. [Table of contents](#table-of-contents)
3. [Prerequisites](#prerequisites)
4. [Installation](#installation)
5. [Usage](#usage)
6. [License](#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](https://git.van-hemmen.com/GuillaumeHemmen-DockerCompose-Infra/traefik-standalone)
  or [Traefik Authelia](https://git.van-hemmen.com/GuillaumeHemmen-DockerCompose-Infra/traefik-authelia)

## Installation

1. Clone the repository:

    ```bash
    git clone https://git.van-hemmen.com/GuillaumeHemmen-DockerCompose-Infra/sonarqube.git
    cd sonarqube
    ```

2. Copy the environment variable template:

    ```bash
    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](LICENCE) file for details.