solr.in.sh 9.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185
  1. # Licensed to the Apache Software Foundation (ASF) under one or more
  2. # contributor license agreements. See the NOTICE file distributed with
  3. # this work for additional information regarding copyright ownership.
  4. # The ASF licenses this file to You under the Apache License, Version 2.0
  5. # (the "License"); you may not use this file except in compliance with
  6. # the License. You may obtain a copy of the License at
  7. #
  8. # http://www.apache.org/licenses/LICENSE-2.0
  9. #
  10. # Unless required by applicable law or agreed to in writing, software
  11. # distributed under the License is distributed on an "AS IS" BASIS,
  12. # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13. # See the License for the specific language governing permissions and
  14. # limitations under the License.
  15. # Settings here will override settings in existing env vars or in bin/solr. The default shipped state
  16. # of this file is completely commented.
  17. # By default the script will use JAVA_HOME to determine which java
  18. # to use, but you can set a specific path for Solr to use without
  19. # affecting other Java applications on your server/workstation.
  20. #SOLR_JAVA_HOME=""
  21. # This controls the number of seconds that the solr script will wait for
  22. # Solr to stop gracefully or Solr to start. If the graceful stop fails,
  23. # the script will forcibly stop Solr. If the start fails, the script will
  24. # give up waiting and display the last few lines of the logfile.
  25. #SOLR_STOP_WAIT="180"
  26. # Increase Java Heap as needed to support your indexing / query needs
  27. #SOLR_HEAP="512m"
  28. # Expert: If you want finer control over memory options, specify them directly
  29. # Comment out SOLR_HEAP if you are using this though, that takes precedence
  30. #SOLR_JAVA_MEM="-Xms512m -Xmx512m"
  31. # Enable verbose GC logging...
  32. # * If this is unset, various default options will be selected depending on which JVM version is in use
  33. # * For Java 8: if this is set, additional params will be added to specify the log file & rotation
  34. # * For Java 9 or higher: each included opt param that starts with '-Xlog:gc', but does not include an
  35. # output specifier, will have a 'file' output specifier (as well as formatting & rollover options)
  36. # appended, using the effective value of the SOLR_LOGS_DIR.
  37. #
  38. #GC_LOG_OPTS='-Xlog:gc*' # (Java 9+)
  39. #GC_LOG_OPTS="-verbose:gc -XX:+PrintHeapAtGC -XX:+PrintGCDetails \
  40. # -XX:+PrintGCDateStamps -XX:+PrintGCTimeStamps -XX:+PrintTenuringDistribution -XX:+PrintGCApplicationStoppedTime"
  41. # These GC settings have shown to work well for a number of common Solr workloads
  42. #GC_TUNE="-XX:NewRatio=3 -XX:SurvivorRatio=4 etc.
  43. # Set the ZooKeeper connection string if using an external ZooKeeper ensemble
  44. # e.g. host1:2181,host2:2181/chroot
  45. # Leave empty if not using SolrCloud
  46. #ZK_HOST=""
  47. # Set the ZooKeeper client timeout (for SolrCloud mode)
  48. #ZK_CLIENT_TIMEOUT="15000"
  49. # By default the start script uses "localhost"; override the hostname here
  50. # for production SolrCloud environments to control the hostname exposed to cluster state
  51. #SOLR_HOST="192.168.1.1"
  52. # By default Solr will try to connect to Zookeeper with 30 seconds in timeout; override the timeout if needed
  53. #SOLR_WAIT_FOR_ZK="30"
  54. # By default the start script uses UTC; override the timezone if needed
  55. #SOLR_TIMEZONE="UTC"
  56. # Set to true to activate the JMX RMI connector to allow remote JMX client applications
  57. # to monitor the JVM hosting Solr; set to "false" to disable that behavior
  58. # (false is recommended in production environments)
  59. #ENABLE_REMOTE_JMX_OPTS="false"
  60. # The script will use SOLR_PORT+10000 for the RMI_PORT or you can set it here
  61. # RMI_PORT=18983
  62. # Anything you add to the SOLR_OPTS variable will be included in the java
  63. # start command line as-is, in ADDITION to other options. If you specify the
  64. # -a option on start script, those options will be appended as well. Examples:
  65. #SOLR_OPTS="$SOLR_OPTS -Dsolr.autoSoftCommit.maxTime=3000"
  66. #SOLR_OPTS="$SOLR_OPTS -Dsolr.autoCommit.maxTime=60000"
  67. #SOLR_OPTS="$SOLR_OPTS -Dsolr.clustering.enabled=true"
  68. # Location where the bin/solr script will save PID files for running instances
  69. # If not set, the script will create PID files in $SOLR_TIP/bin
  70. #SOLR_PID_DIR=
  71. # Path to a directory for Solr to store cores and their data. By default, Solr will use server/solr
  72. # If solr.xml is not stored in ZooKeeper, this directory needs to contain solr.xml
  73. #SOLR_HOME=
  74. # Path to a directory that Solr will use as root for data folders for each core.
  75. # If not set, defaults to <instance_dir>/data. Overridable per core through 'dataDir' core property
  76. #SOLR_DATA_HOME=
  77. # Solr provides a default Log4J configuration xml file in server/resources
  78. # however, you may want to customize the log settings and file appender location
  79. # so you can point the script to use a different log4j2.xml file
  80. #LOG4J_PROPS=/var/solr/log4j2.xml
  81. # Changes the logging level. Valid values: ALL, TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF. Default is INFO
  82. # This is an alternative to changing the rootLogger in log4j2.xml
  83. #SOLR_LOG_LEVEL=INFO
  84. # Location where Solr should write logs to. Absolute or relative to solr start dir
  85. #SOLR_LOGS_DIR=logs
  86. # Enables log rotation before starting Solr. Setting SOLR_LOG_PRESTART_ROTATION=true will let Solr take care of pre
  87. # start rotation of logs. This is false by default as log4j2 handles this for us. If you choose to use another log
  88. # framework that cannot do startup rotation, you may want to enable this to let Solr rotate logs on startup.
  89. #SOLR_LOG_PRESTART_ROTATION=false
  90. # Sets the port Solr binds to, default is 8983
  91. #SOLR_PORT=8983
  92. # Enables HTTPS. It is implictly true if you set SOLR_SSL_KEY_STORE. Use this config
  93. # to enable https module with custom jetty configuration.
  94. #SOLR_SSL_ENABLED=true
  95. # Uncomment to set SSL-related system properties
  96. # Be sure to update the paths to the correct keystore for your environment
  97. #SOLR_SSL_KEY_STORE=etc/solr-ssl.keystore.jks
  98. #SOLR_SSL_KEY_STORE_PASSWORD=secret
  99. #SOLR_SSL_TRUST_STORE=etc/solr-ssl.keystore.jks
  100. #SOLR_SSL_TRUST_STORE_PASSWORD=secret
  101. # Require clients to authenticate
  102. #SOLR_SSL_NEED_CLIENT_AUTH=false
  103. # Enable clients to authenticate (but not require)
  104. #SOLR_SSL_WANT_CLIENT_AUTH=false
  105. # SSL Certificates contain host/ip "peer name" information that is validated by default. Setting
  106. # this to false can be useful to disable these checks when re-using a certificate on many hosts
  107. #SOLR_SSL_CHECK_PEER_NAME=true
  108. # Override Key/Trust Store types if necessary
  109. #SOLR_SSL_KEY_STORE_TYPE=JKS
  110. #SOLR_SSL_TRUST_STORE_TYPE=JKS
  111. # Uncomment if you want to override previously defined SSL values for HTTP client
  112. # otherwise keep them commented and the above values will automatically be set for HTTP clients
  113. #SOLR_SSL_CLIENT_KEY_STORE=
  114. #SOLR_SSL_CLIENT_KEY_STORE_PASSWORD=
  115. #SOLR_SSL_CLIENT_TRUST_STORE=
  116. #SOLR_SSL_CLIENT_TRUST_STORE_PASSWORD=
  117. #SOLR_SSL_CLIENT_KEY_STORE_TYPE=
  118. #SOLR_SSL_CLIENT_TRUST_STORE_TYPE=
  119. # Sets path of Hadoop credential provider (hadoop.security.credential.provider.path property) and
  120. # enables usage of credential store.
  121. # Credential provider should store the following keys:
  122. # * solr.jetty.keystore.password
  123. # * solr.jetty.truststore.password
  124. # Set the two below if you want to set specific store passwords for HTTP client
  125. # * javax.net.ssl.keyStorePassword
  126. # * javax.net.ssl.trustStorePassword
  127. # More info: https://hadoop.apache.org/docs/current/hadoop-project-dist/hadoop-common/CredentialProviderAPI.html
  128. #SOLR_HADOOP_CREDENTIAL_PROVIDER_PATH=localjceks://file/home/solr/hadoop-credential-provider.jceks
  129. #SOLR_OPTS=" -Dsolr.ssl.credential.provider.chain=hadoop"
  130. # Settings for authentication
  131. # Please configure only one of SOLR_AUTHENTICATION_CLIENT_BUILDER or SOLR_AUTH_TYPE parameters
  132. #SOLR_AUTHENTICATION_CLIENT_BUILDER="org.apache.solr.client.solrj.impl.PreemptiveBasicAuthClientBuilderFactory"
  133. #SOLR_AUTH_TYPE="basic"
  134. #SOLR_AUTHENTICATION_OPTS="-Dbasicauth=solr:SolrRocks"
  135. # Settings for ZK ACL
  136. #SOLR_ZK_CREDS_AND_ACLS="-DzkACLProvider=org.apache.solr.common.cloud.VMParamsAllAndReadonlyDigestZkACLProvider \
  137. # -DzkCredentialsProvider=org.apache.solr.common.cloud.VMParamsSingleSetCredentialsDigestZkCredentialsProvider \
  138. # -DzkDigestUsername=admin-user -DzkDigestPassword=CHANGEME-ADMIN-PASSWORD \
  139. # -DzkDigestReadonlyUsername=readonly-user -DzkDigestReadonlyPassword=CHANGEME-READONLY-PASSWORD"
  140. #SOLR_OPTS="$SOLR_OPTS $SOLR_ZK_CREDS_AND_ACLS"
  141. # Settings for common system values that may cause operational imparement when system defaults are used.
  142. # Solr can use many processes and many file handles. On modern operating systems the savings by leaving
  143. # these settings low is minuscule, while the consequence can be Solr instability. To turn these checks off, set
  144. # SOLR_ULIMIT_CHECKS=false either here or as part of your profile.
  145. # Different limits can be set in solr.in.sh or your profile if you prefer as well.
  146. #SOLR_RECOMMENDED_OPEN_FILES=
  147. #SOLR_RECOMMENDED_MAX_PROCESSES=
  148. SOLR_ULIMIT_CHECKS=false
  149. # When running Solr in non-cloud mode and if planning to do distributed search (using the "shards" parameter), the
  150. # list of hosts needs to be whitelisted or Solr will forbid the request. The whitelist can be configured in solr.xml,
  151. # or if you are using the OOTB solr.xml, can be specified using the system property "solr.shardsWhitelist". Alternatively
  152. # host checking can be disabled by using the system property "solr.disable.shardsWhitelist"
  153. #SOLR_OPTS="$SOLR_OPTS -Dsolr.shardsWhitelist=http://localhost:8983,http://localhost:8984"