This is an automated email from the ASF dual-hosted git repository.
epugh pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/solr.git
The following commit(s) were added to refs/heads/main by this push:
new ac3d6d5902d SOLR-17868: Introduce a single page in Ref Guide to list
all system properties (#3613)
ac3d6d5902d is described below
commit ac3d6d5902d6a777a9091e1956f628f71159abf4
Author: Eric Pugh <[email protected]>
AuthorDate: Sat Sep 6 06:50:57 2025 -0400
SOLR-17868: Introduce a single page in Ref Guide to list all system
properties (#3613)
---
.../modules/configuration-guide/config-nav.adoc | 1 +
.../configuration-guide/pages/solr-properties.adoc | 120 +++++++++++++++++++++
2 files changed, 121 insertions(+)
diff --git a/solr/solr-ref-guide/modules/configuration-guide/config-nav.adoc
b/solr/solr-ref-guide/modules/configuration-guide/config-nav.adoc
index 6afef555df9..3c939435b6a 100644
--- a/solr/solr-ref-guide/modules/configuration-guide/config-nav.adoc
+++ b/solr/solr-ref-guide/modules/configuration-guide/config-nav.adoc
@@ -21,6 +21,7 @@
* xref:property-substitution.adoc[]
* xref:core-discovery.adoc[]
* xref:configuring-solr-xml.adoc[]
+* xref:solr-properties.adoc[]
* xref:configuring-solrconfig-xml.adoc[]
** xref:index-location-format.adoc[]
diff --git
a/solr/solr-ref-guide/modules/configuration-guide/pages/solr-properties.adoc
b/solr/solr-ref-guide/modules/configuration-guide/pages/solr-properties.adoc
new file mode 100644
index 00000000000..6e150e61155
--- /dev/null
+++ b/solr/solr-ref-guide/modules/configuration-guide/pages/solr-properties.adoc
@@ -0,0 +1,120 @@
+= Solr Properties Reference
+// 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.
+
+This page provides an alphabetical reference of Solr system properties that
can be used to configure various aspects of Solr. Where applicable, previous
property names are also listed.
+
+NOTE: Properties marked with "!" indicate inverted meaning between old and new
properties. For example, if the old property was `disable.config.edit=false`,
the equivalent setting with the new property would be
`solr.api.config.edit.enabled=true`.
+
+== System Properties
+
+[width="100%",options="header",cols="20,25,15,40"]
+|===
+|Property Name|Previous Property Name (if any)|Default Value|Description
+
+|solr.admin.handler.systeminfo.dns.reverse.lookup.enabled|!solr.dns.prevent.reverse.lookup|true|Controls
whether reverse DNS lookups are enabled in the system info handler.
+
+|solr.api.config.edit.enabled|!disable.config.edit|true|Controls whether
configuration editing via API is enabled. When set to `true`, configuration
editing is enabled.
+
+|solr.api.v2.enabled|!disable.v2.api|true|Controls whether the V2 API is
enabled. When set to `true`, the V2 API is enabled.
+
+|solr.auth.jwt.outbound.http.enabled|solr.auth.jwt.allowOutboundHttp|false|Controls
whether JWT authentication for outbound HTTP connections is enabled.
+
+|solr.auth.superuser|solr.authorization.superuser|solr|Specifies the superuser
for authorization. This user has all permissions when using SASL authentication.
+
+|solr.circuitbreaker.errorcode||503|Defines the HTTP error code returned when
a circuit breaker is triggered.
+
+|solr.cloud.prep.recovery.read.timeout.additional.ms|prepRecoveryReadTimeoutExtraWait|8000|Specifies
additional milliseconds to wait during recovery read operations in SolrCloud
mode.
+
+|solr.cloud.startup.delete.unknown.cores.enabled|solr.deleteUnknownCores|false|Controls
whether unknown cores are deleted at startup in SolrCloud mode.
+
+|solr.cloud.wait.for.zk.seconds|waitForZk|30|Specifies the number of seconds
to wait for ZooKeeper connection in SolrCloud mode.
+
+|solr.configset.bootstrap.confdir|bootstrap_confdir||Defines the directory of
a configuration to be loaded as a configset when starting Solr. Often ends in
`/conf`.
+
+|solr.configset.bootstrap.config.name|collection.configName||Specifies the
configuration name for the bootstrapped configset. Use with
"solr.configset.bootstrap.confdir".
+
+|solr.configset.default.confdir|solr.default.confdir|"_default"|Defines the
default configuration directory for configsets.
+
+|solr.configset.forbidden.file.types|solrConfigSetForbiddenFileTypes|jar,jnilib,dll,so,dylib,exe|Specifies
file types that are forbidden in configsets.
+
+|solr.configset.upload.enabled|configset.upload.enabled|true|Controls whether
configset uploads are enabled.
+
+|solr.filestore.filesize.max|max.file.store.size|100MB|Defines the maximum
file size allowed in Solr's filestore.
+
+|solr.index.replication.fingerprint.enabled|!solr.disableFingerprint|true|Controls
whether index fingerprinting for replication is disabled.
+
+|solr.index.updatelog.enabled|enable.update.log|true (in default
solrconfig.xml)|Controls whether the UpdateLog is enabled. The UpdateLog is
required for atomic updates, real-time get, and transaction log replay.
+
+|solr.logs.dir|solr.log.dir|server/logs|Specifies the directory where Solr
logs are stored.
+
+|solr.metrics.fieldcache.entries.enabled|!disableSolrFieldCacheMBeanEntryList|true|Controls
whether Solr FieldCache MBean entry list is disabled for metrics reporting.
+
+|solr.metrics.fieldcache.entries.jmx.enabled|!disableSolrFieldCacheMBeanEntryListJmx|true|Controls
whether Solr FieldCache MBean JMX entry list is disabled for metrics reporting.
+
+|solr.packages.enabled|enable.packages|false|Controls whether the package
management system is enabled.
+
+|solr.requests.allow.urls|solr.disable.allowUrls||Specifies URLs that are
allowed for streaming. See also solr.requests.streaming.remote.enabled.
+
+|solr.requests.streaming.body.enabled|solr.enableStreamBody|false|Controls
whether streaming request bodies are enabled.
+
+|solr.requests.streaming.remote.enabled|solr.enableRemoteStreaming|false|Controls
whether remote streaming is enabled for requests.
+
+|solr.resourceloading.restricted.enabled|!solr.allow.unsafe.resourceloading|true|Controls
whether resource loading restrictions are enabled. When set to `true`,
resource loading restrictions are enabled.
+
+|solr.responses.hidden.sys.props|solr.hiddenSysProps||Defines system
properties that are hidden in responses.
+
+|solr.responses.stacktrace.enabled|!solr.hideStackTrace|false|Controls whether
stack traces are included in responses. When set to `true`, stack traces are
included in responses.
+
+|solr.security.auth.basicauth.credentials|basicauth||Defines basic
authentication credentials.
+
+|solr.security.auth.plugin|authenticationPlugin||Specifies the authentication
plugin to use.
+
+|solr.solrj.cloud.max.stale.retries|cloudSolrClientMaxStaleRetries|5|Sets the
maximum number of retries for stale connection attempts in SolrJ cloud client.
+
+|solr.streamingexpressions.facet.tiered.enabled|solr.facet.stream.tiered|true|Controls
whether tiered faceting is enabled for streaming expressions.
+
+|solr.tracing.always.on.enabled|solr.alwaysOnTraceId|true|Controls whether
trace IDs are always generated, even when no request contains a trace ID.
+
+|solr.ui.enabled|!disableAdminUI|true|Controls whether the Solr Admin UI is
enabled. When set to `true`, the Solr Admin UI is enabled.
+
+|solr.ui.experimental.enabled|!solr.admin.ui.experimental.disabled|true|Controls
whether experimental features in the Solr Admin UI are enabled. When set to
`true`, experimental features in the UI are enabled.
+
+|solr.zookeeper.chroot.create|createZkChroot|false|Controls whether a
ZooKeeper chroot is created if it doesn't exist.
+|===
+
+== Property Naming Conventions
+
+Many Solr properties follow a standard naming convention. Newer properties
typically use dot-separated format prefixed with `solr.` (e.g.,
`solr.my.property`), while older properties might camelCase (e.g.,
`solr.myProperty`).
+
+== Setting System Properties
+
+System properties can be set in several ways:
+
+1. JVM command line arguments using `-D`: `-Dsolr.api.v2.enabled=true`
+2. In `solr.in.sh` (Unix) or `solr.in.cmd` (Windows) using environment
variables
+3. Through environment variables (with appropriate naming conventions)
+
+Environment variables can also be used to set these properties.
+You may find this useful in environments such as Docker.
+Environment variables should be uppercase with dot notations equivalents, e.g.
`SOLR_API_V2_ENABLED` for the property `solr.api.v2.enabled`.
+
+== See Also
+
+* xref:configuring-solr-xml.adoc[]
+* xref:configuring-solrconfig-xml.adoc[]
+* xref:property-substitution.adoc[]
