Forge Home


SonarQube installation and configuration


6,542 latest version

5.0 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Version information

  • 1.0.0 (latest)
released Aug 22nd 2017
This version is compatible with:
  • Puppet Enterprise >=3.2.0
  • Puppet >=2.7.17
  • , , , , , , , , , ,

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'ddsloan96-sonarqube', '1.0.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add ddsloan96-sonarqube
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install ddsloan96-sonarqube --version 1.0.0

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.



ddsloan96/sonarqube — version 1.0.0 Aug 22nd 2017


Build Status Puppet Forge Puppet Forge Quality Gate

A puppet recipe to install SonarQube (former Sonar)


class { 'java': }
class { 'sonarqube':
  version => '5.1',


$jdbc = {
  url      => 'jdbc:h2:tcp://localhost:9092/sonar',
  username => 'sonar',
  password => 'sonar',

class { 'sonarqube':
  arch          => 'linux-x86-64',
  version       => '5.1,
  user          => 'sonar',
  group         => 'sonar',
  service       => 'sonar',
  installroot   => '/usr/local',
  home          => '/var/local/sonar',
  download_url  => ''
  jdbc          => $jdbc,
  web_java_opts => '-Xmx1024m',
  log_folder    => '/var/local/sonar/logs',
  updatecenter  => 'true',
  http_proxy    => {
    host        => '',
    port        => '8080',
    ntlm_domain => '',
    user        => '',
    password    => '',

SonarQube Plugins

The sonarqube::plugin defined type can be used to install SonarQube plugins. Note that Maven is required to download the plugins then.

class { 'java': }
class { 'maven::maven': }
class { 'sonarqube': }

sonarqube::plugin { 'sonar-javascript-plugin':
  groupid    => 'org.sonarsource.javascript',
  artifactid => 'sonar-javascript-plugin',
  version    => '2.10',
  notify     => Service['sonar'],

Security Configuration

The sonarqube class provides an easy way to configure security with LDAP, Crowd or PAM. Here's an example with LDAP:

$ldap = {
  url          => 'ldap://',
  user_base_dn => 'ou=Users,dc=mycompany,dc=com',
  local_users  => ['foo', 'bar'],

class { 'java': }
class { 'maven::maven': }
class { 'sonarqube':
  ldap => $ldap,

# Do not forget to add the SonarQube LDAP plugin that is not provided out of the box.
# Same thing with Crowd or PAM.
sonarqube::plugin { 'sonar-ldap-plugin':
  groupid    => 'org.sonarsource.ldap',
  artifactid => 'sonar-ldap-plugin',
  version    => '1.5.1',
  notify     => Service['sonar'],

Module Requirements

  • maestrodev/wget
  • maestrodev/maven (only if additional SonarQube plugins are needed to be installed)
  • puppetlabs/stdlib


Copyright 2011-2013 MaestroDev, Inc

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
See the License for the specific language governing permissions and
limitations under the License.