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