Full documentation for SonarQube has moved to a new location: http://docs.sonarqube.org/display/SONAR

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Wiki Markup
{iframe:src=http://update.sonarsource.org/plugins/crowd-confluence.html|width=700|height=250|frameborder=0}
Your browser does not support iframes.
{iframe}

Compatibility matrix

Plugin

0.1

0.2

1.0

Crowd

2.0.2

2.0.2

2.0.2 - 2.2.x

Description / Features

The Sonar Crowd Plugin This plugin enables the delegation of Sonar SonarQube authentication to an external system. The plugin currently supports Atlassian Crowd.

Only password-checking is done against the external system. Authorization (access control) is still fully managed in SonarSonarQube. That’s why Crowd users do not automatically have access to Sonar. A Sonar account must be created first for each new user wishing to use Sonar. The Sonar SonarQube. During the first authentication trial, if the password is correct, the SonarQube database is automatically populated with the new user. The System administrator should also assign the user to the desired groups in order to grant him necessary rights. If one exists, the password in the Sonar SonarQube account will be ignored as the external system password will override it.

Usage & Installation

...

Requirements

Plugin

0.1

0.2

1.0

Crowd

2.0.2

2.0.2

2.0.2 - 2.2.x

Include Page
Include - Plugin Installation
Include - Plugin Installation

Usage

  1. Make sure that at least one user with global System administration role exists in Sonar SonarQube as well as in the external system
  2. Configure

    Update the SONARQUBE_HOME/conf/sonar.properties file by adding

    and editing

    the following lines:

    #------------------- # Sonar Crowd Plugin #------------------- # IMPORTANT : before activation, make sure that one Sonar administrator is defined in the external system #
    Code Block
    titleSONARQUBE/_HOME/conf/sonar.properties
    languagenone
    # Activates the plugin. Leave blank or comment out to use default sonarSonarQube authentication.
    sonar.authenticator.class: org.sonar.plugins.crowd.CrowdAuthenticator
    
    # Ignore failure at startup if the connection to external system is refused.
    # Users can browse sonarSonarQube but not log in as long as the connection fails.
    # When set to true, SonarSonarQube will not start if connection to external system fails.
    # Default is false.
    #sonar.authenticator.ignoreStartupFailure: true
    
    # Automatically create users (available since Sonar 2.0).
    # When set to true, user will be created after successful authentication, if doesn't exists.
    # The default group affected to new users can be defined online, in SonarSonarQube general settings. The default value is "sonar-users".
    # Default is false.
    #sonarsonar.authenticator.createUsers: true
    
    # URL of the Crowd server (usually ends with /services/).
    crowd.url:
    
    # Crowd application name.
    # Default is 'sonar'.
    #crowd.application:
    
    # Crowd application password.
    crowd.password:
    
  3. Restart the

    Sonar server

    SonarQube server and check the log file for:

    No Format
    
    INFO  org.sonar.INFO  Authentication plugin: class org.sonar.plugins.crowd.CrowdAuthenticator
    INFO  org.sonar.INFO  Authentication plugin started
    
  4. Log in to Sonar

Troubleshooting

...

  1. SonarQube

Include Page
Include - Technical Users
Include - Technical Users

Troubleshooting

For versions prior to SonarQube 4.1, you can enable debug logging by adding the following to conf/logback.xml:

Code Block
titleconf/logback.xml
   <logger name="org.sonar.plugins.crowd">
    <level value="DEBUG"/>
    <appender-ref ref="CONSOLE"/>
    <appender-ref ref="SONAR_FILE"/>
  </logger>

Changelog

JIRA Issues
anonymoustrue
titleRelease 1.0
height90
width800
columnstype;key;summary;priority;status;resolution
urlhttp://jira.codehaus.org/sr/jira.issueviews:searchrequest-xml/temp/SearchRequest.xml?fixfor=16911&pid=11911&sorter/field=priority&sorter/order=DESC&tempMax=1000
JIRA Issues
anonymoustrue
titleRelease 0.2
height90
width800
columnstype;key;summary;priority;status;resolution
urlhttp://jira.codehaus.org/sr/jira.issueviews:searchrequest-xml/temp/SearchRequest.xml?fixfor=16515&pid=11911&sorter/field=priority&sorter/order=DESC&tempMax=1000
JIRA Issues
anonymoustrue
titleRelease 0.1
height120
width800
columnstype;key;summary;priority;status;resolution
urlhttp://jira.codehaus.org/sr/jira.issueviews:searchrequest-xml/temp/SearchRequest.xml?fixfor=16079&pid=11911&sorter/field=priority&sorter/order=DESC&tempMax=1000