Out of the box, SonarQube comes with a complete mechanism to manage security. Configuring security allows you to cover two main use cases:
- Manage access rights to components, information, etc.
- Enable customization (custom dashboards, notifications, etc.) of SonarQube for users
- Secure a SonarQube instance by forcing authentication prior to accessing any page
- Make a given project invisible to anonymous users
- Restrict access to a project to a given group of users
- Restrict access to a project's source code (Code Viewer) to a given set of users
- Define who can administer a project (setting exclusion patterns, tuning plugins configuration for that project, etc.)
- Define who can administer a SonarQube instance
Default Admin Credentials
When installing SonarQube, a default user with administration privileges is created automatically:
- Login: admin
- Password: admin
A user is a set of basic information: login, password, name and email.
To create a new user, go to Setting > Users > Add new user:
Changing my Password
Log in and go to Your Name > My Profile:
The way authorization is implemented in SonarQube is pretty standard. It is possible to create as many users and groups of users as required in the system. The users can then be attached (or not) to (multiple) groups. Groups and / or users are then given (multiple) permissions. The permissions grant access to projects, services and functionalities.
A group is a set of users.
To create a new group, go to Settings > Groups > Add new group:
To add/remove users to/from a group:
Two groups have a special meaning:
- Anyone is a group that exists in the system, but that cannot be managed. Every user belongs to this group, including "anonymous."
- sonar-users is the default group to which users are automatically added. This group can be changed through the Global Security Settings (
To set global permissions, log in as a System administrator and go to Settings > Global Permissions.
- System Administration: Ability to perform all administration functions for the instance: global configuration and personalization of default dashboards.
- Quality Profile Administration: Ability to perform any action on the quality profiles. Available since version 3.6.
- Dashboard And Filter Sharing: Ability to share dashboards, issue filters and measure filters. Available since version 3.7.
- Analysis Execution: Ability to execute analyses, and to get all settings required to perform the analysis, even the secured ones like the scm account password, the jira account password, and so on. Available since version 3.7.
- Local (dry run) Analysis Execution: Ability to execute local (dry run) analyses without pushing the results to the server, and to get all settings required to perform a local analysis. This permission does not include the ability to access secured settings such as the scm account password, the jira account password, and so on. This permission is required to execute a local analysis in Eclipse or via the Issues Report plugin. Available since version 3.7.
Three different permissions can be set on projects (projects, views, developers):
- Users have the ability to see that a project exists, browse the measures and create/edit issues on the project
- Code viewers have the ability to view the source code of the project. You must have the Users permission on a project to make use of the Code viewers permission.
- Administrators have the ability to perform administration tasks for the project by accessing its settings. You must have the Users permission on a project to make use of the Administrators permission .
Note that permissions are not cumulative. For instance, if you want to be able to administer the project, browse the measures and browse the source code, you have to be given the three permissions: Administrators, Users and Code viewers.
You can either manually grant permissions for each project to some users and groups or apply permission templates to projects (since version 3.7).
Manually grant permissions for each project to some users and groups
Log in as a System administrator and go to Settings > Project Permissions > Projects (was Settings > Roles prior to version 3.7):
Apply permission templates to projects (available since version 3.7)
Create first some permission templates. To do so, go to Settings > Project Permissions > Permission Templates:
Then, apply permission templates to projects (either to a specific one through the "Apply permission template" link or apply some bulk changes on the selected projects):
Note that there is no relation between a project and a permission template, meaning that:
- the permissions of a project can be modified after a permission template has been applied to this project
- none of the project permissions is changed when a permission template is modified
Default project permissions
It is possible to configure the system so that when a new project (project, view, developer) is created, some users/groups are automatically granted permissions on this project.
For versions 3.7+, this is done through permission templates. Go to Settings > Project Permissions > Permission Templates > Set default templates:
For versions prior to 3.7, it is done through the "Default roles for new Projects" table:
In the example below, once a new project has been created:
- All the users in the sonar-administrators group can administrate (Administrators), access the project (Users) and browse the source code (Code viewers).
- The myAuditor user can access the project (Users) and browse the source code (Code viewers).
Log in as a System administrator and go to Settings > General Settings > Security:
- Default user group: any new user created will automatically join this group.
- Force user authentication: this is really the first question that should be answered when setting the security strategy in SonarQube. Can anybody browse the SonarQube instance or do you need to be authenticated?
- Allow users to sign up online: this means that anybody can access a form to create himself an account in the system. Note that after filling up the form, the user should log in.
- Import sources: if set to false, source code will not be accessible for any user. To restrict access to source code for some users only, grant them Code viewers permission.
Delegating Authentication and Authorization to External Systems
In order to leverage existing enterprise infrastructure, SonarQube provides the capability to delegate authentication and authorization to external systems through plugins:
- LDAP with the SonarQube LDAP Plugin
- Active Directory with the SonarQube LDAP Plugin
- PAM with the SonarQube PAM Plugin
- Crowd with the SonarQube Crowd Plugin
I have locked myself out
To recreate a System administrator:
I have lost the admin password
In case you lost the admin password of your SonarQube instance, you can reset it by running the following update statement :
This will reset the password to admin.