You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

sonar.properties 20KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421
  1. # Property values can:
  2. # - be overridden by environment variables. The name of the corresponding environment variable is the
  3. # upper-cased name of the property where all the dot ('.') and dash ('-') characters are replaced by
  4. # underscores ('_'). For example, to override 'sonar.web.systemPasscode' use 'SONAR_WEB_SYSTEMPASSCODE'.
  5. # - be encrypted. See https://redirect.sonarsource.com/doc/settings-encryption.html
  6. #--------------------------------------------------------------------------------------------------
  7. # DATABASE
  8. #
  9. # IMPORTANT:
  10. # - The embedded H2 database is used by default. It is recommended for tests but not for
  11. # production use. Supported databases are Oracle, PostgreSQL and Microsoft SQLServer.
  12. # - Changes to database connection URL (sonar.jdbc.url) can affect SonarSource licensed products.
  13. # User credentials.
  14. # Permissions to create tables, indices and triggers must be granted to JDBC user.
  15. # The schema must be created first.
  16. #sonar.jdbc.username=
  17. #sonar.jdbc.password=
  18. #----- Embedded Database (default)
  19. # H2 embedded database server listening port, defaults to 9092
  20. #sonar.embeddedDatabase.port=9092
  21. #----- Oracle 12c/18c/19c
  22. # The Oracle JDBC driver must be copied into the directory extensions/jdbc-driver/oracle/.
  23. # Only the thin client is supported, and we recommend using the latest Oracle JDBC driver. See
  24. # https://jira.sonarsource.com/browse/SONAR-9758 for more details.
  25. # If you need to set the schema, please refer to http://jira.sonarsource.com/browse/SONAR-5000
  26. #sonar.jdbc.url=jdbc:oracle:thin:@localhost:1521/XE
  27. #----- PostgreSQL 9.6 or greater
  28. # By default the schema named "public" is used. It can be overridden with the parameter "currentSchema".
  29. #sonar.jdbc.url=jdbc:postgresql://localhost/sonarqube?currentSchema=my_schema
  30. #----- Microsoft SQLServer 2014/2016/2017/2019 and SQL Azure
  31. # A database named sonar must exist and its collation must be case-sensitive (CS) and accent-sensitive (AS)
  32. # Use the following connection string if you want to use integrated security with Microsoft Sql Server
  33. # Do not set sonar.jdbc.username or sonar.jdbc.password property if you are using Integrated Security
  34. # For Integrated Security to work, you have to download the Microsoft SQL JDBC Driver 9.2.0 package from
  35. # https://docs.microsoft.com/en-us/sql/connect/jdbc/release-notes-for-the-jdbc-driver?view=sql-server-ver15#92
  36. # and copy mssql-jdbc_auth-9.2.0.x64.dll to your path.
  37. #sonar.jdbc.url=jdbc:sqlserver://localhost;databaseName=sonar;integratedSecurity=true
  38. # Use the following connection string if you want to use SQL Auth while connecting to MS Sql Server.
  39. # Set the sonar.jdbc.username and sonar.jdbc.password appropriately.
  40. #sonar.jdbc.url=jdbc:sqlserver://localhost;databaseName=sonar
  41. #----- Connection pool settings
  42. # The maximum number of active connections that can be allocated
  43. # at the same time, or negative for no limit.
  44. # The recommended value is 1.2 * max sizes of HTTP pools. For example if HTTP ports are
  45. # enabled with default sizes (50, see property sonar.web.http.maxThreads)
  46. # then sonar.jdbc.maxActive should be 1.2 * 50 = 60.
  47. #sonar.jdbc.maxActive=60
  48. # The maximum number of connections that can remain idle in the
  49. # pool, without extra ones being released, or negative for no limit.
  50. #sonar.jdbc.maxIdle=5
  51. # The minimum number of connections that can remain idle in the pool,
  52. # without extra ones being created, or zero to create none.
  53. #sonar.jdbc.minIdle=2
  54. # The maximum number of milliseconds that the pool will wait (when there
  55. # are no available connections) for a connection to be returned before
  56. # throwing an exception, or <= 0 to wait indefinitely.
  57. #sonar.jdbc.maxWait=5000
  58. #sonar.jdbc.minEvictableIdleTimeMillis=600000
  59. #sonar.jdbc.timeBetweenEvictionRunsMillis=30000
  60. #--------------------------------------------------------------------------------------------------
  61. # WEB SERVER
  62. # Web server is executed in a dedicated Java process. By default heap size is @webDefaultHeapSize@.
  63. # Use the following property to customize JVM options.
  64. # Recommendations:
  65. #
  66. # The HotSpot Server VM is recommended. The property -server should be added if server mode
  67. # is not enabled by default on your environment:
  68. # http://docs.oracle.com/javase/8/docs/technotes/guides/vm/server-class.html
  69. #
  70. # Startup can be long if entropy source is short of entropy. Adding
  71. # -Djava.security.egd=file:/dev/./urandom is an option to resolve the problem.
  72. # See https://wiki.apache.org/tomcat/HowTo/FasterStartUp#Entropy_Source
  73. #
  74. #sonar.web.javaOpts=@webJavaOpts@
  75. # Same as previous property, but allows to not repeat all other settings like -Xmx
  76. #sonar.web.javaAdditionalOpts=
  77. # Binding IP address. For servers with more than one IP address, this property specifies which
  78. # address will be used for listening on the specified ports.
  79. # By default, ports will be used on all IP addresses associated with the server.
  80. #sonar.web.host=0.0.0.0
  81. # Web context. When set, it must start with forward slash (for example /sonarqube).
  82. # The default value is root context (empty value).
  83. #sonar.web.context=
  84. # TCP port for incoming HTTP connections. Default value is 9000.
  85. #sonar.web.port=9000
  86. # The maximum number of connections that the server will accept and process at any given time.
  87. # When this number has been reached, the server will not accept any more connections until
  88. # the number of connections falls below this value. The operating system may still accept connections
  89. # based on the sonar.web.connections.acceptCount property. The default value is 50.
  90. #sonar.web.http.maxThreads=50
  91. # The minimum number of threads always kept running. The default value is 5.
  92. #sonar.web.http.minThreads=5
  93. # The maximum queue length for incoming connection requests when all possible request processing
  94. # threads are in use. Any requests received when the queue is full will be refused.
  95. # The default value is 25.
  96. #sonar.web.http.acceptCount=25
  97. # By default users are logged out and sessions closed when server is restarted.
  98. # If you prefer keeping user sessions open, a secret should be defined. Value is
  99. # HS256 key encoded with base64. It must be unique for each installation of SonarQube.
  100. # Example of command-line:
  101. # echo -n "type_what_you_want" | openssl dgst -sha256 -hmac "key" -binary | base64
  102. #sonar.auth.jwtBase64Hs256Secret=
  103. # The inactivity timeout duration of user sessions, in minutes. After the configured
  104. # period of time, the user is logged out.
  105. # The default value is set to 3 days (4320 minutes).
  106. # It must be set between 6 minutes and 3 months (129600 minutes).
  107. # Value must be strictly positive.
  108. #sonar.web.sessionTimeoutInMinutes=4320
  109. # A passcode can be defined to access some web services from monitoring
  110. # tools without having to use the credentials of a system administrator.
  111. # Check the Web API documentation to know which web services are supporting this authentication mode.
  112. # The passcode should be provided in HTTP requests with the header "X-Sonar-Passcode".
  113. # By default feature is disabled.
  114. #sonar.web.systemPasscode=
  115. #--------------------------------------------------------------------------------------------------
  116. # SSO AUTHENTICATION
  117. # Enable authentication using HTTP headers
  118. #sonar.web.sso.enable=false
  119. # Name of the header to get the user login.
  120. # Only alphanumeric, '.' and '@' characters are allowed
  121. #sonar.web.sso.loginHeader=X-Forwarded-Login
  122. # Name of the header to get the user name
  123. #sonar.web.sso.nameHeader=X-Forwarded-Name
  124. # Name of the header to get the user email (optional)
  125. #sonar.web.sso.emailHeader=X-Forwarded-Email
  126. # Name of the header to get the list of user groups, separated by comma (optional).
  127. # If the sonar.sso.groupsHeader is set, the user will belong to those groups if groups exist in SonarQube.
  128. # If none of the provided groups exists in SonarQube, the user will only belong to the default group.
  129. # Note that the default group will always be set.
  130. #sonar.web.sso.groupsHeader=X-Forwarded-Groups
  131. # Interval used to know when to refresh name, email and groups.
  132. # During this interval, if for instance the name of the user is changed in the header, it will only be updated after X minutes.
  133. #sonar.web.sso.refreshIntervalInMinutes=5
  134. #--------------------------------------------------------------------------------------------------
  135. # LDAP CONFIGURATION
  136. # Enable the LDAP feature
  137. # sonar.security.realm=LDAP
  138. # Set to true when connecting to a LDAP server using a case-insensitive setup.
  139. # sonar.authenticator.downcase=true
  140. # URL of the LDAP server. Note that if you are using ldaps, then you should install the server certificate into the Java truststore.
  141. # ldap.url=ldap://localhost:10389
  142. # Bind DN is the username of an LDAP user to connect (or bind) with. Leave this blank for anonymous access to the LDAP directory (optional)
  143. # ldap.bindDn=cn=sonar,ou=users,o=mycompany
  144. # Bind Password is the password of the user to connect with. Leave this blank for anonymous access to the LDAP directory (optional)
  145. # ldap.bindPassword=secret
  146. # Possible values: simple | CRAM-MD5 | DIGEST-MD5 | GSSAPI See http://java.sun.com/products/jndi/tutorial/ldap/security/auth.html (default: simple)
  147. # ldap.authentication=simple
  148. # See :
  149. # * http://java.sun.com/products/jndi/tutorial/ldap/security/digest.html
  150. # * http://java.sun.com/products/jndi/tutorial/ldap/security/crammd5.html
  151. # (optional)
  152. # ldap.realm=example.org
  153. # Context factory class (optional)
  154. # ldap.contextFactoryClass=com.sun.jndi.ldap.LdapCtxFactory
  155. # Enable usage of StartTLS (default : false)
  156. # ldap.StartTLS=true
  157. # Follow or not referrals. See http://docs.oracle.com/javase/jndi/tutorial/ldap/referral/jndi.html (default: true)
  158. # ldap.followReferrals=false
  159. # USER MAPPING
  160. # Distinguished Name (DN) of the root node in LDAP from which to search for users (mandatory)
  161. # ldap.user.baseDn=cn=users,dc=example,dc=org
  162. # LDAP user request. (default: (&(objectClass=inetOrgPerson)(uid={login})) )
  163. # ldap.user.request=(&(objectClass=user)(sAMAccountName={login}))
  164. # Attribute in LDAP defining the user’s real name. (default: cn)
  165. # ldap.user.realNameAttribute=name
  166. # Attribute in LDAP defining the user’s email. (default: mail)
  167. # ldap.user.emailAttribute=email
  168. # GROUP MAPPING
  169. # Distinguished Name (DN) of the root node in LDAP from which to search for groups. (optional, default: empty)
  170. # ldap.group.baseDn=cn=groups,dc=example,dc=org
  171. # LDAP group request (default: (&(objectClass=groupOfUniqueNames)(uniqueMember={dn})) )
  172. # ldap.group.request=(&(objectClass=group)(member={dn}))
  173. # Property used to specifiy the attribute to be used for returning the list of user groups in the compatibility mode. (default: cn)
  174. # ldap.group.idAttribute=sAMAccountName
  175. #--------------------------------------------------------------------------------------------------
  176. # COMPUTE ENGINE
  177. # The Compute Engine is responsible for processing background tasks.
  178. # Compute Engine is executed in a dedicated Java process. Default heap size is @ceDefaultHeapSize@.
  179. # Use the following property to customize JVM options.
  180. # Recommendations:
  181. #
  182. # The HotSpot Server VM is recommended. The property -server should be added if server mode
  183. # is not enabled by default on your environment:
  184. # http://docs.oracle.com/javase/8/docs/technotes/guides/vm/server-class.html
  185. #
  186. #sonar.ce.javaOpts=@ceJavaOpts@
  187. # Same as previous property, but allows to not repeat all other settings like -Xmx
  188. #sonar.ce.javaAdditionalOpts=
  189. #--------------------------------------------------------------------------------------------------
  190. # ELASTICSEARCH
  191. # Elasticsearch is used to facilitate fast and accurate information retrieval.
  192. # It is executed in a dedicated Java process. Default maximum heap size is @searchDefaultHeapSize@.
  193. # It is recommended to also set MaxDirectMemorySize (-XX:MaxDirectMemorySize) and set it to half the maximum heap size.
  194. #
  195. # --------------------------------------------------
  196. # Word of caution for Linux users on 64bits systems
  197. # --------------------------------------------------
  198. # Please ensure Virtual Memory on your system is correctly configured for Elasticsearch to run properly
  199. # (see https://www.elastic.co/guide/en/elasticsearch/reference/5.5/vm-max-map-count.html for details).
  200. #
  201. # When SonarQube runs standalone, a warning such as the following may appear in logs/es.log:
  202. # "max virtual memory areas vm.max_map_count [65530] is too low, increase to at least [262144]"
  203. # When SonarQube runs as a cluster, however, Elasticsearch will refuse to start.
  204. #
  205. # JVM options of Elasticsearch process
  206. #sonar.search.javaOpts=@searchJavaOpts@
  207. # Same as previous property, but allows to not repeat all other settings like -Xmx
  208. #sonar.search.javaAdditionalOpts=
  209. # Elasticsearch port for incoming HTTP connections. Default is 9001. Use 0 to get a free port.
  210. # As a security precaution, should be blocked by a firewall and not exposed to the Internet.
  211. #sonar.search.port=9001
  212. # Elasticsearch TCP transport port that is bound to loopback address. When nothing is set, a random port will be chosen.
  213. # As a security precaution, your OS configuration should not expose this port for external access.
  214. #sonar.es.port=
  215. # Elasticsearch host. The search server will bind this address and the search client will connect to it.
  216. # Default is loopback address.
  217. # As a security precaution, should NOT be set to a publicly available address.
  218. #sonar.search.host=
  219. #--------------------------------------------------------------------------------------------------
  220. # UPDATE CENTER
  221. # Update Center requires an internet connection to request https://update.sonarsource.org
  222. # It is enabled by default.
  223. #sonar.updatecenter.activate=true
  224. # HTTP proxy (default none)
  225. #http.proxyHost=
  226. #http.proxyPort=
  227. # HTTPS proxy (defaults are values of http.proxyHost and http.proxyPort)
  228. #https.proxyHost=
  229. #https.proxyPort=
  230. # NT domain name if NTLM proxy is used
  231. #http.auth.ntlm.domain=
  232. # SOCKS proxy (default none)
  233. #socksProxyHost=
  234. #socksProxyPort=
  235. # Proxy authentication (used for HTTP, HTTPS and SOCKS proxies)
  236. #http.proxyUser=
  237. #http.proxyPassword=
  238. # Proxy exceptions: list of hosts that can be accessed without going through the proxy
  239. # separated by the '|' character, wildcard character '*' can be used for pattern matching
  240. # used for HTTP and HTTPS (default none)
  241. # (note: localhost and its literal notations (127.0.0.1, ...) are always excluded)
  242. #http.nonProxyHosts=
  243. #--------------------------------------------------------------------------------------------------
  244. # LOGGING
  245. # SonarQube produces logs in 4 logs files located in the same directory (see property sonar.path.logs below),
  246. # one per process:
  247. # Main process (aka. App) logs in sonar.log
  248. # Web Server (aka. Web) logs in web.log
  249. # Compute Engine (aka. CE) logs in ce.log
  250. # Elasticsearch (aka. ES) logs in es.log
  251. #
  252. # Depending on the startup, all 4 files follow the same rolling policy (see sonar.log.rollingPolicy and sonar.log.maxFiles) but it applies
  253. # individually (eg. if sonar.log.maxFiles=4, there can be at most 4 of each files, ie. 16 files in total).
  254. # If the SonarQube wrapper is used (for example, with the provided start.sh script), the sonar.log rotation policy needs to be set in the wrapper.conf
  255. #
  256. # All 4 files have logs in the same format:
  257. # 1 2 3 4 5 6
  258. # |-----------------| |---| |-|--------------------||------------------------------| |------------------------------------------------------------------------------------------------------------------------------|
  259. # 2016.11.16 16:47:00 INFO ce[AVht0dNXFcyiYejytc3m][o.s.s.c.t.CeWorkerCallableImpl] Executed task | project=org.sonarqube:example-java-maven | type=REPORT | id=AVht0dNXFcyiYejytc3m | submitter=admin | time=1699ms
  260. #
  261. # 1: timestamp. Format is YYYY.MM.DD HH:MM:SS
  262. # YYYY: year on 4 digits
  263. # MM: month on 2 digits
  264. # DD: day on 2 digits
  265. # HH: hour of day on 2 digits in 24 hours format
  266. # MM: minutes on 2 digits
  267. # SS: seconds on 2 digits
  268. # 2: log level.
  269. # Possible values (in order of descending criticality): ERROR, WARN, INFO, DEBUG and TRACE
  270. # 3: process identifier. Possible values: app (main), web (Web Server), ce (Compute Engine) and es (Elasticsearch)
  271. # 4: SQ thread identifier. Can be empty.
  272. # In the Web Server, if present, it will be the HTTP request ID.
  273. # In the Compute Engine, if present, it will be the task ID.
  274. # 5: logger name. Usually a class canonical name.
  275. # Package names are truncated to keep the whole field to 20 characters max
  276. # 6: log payload. Content of this field does not follow any specific format, can vary in length and include line returns.
  277. # Some logs, however, will follow the convention to provide data in payload in the format " | key=value"
  278. # Especially, log of profiled pieces of code will end with " | time=XXXXms".
  279. # Global level of logs (applies to all 4 processes).
  280. # Supported values are INFO (default), DEBUG and TRACE
  281. #sonar.log.level=INFO
  282. # Level of logs of each process can be controlled individually with their respective properties.
  283. # When specified, they overwrite the level defined at global level.
  284. # Supported values are INFO, DEBUG and TRACE
  285. #sonar.log.level.app=INFO
  286. #sonar.log.level.web=INFO
  287. #sonar.log.level.ce=INFO
  288. #sonar.log.level.es=INFO
  289. # Path to log files. Can be absolute or relative to installation directory.
  290. # Default is <installation home>/logs
  291. #sonar.path.logs=logs
  292. # Rolling policy of log files
  293. # - based on time if value starts with "time:", for example by day ("time:yyyy-MM-dd")
  294. # or by month ("time:yyyy-MM")
  295. # - based on size if value starts with "size:", for example "size:10MB"
  296. # - disabled if value is "none". That needs logs to be managed by an external system like logrotate.
  297. #sonar.log.rollingPolicy=time:yyyy-MM-dd
  298. # Maximum number of files to keep if a rolling policy is enabled.
  299. # - maximum value is 20 on size rolling policy
  300. # - unlimited on time rolling policy. Set to zero to disable old file purging.
  301. #sonar.log.maxFiles=7
  302. # Access log is the list of all the HTTP requests received by server. If enabled, it is stored
  303. # in the file {sonar.path.logs}/access.log. This file follows the same rolling policy as other log file
  304. # (see sonar.log.rollingPolicy and sonar.log.maxFiles).
  305. #sonar.web.accessLogs.enable=true
  306. # Format of access log. It is ignored if sonar.web.accessLogs.enable=false. Possible values are:
  307. # - "common" is the Common Log Format, shortcut to: %h %l %u %user %date "%r" %s %b
  308. # - "combined" is another format widely recognized, shortcut to: %h %l %u [%t] "%r" %s %b "%i{Referer}" "%i{User-Agent}"
  309. # - else a custom pattern. See http://logback.qos.ch/manual/layouts.html#AccessPatternLayout.
  310. # The login of authenticated user is not implemented with "%u" but with "%reqAttribute{LOGIN}" (since version 6.1).
  311. # The value displayed for anonymous users is "-".
  312. # The SonarQube's HTTP request ID can be added to the pattern with "%reqAttribute{ID}" (since version 6.2).
  313. # If SonarQube is behind a reverse proxy, then the following value allows to display the correct remote IP address:
  314. #sonar.web.accessLogs.pattern=%i{X-Forwarded-For} %l %u [%t] "%r" %s %b "%i{Referer}" "%i{User-Agent}" "%reqAttribute{ID}"
  315. # Default value (which was "combined" before version 6.2) is equivalent to "combined + SQ HTTP request ID":
  316. #sonar.web.accessLogs.pattern=%h %l %u [%t] "%r" %s %b "%i{Referer}" "%i{User-Agent}" "%reqAttribute{ID}"
  317. #--------------------------------------------------------------------------------------------------
  318. # OTHERS
  319. # Delay in seconds between processing of notification queue. Default is 60 seconds.
  320. #sonar.notifications.delay=60
  321. # Paths to persistent data files (embedded database and search index) and temporary files.
  322. # Can be absolute or relative to installation directory.
  323. # Defaults are respectively <installation home>/data and <installation home>/temp
  324. #sonar.path.data=data
  325. #sonar.path.temp=temp
  326. # Telemetry - Share anonymous SonarQube statistics
  327. # By sharing anonymous SonarQube statistics, you help us understand how SonarQube is used so we can improve the product to work even better for you.
  328. # We don't collect source code or IP addresses. And we don't share the data with anyone else.
  329. # To see an example of the data shared: login as a global administrator, call the WS api/system/info and check the Statistics field.
  330. #sonar.telemetry.enable=true
  331. sonar.search.host=192.168.1.148