SONAR-5430 User authentication by HTTP header

1 files changed, 27 insertions, 0 deletions

diff --git a/sonar-application/src/main/assembly/conf/sonar.properties b/sonar-application/src/main/assembly/conf/sonar.properties
index f34e1cd4c2e..a39c648033f 100644
--- a/sonar-application/src/main/assembly/conf/sonar.properties
+++ b/sonar-application/src/main/assembly/conf/sonar.properties
@@ -250,6 +250,33 @@
 
 
 #--------------------------------------------------------------------------------------------------
+# AUTHENTICATION
+
+# Enable authentication using HTTP headers
+#sonar.sso.enable=false
+
+# Name of the header to get the user login.
+# Only alphanumeric, '.' and '@' characters are allowed
+#sonar.sso.loginHeader=X-Forwarded-Login
+
+# Name of the header to get the user name
+#sonar.sso.nameHeader=X-Forwarded-Name
+
+# Name of the header to get the user email (optional)
+#sonar.sso.emailHeader=X-Forwarded-Email
+
+# Name of the header to get the list of user groups, separated by comma (optional).
+# If the sonar.sso.groupsHeader is set, the user will belong to those groups if groups exist in SonarQube.
+# If none of the provided groups exists in SonarQube, the user won't belong to any group.
+# Note that the default group will NOT be automatically added when using SSO, it should be provided in the groups list, if needed.
+#sonar.sso.groupsHeader=X-Forwarded-Groups
+
+# Interval used to know when to refresh name, email and groups.
+# During this interval, if for instance the name of the user is changed in the header, it will only be updated after X minutes.
+#sonar.sso.refreshIntervalInMinutes=5
+
+
+#--------------------------------------------------------------------------------------------------
 # OTHERS
 
 # Delay in seconds between processing of notification queue. Default is 60 seconds.