SONAR-4898 update documentation and Minimum Viable Environment

2 files changed, 68 insertions, 59 deletions

diff --git a/sonar-application/src/main/assembly/conf/sonar.properties b/sonar-application/src/main/assembly/conf/sonar.properties
index ce2bb92b4cd..578cfa942bd 100644
--- a/sonar-application/src/main/assembly/conf/sonar.properties
+++ b/sonar-application/src/main/assembly/conf/sonar.properties
@@ -1,35 +1,16 @@
-# This file must contain only ISO 8859-1 characters
-# see http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Properties.html#load(java.io.InputStream)
+# This file must contain only ISO 8859-1 characters.
+# See http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Properties.html#load(java.io.InputStream)
 #
-# To use an environment variable, use the following syntax :  ${env:NAME_OF_ENV_VARIABLE}
-# For example:
-#   sonar.jdbc.url= ${env:SONAR_JDBC_URL}
-
-
-#--------------------------------------------------------------------------------------------------
-# TO BE DOCUMENTED - WORK IN PROGRESS
-#sonar.search.javaOpts=-Djava.net.preferIPv4Stack=true -Djava.awt.headless=true -Xmx256m -Xms256m -Xss256k -XX:+UseParNewGC -XX:+UseConcMarkSweepGC -XX:CMSInitiatingOccupancyFraction=75 -XX:+UseCMSInitiatingOccupancyOnly
-#sonar.search.port=9001
-#sonar.search.jmxPort=9002
-
-# For debug only
-#sonar.search.httpPort=
-
-#sonar.web.javaOpts=-server -Xmx768m -XX:MaxPermSize=160m -XX:+HeapDumpOnOutOfMemoryError
-#sonar.web.jmxPort=9003
-
-# Paths are absolute or relative to installation root directory
-#sonar.path.data=data
-#sonar.path.logs=logs
-#sonar.path.temp=temp
+# Property values can:
+# - reference an environment variable, for example sonar.jdbc.url= ${env:SONAR_JDBC_URL}
+# - be encrypted. See http://docs.codehaus.org/display/SONAR/Settings+Encryption
 
 
 #--------------------------------------------------------------------------------------------------
 # DATABASE
 #
-# IMPORTANT: the embedded H2 database is used by default. It is recommended for tests only.
-# Please use a production-ready database. Supported databases are MySQL, Oracle, PostgreSQL
-# and Microsoft SQLServer.
+# IMPORTANT: the embedded H2 database is used by default. It is recommended for tests but not for
+# production use. Supported databases are MySQL, Oracle, PostgreSQL and Microsoft SQLServer.
 
 # User credentials.
 # Permissions to create tables, indices and triggers must be granted to JDBC user.
@@ -37,11 +18,9 @@
 #sonar.jdbc.username=sonar
 #sonar.jdbc.password=sonar
 
-#----- Embedded database H2
-# Note: it does not accept connections from remote hosts, so the
-# SonarQube server and the maven plugin must be executed on the same host.
-
-# Comment the following line to deactivate the default embedded database.
+#----- Embedded database
+# It does not accept connections from remote hosts, so the
+# SonarQube server and the analyzers must be executed on the same host.
 sonar.jdbc.url=jdbc:h2:tcp://localhost:9092/sonar
 
 # directory containing H2 database files. By default it's the /data directory in the SonarQube installation.
@@ -56,24 +35,21 @@ sonar.jdbc.url=jdbc:h2:tcp://localhost:9092/sonar
 
 
 #----- Oracle 10g/11g
-# To connect to Oracle database:
-#
-# - It's recommended to use the latest version of the JDBC driver (ojdbc6.jar).
-#   Download it in http://www.oracle.com/technetwork/database/enterprise-edition/jdbc-112010-090769.html
-# - Copy the driver to the directory extensions/jdbc-driver/oracle/
+# - Only versions 11.2.* of Oracle JDBC driver are supported, even if connecting to lower Oracle versions.
+# - The JDBC driver must be copied into the directory extensions/jdbc-driver/oracle/
 # - If you need to set the schema, please refer to http://jira.codehaus.org/browse/SONAR-5000
 # - Comment the embedded database and uncomment the following line:
 #sonar.jdbc.url=jdbc:oracle:thin:@localhost/XE
 
 
 #----- PostgreSQL 8.x/9.x
-# Comment the embedded database and uncomment the following property to use PostgreSQL.
+# Comment the embedded database and uncomment the following property to connect to PostgreSQL.
 # If you don't use the schema named "public", please refer to http://jira.codehaus.org/browse/SONAR-5000
 #sonar.jdbc.url=jdbc:postgresql://localhost/sonar
 
 
-#----- Microsoft SQLServer
-# The Jtds open source driver is available in extensions/jdbc-driver/mssql. More details on http://jtds.sourceforge.net
+#----- Microsoft SQLServer 2005/2008
+# Only the distributed jTDS driver is supported and must not be changed.
 #sonar.jdbc.url=jdbc:jtds:sqlserver://localhost/sonar;SelectMethod=Cursor
 
 
@@ -90,6 +66,18 @@ sonar.jdbc.timeBetweenEvictionRunsMillis=30000
 #--------------------------------------------------------------------------------------------------
 # WEB SERVER
 
+# Web server is executed in a dedicated Java process. By default its heap size is 768Mb.
+# Use the following property to customize JVM options. Enabling the HotSpot Server VM
+# mode (-server) is recommended.
+# Note that the option -Dfile.encoding=UTF-8 is mandatory.
+#sonar.web.javaOpts=-Xmx768m -XX:MaxPermSize=160m -XX:+HeapDumpOnOutOfMemoryError \
+#  -Djava.awt.headless=true -Dfile.encoding=UTF-8 -Djruby.management.enabled=false
+
+# Web server requires a JMX RMI port to be open. Default is 9003. A free port is
+# dynamically used is value is 0.
+# This JMX port must be private and must not be exposed to the Internet.
+#sonar.web.jmxPort=9003
+
 # Binding IP address. For servers with more than one IP address, this property specifies which
 # address will be used for listening on the specified ports.
 # By default, ports will be used on all IP addresses associated with the server.
@@ -178,15 +166,35 @@ sonar.jdbc.timeBetweenEvictionRunsMillis=30000
 # Access logs are enabled by default.
 #sonar.web.accessLogs.enable=true
 
-# TCP port for incoming AJP connections. Disabled when value is -1.
-# sonar.ajp.port=9009
+# TCP port for incoming AJP connections. Disabled if value is -1. Disabled by default.
+#sonar.ajp.port=-1
+
+
+#--------------------------------------------------------------------------------------------------
+# SEARCH INDEX
+
+# Elasticsearch is used to facilitate fast and accurate information retrieval.
+# It is executed in a dedicated Java process.
+
+# JVM options. Note that enabling the HotSpot Server VM mode (-server) is recommended.
+#sonar.search.javaOpts=-Xmx256m -Xms256m -Xss256k -Djava.net.preferIPv4Stack=true \
+#  -XX:+UseParNewGC -XX:+UseConcMarkSweepGC -XX:CMSInitiatingOccupancyFraction=75 \
+#  -XX:+UseCMSInitiatingOccupancyOnly -XX:+HeapDumpOnOutOfMemoryError \
+#  -Djava.awt.headless=true
+
+# Elasticsearch port. Default is 9001. Use 0 to get a free port.
+# This port must be private and must not be exposed to the Internet.
+#sonar.search.port=9001
 
+# JMX RMI port to monitor Elasticsearch process. Default is 9002. Use 0 to get a free port.
+# It must be private and must not be exposed to the Internet.
+#sonar.search.jmxPort=9002
 
 
 #--------------------------------------------------------------------------------------------------
 # UPDATE CENTER
 
-# The Update Center requires an internet connection to request http://update.sonarsource.org
+# Update Center requires an internet connection to request http://update.sonarsource.org
 # It is enabled by default.
 #sonar.updatecenter.activate=true
 
@@ -207,20 +215,25 @@ sonar.jdbc.timeBetweenEvictionRunsMillis=30000
 
 
 #--------------------------------------------------------------------------------------------------
-# NOTIFICATIONS
-
-# Delay (in seconds) between processing of notification queue
-sonar.notifications.delay=60
+# LOGGING
 
-#--------------------------------------------------------------------------------------------------
-# PROFILING
-# Level of information displayed in the logs: NONE (default), BASIC (functional information) and FULL (functional and technical details)
+# Level of information displayed in the logs: NONE (default), BASIC (functional information)
+# and FULL (functional and technical details)
 #sonar.log.profilingLevel=NONE
 
+# Path to log files. Can be absolute or relative to installation directory.
+# Default is <installation home>/logs
+#sonar.path.logs=logs
+
 
 #--------------------------------------------------------------------------------------------------
-# DEVELOPMENT MODE
-# Only for debugging
+# OTHERS
+
+# Delay in seconds between processing of notification queue. Default is 60 seconds.
+#sonar.notifications.delay=60
 
-# Set to true to apply Ruby on Rails code changes on the fly
-#sonar.rails.dev=false
+# Paths to persistent data files (embedded database and search index) and temporary files.
+# Can be absolute or relative to installation directory.
+# Defaults are respectively <installation home>/data and <installation home>/temp
+#sonar.path.data=data
+#sonar.path.temp=temp
diff --git a/sonar-application/src/main/assembly/lib/jsw/wrapper.conf b/sonar-application/src/main/assembly/lib/jsw/wrapper.conf
index 1020f2003cb..075cd1c5878 100644
--- a/sonar-application/src/main/assembly/lib/jsw/wrapper.conf
+++ b/sonar-application/src/main/assembly/lib/jsw/wrapper.conf
@@ -30,8 +30,6 @@ wrapper.java.library.path.1=./lib
 # Application parameters.  Add parameters as needed starting from 1
 wrapper.app.parameter.1=org.sonar.application.App
 
-# Do not touch the following property. Max memory is set with -Xmx (see above).
-# See https://jira.codehaus.org/browse/SONAR-5204
 wrapper.java.maxmemory=0
 
 #********************************************************************
@@ -41,7 +39,7 @@ wrapper.java.maxmemory=0
 wrapper.console.format=PM
 
 # Log Level for console output.  (See docs for log levels)
-wrapper.console.loglevel=ERROR
+wrapper.console.loglevel=INFO
 
 # Log file to use for wrapper output logging.
 wrapper.logfile=../../logs/application.log
@@ -50,7 +48,7 @@ wrapper.logfile=../../logs/application.log
 wrapper.logfile.format=M
 
 # Log Level for log file output.  (See docs for log levels)
-wrapper.logfile.loglevel=ERROR
+wrapper.logfile.loglevel=INFO
 
 # Maximum size that the log file will be allowed to grow to before
 #  the log is rolled. Size is specified in bytes.  The default value
@@ -104,6 +102,4 @@ wrapper.ntservice.interactive=false
 # Forking Properties
 #********************************************************************
 wrapper.disable_restarts=TRUE
-wrapper.shutdown.timeout=30
-wrapper.jvm_exit.timeout=30
 wrapper.ping.timeout=0