Skip to content

Latest commit

 

History

History
41 lines (32 loc) · 2.25 KB

README.md

File metadata and controls

41 lines (32 loc) · 2.25 KB
Raw

Phabricator Authentication Plugin for SonarQube

This plugin enables user authentication and Single Sign-On via Phabricator.

This was based on the Bitbucket Authentication Plugin for SonarQube.

Installation

  1. Install the plugin into the SONARQUBE_HOME/extensions/plugins directory
  2. Restart the SonarQube server

Configuration

  1. In Phabricator, create an OAuth application :
  2. Set "phabricator.show-prototypes" to true
  3. Go to "More Applications" -> "Administration" -> "OAuth Server" -> "Create OAuth Server"
  4. Name: Something like "SonarQube"
  5. Redirect URI: SonarQube_URL/oauth2/callback/phabricator
  6. In SonarQube :
  7. Go to "Administration" -> "Configuration" -> "General Settings" -> "Security" -> "Phabricator"
  8. Set the "Enabled" property to true
  9. Set the "OAuth Application Client PHID" from the value provided by the Phabricator OAuth Application Client PHID
  10. Set the "OAuth Application Secret" from the value provided by the Phabricator OAuth Application Secret
  11. Set the "Phabricator Host" to the URL of your Phabricator server
  12. Go to the login form, a new button "Log in with Phabricator" allow users to connect to SonarQube with their Phabricator accounts.

Note: Only HTTPS is supported

  • SonarQube must be publicly accessible through HTTPS only
  • The property 'sonar.core.serverBaseURL' must be set to this public HTTPS URL

General Configuration

Property Description Default value
sonar.auth.phabricator.allowUsersToSignUp Allow new users to authenticate. When set to 'false', only existing users will be able to authenticate to the server true
sonar.auth.phabricator.clientId.secured Client PHID provided by Phabricator when registering the application None
sonar.auth.phabricator.clientSecret.secured Application Secret provided by Phabricator when registering the application None
sonar.auth.phabricator.enabled Enable Phabricator users to login. Value is ignored if Client PHID and Application are not defined false
sonar.auth.phabricator.hostUrl Phabricator server URL https://secure.phabricator.com

License

This project is licensed under the terms of the MIT license.